Laravel模型如何定义作用域_Laravel模型定义查询作用域【指南】

千磊酱_4139

千磊酱_4139

2026-05-03

192人浏览

原创

本地作用域需以scope开头、public修饰、首参$query、返回$query;全局作用域闭包适合简单条件,独立类适合复用场景;withoutglobalscopes()会移除所有全局作用域包括softdeletingscope。

laravel模型如何定义作用域_laravel模型定义查询作用域【指南】

全局作用域会自动加到所有查询里,本地作用域得手动调用才生效——选哪个,取决于你是否希望“默认过滤”成为模型行为的一部分。

本地作用域怎么写才不会报 Call to undefined method 错误

最常见的错误是方法名没加 scope 前缀、没用 public 修饰符,或者参数写错。

  • 方法必须以 scope 开头,比如 scopeActive,调用时写 ->active()
  • 第一个参数固定是 $query(类型为 Illuminate\Database\Eloquent\Builder),不能是 $this 或漏掉
  • 必须返回 $query,否则链式调用中断,比如 User::active()->orderBy(...) 会失败
  • 带参数的作用域,外部值必须显式传入,不能在方法体内读 request() 或 auth()

示例:

laravel-specialist
laravel-specialist

精通 Laravel 10+,遵循现代 PHP 实践的 Laravel 专家。擅长优雅语法、Eloquent ORM、队列系统及企业级特性...

下载
public function scopeWithinDays($query, int $days = 7)
{
    return $query->where('created_at', '>=', now()->subDays($days));
}
// 调用:Order::withinDays(30)->get()

全局作用域该用闭包还是独立类

闭包适合一次性、无状态的简单条件(比如固定 where('published', 1));独立类更适合需要传参、复用、测试或跨模型共享的场景(比如租户 ID 隔离)。

  • 闭包注册时必须指定字符串键名:addGlobalScope('published', function ($builder) { ... }),否则无法用 withoutGlobalScope('published') 移除
  • 独立类要实现 Illuminate\Database\Eloquent\Scope 接口,apply() 方法里只改 $builder,别执行查询
  • 构造参数(如 $tenantId)必须在 booted() 中获取并传入,不能在 apply() 里动态读 session 或 auth —— 队列任务里会出错
  • Laravel 9+ 推荐用 booted() 而非 boot() 注册,时机更稳妥

为什么 sometimes withoutGlobalScopes() 不起作用

常见原因是作用域注册方式和移除方式不匹配,或者被其他作用域干扰。

  • 用字符串名注册的闭包作用域,必须用同名字符串移除:withoutGlobalScope('published'),不是 withoutGlobalScope('PublishedScope')
  • withoutGlobalScopes() 只移除全局作用域,不影响本地作用域(scope* 方法)
  • 如果模型同时用了软删除(SoftDeletes trait),它的 SoftDeletingScope 也是全局作用域,withoutGlobalScopes() 会一并干掉它 —— 这可能导致 find(1) 查不到已软删记录,但你本意只是绕过业务级作用域
  • 多个全局作用域叠加时,后注册的 where 条件可能覆盖前面的同字段条件,withoutGlobalScopes() 是全量清除,没法只保留部分

真正容易被忽略的是:全局作用域在 find()、findOrFail()、first() 这些方法里照样生效,不是只有 get() 才触发;而本地作用域不支持静态调用以外的方式,比如不能在关系定义里直接写 ->active(),得靠 with(['posts' => function ($q) { $q->active(); }]) 这种闭包形式。

相关文章

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

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

下载

相关标签:

laravel 作用域

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

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

10704

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

6261

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2135

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

3948

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4674

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3651

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

5237

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

4102

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

12042

4

热门下载

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

精品课程

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

共1课时 | 208人学习

Composer手册
Composer手册

共0课时 | 0人学习