Laravel框架宏怎么用_Laravel框架查询功能扩展方法【详解】

落静君_2714

落静君_2714

2026-04-29

978人浏览

原创

可在 Laravel 中通过 Builder::macro() 为查询构造器动态添加可复用条件逻辑,支持在 AppServiceProvider、Tinker 或独立文件中注册,适配 Eloquent 和 Query Builder 两类实例,并天然支持链式调用。

laravel框架宏怎么用_laravel框架查询功能扩展方法【详解】

如果您希望在 Laravel 框架中为查询构造器(Builder)动态添加可复用的条件逻辑,但又不希望每次重复编写 where 子句或封装成作用域(Scope),则可以利用 Laravel 提供的宏(Macro)机制对 Builder 类进行扩展。以下是实现此目标的具体操作步骤:

一、在服务提供者中注册 Builder 宏

Builder 宏需在应用启动早期注册,确保所有查询构造器实例(包括 Eloquent 和 Query Builder)均可识别该宏方法。注册位置必须为 AppServiceProvider 的 boot 方法,否则调用时会抛出 BadMethodCallException 异常。

1、打开 app/Providers/AppServiceProvider.php 文件。

2、在 boot 方法内部调用 Builder::macro(),传入宏名称与闭包函数。

3、闭包函数接收当前 Builder 实例作为第一个参数(即 $this),并可接受额外参数,返回 $this 以支持链式调用。

4、示例:注册一个名为 wherePublished 的宏,用于统一筛选已发布的记录:Builder::macro('wherePublished', function () { return $this->where('published', true); });

二、使用 Tinker 临时注册 Builder 宏

该方式适用于开发调试或快速验证宏逻辑是否符合预期,无需修改项目文件,注册后立即生效,但仅在当前 Tinker 会话中存在。

1、在终端执行 php artisan tinker 命令进入交互环境。

2、输入以下语句注册宏:use Illuminate\Database\Eloquent\Builder; Builder::macro('whereActiveYear', function ($year) { return $this->whereYear('created_at', $year); });

3、在模型上测试调用:$users = App\Models\User::query()->whereActiveYear(2026)->get();

4、确认结果是否正确返回创建于 2026 年的用户记录。

三、通过独立宏文件集中管理 Builder 宏

当项目中 Builder 宏数量增多时,将全部定义提取至单独文件可显著提升组织性与可维护性,避免 AppServiceProvider::boot() 方法臃肿,并便于团队协作与版本控制。

1、新建文件 app/Macros/BuilderMacros.php。

Laravel Cloud
Laravel Cloud

Laravel Cloud(cloud.laravel.com)。此技能用于处理所有 Laravel Cloud 请求,包括搜索和读取数据。只要任务涉及 Laravel Cloud,即使用此技能。

下载

2、在该文件中逐条注册多个职责单一的宏,例如:Builder::macro('whereNotSoftDeleted', function () { return $this->whereNull('deleted_at'); });

3、在 AppServiceProvider 的 boot 方法中引入该文件:require_once app_path('Macros/BuilderMacros.php');

4、确保该文件无命名空间声明、无类定义,仅含 Builder::macro() 调用语句,且不包含任何 echo 或输出语句。

四、在 Eloquent 模型查询中调用 Builder 宏

宏注册完成后,所有通过 query()、newQuery() 或直接使用模型静态方法(如 User::where())生成的 Builder 实例均可调用宏,语法与原生方法完全一致,且天然支持链式调用。

1、在控制器中创建基础查询:$query = App\Models\Post::query();

2、连续调用多个已注册宏:$posts = $query->wherePublished()->whereActiveYear(2026)->orderBy('created_at', 'desc')->get();

3、验证最终 SQL 是否包含对应 WHERE 条件,且结果集符合业务预期。

五、为不同 Builder 类型分别注册宏

Laravel 中存在两类 Builder:Eloquent Builder(Illuminate\Database\Eloquent\Builder)和 Query Builder(Illuminate\Database\Query\Builder)。二者均实现 Macroable,但注册宏时需明确指定目标类,否则可能因类型不匹配导致宏不可见。

1、为 Eloquent Builder 注册特有宏(如作用于模型关系):use Illuminate\Database\Eloquent\Builder; Builder::macro('withTrashedIfAdmin', function () { if (auth()->check() && auth()->user()->is_admin) { return $this->withTrashed(); } return $this; });

2、为 Query Builder 注册底层 SQL 相关宏(如原生表达式封装):use Illuminate\Database\Query\Builder; Builder::macro('whereJsonContainsAny', function ($column, array $values) { foreach ($values as $value) { $this->orWhereRaw("JSON_CONTAINS({$column}, ?)", [$value]); } return $this; });

3、在实际查询中区分调用:Eloquent 查询走 Eloquent Builder 宏,DB::table() 查询走 Query Builder 宏。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

laravel

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

2024.04.09

897

10

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

2024.04.09

875

9

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

2024.04.09

2528

10

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.10

4901

7

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

2025.08.05

7170

22

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

2025.08.05

4716

13

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

2025.08.05

8829

7

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

2026.03.04

1516

29

Laravel 框架安装指南
Laravel 框架安装指南

本指南详解 Laravel 框架安装全流程,涵盖 PHP 8.1+ 环境配置、Composer 依赖管理工具安装及国内镜像源优化。重点演示使用 composer create-project 命令创建 Laravel 10/11 项目,解决常见安装错误与依赖冲突。从环境搭建到项目初始化,助您快速完成 Laravel 开发环境部署,为后续 Web 应用开发奠定基础。适合 PHP 初学者与框架迁移开发者参考。

2026.04.09

215

6

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
如何安装 Composer
如何安装 Composer

共1课时 | 225人学习

Composer手册
Composer手册

共0课时 | 0人学习