0

0

Laravel中如何定义模型范围Scopes_Laravel本地作用域Scope使用方法【详解】

冰火之心

冰火之心

发布时间:2026-01-14 22:58:02

|

583人浏览过

|

来源于php中文网

原创

本地作用域是Eloquent模型中以scope开头的public方法,用于封装可复用查询条件;调用时省略scope前缀,必须返回$query实例,支持链式调用与参数传入,适用于业务语义明确的固定条件筛选。

laravel中如何定义模型范围scopes_laravel本地作用域scope使用方法【详解】

本地作用域(Local Scopes)在 Laravel 模型中不是“必须用”,但一旦需要复用查询逻辑,它就是最干净、最易维护的写法。

什么是本地作用域?

本地作用域是定义在 Eloquent 模型里的方法,以 scope 开头,用于封装常用查询条件。它不是全局生效的,只对调用它的模型实例起作用。

常见错误现象:Call to undefined method App\Models\User::popular() —— 忘记加 scope 前缀,或没用 public 修饰符。

使用场景:筛选「已启用的用户」、「最近 7 天创建的订单」、「状态为 pending 的文章」等固定组合条件。

  • 方法名必须以 scope 开头(如 scopeActive),调用时去掉 scope,直接写 ->active()
  • 必须返回 $this(即当前查询构造器 Builder 实例),否则链式调用会中断
  • 参数不能依赖运行时上下文(比如不能直接读 request()),所有外部输入应显式传入

如何定义和调用一个基础本地作用域

User 模型为例,定义一个只查启用状态的范围:

class User extends Model
{
    public function scopeActive($query)
    {
        return $query->where('status', 'active');
    }
}

调用方式:

  • User::active()->get()
  • User::where('name', 'like', '%john%')->active()->first()(可与其他查询混用)
  • User::active()->orderBy('created_at', 'desc')->paginate(10)

注意:作用域方法第一个参数固定是 $queryIlluminate\Database\Eloquent\Builder),不要写成 $this 或漏掉。

百度智能云·曦灵
百度智能云·曦灵

百度旗下的AI数字人平台

下载

带参数的本地作用域怎么写?

比如按时间范围筛选订单:

class Order extends Model
{
    public function scopeWithinDays($query, int $days = 7)
    {
        return $query->where('created_at', '>=', now()->subDays($days));
    }
}

调用:Order::withinDays(30)->get()Order::withinDays()->get()(用默认值)。

容易踩的坑:

  • 参数类型未声明(如 $days 是字符串却当整数用),PHP 8+ 会报 TypeError
  • 传入 null 且没做空值判断,subDays(null) 会抛异常
  • 作用域里用了 $this->id 这类实例属性 —— 错!本地作用域在构建阶段执行,模型实例尚未存在

本地作用域 vs 全局作用域 vs 查询构造器方法

三者定位不同:

  • 本地作用域:按需显式调用,适合业务语义明确、不总被使用的条件(如 ->draft()->byCategory($id)
  • 全局作用域GlobalScopes):自动附加,适合全表统一规则(如软删除、租户隔离),但调试困难、不易关闭
  • 查询构造器方法(如 whereNotNull()):Laravel 内置,不可扩展,不带业务含义

性能影响几乎为零 —— 本地作用域只是语法糖,最终都编译成普通 where 条件;但若在作用域里做了 N+1 查询(比如 foreach + load()),就违背了设计初衷。

真正容易被忽略的是:本地作用域无法被静态分析工具(如 PHPStan)准确推断返回类型,复杂链式调用时 IDE 可能提示“Method not found”,这时候建议补上 PHPDoc 注解或改用查询构造器对象显式传递。

相关专题

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

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

2515

2023.09.01

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

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

1598

2023.10.11

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

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

1493

2023.10.11

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

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

952

2023.10.23

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

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

1416

2023.10.23

html怎么上传
html怎么上传

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

1234

2023.11.03

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

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

1445

2023.11.09

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

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

1306

2023.11.13

Java 桌面应用开发(JavaFX 实战)
Java 桌面应用开发(JavaFX 实战)

本专题系统讲解 Java 在桌面应用开发领域的实战应用,重点围绕 JavaFX 框架,涵盖界面布局、控件使用、事件处理、FXML、样式美化(CSS)、多线程与UI响应优化,以及桌面应用的打包与发布。通过完整示例项目,帮助学习者掌握 使用 Java 构建现代化、跨平台桌面应用程序的核心能力。

36

2026.01.14

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 8.6万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 7万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号