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 或漏掉。

吐槽大师
吐槽大师

吐槽大师(Roast Master) - 终极 AI 吐槽生成器,适用于 Instagram,Facebook,Twitter,Threads 和 Linkedin

下载

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

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

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 注解或改用查询构造器对象显式传递。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

340

2024.04.09

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

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

293

2024.04.09

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

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

773

2024.04.09

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

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

385

2024.04.10

laravel入门教程
laravel入门教程

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

141

2025.08.05

laravel实战教程
laravel实战教程

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

85

2025.08.05

laravel面试题
laravel面试题

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

80

2025.08.05

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

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

564

2026.03.04

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

26

2026.03.13

热门下载

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

精品课程

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

共137课时 | 13.5万人学习

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

共6课时 | 11.3万人学习

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

共13课时 | 1.0万人学习

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

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