0

0

Laravel Eloquent如何实现作用域(Scopes)来复用查询逻辑? (全局与本地作用域)

尼克

尼克

发布时间:2026-01-19 09:05:02

|

598人浏览过

|

来源于php中文网

原创

Laravel Eloquent作用域本质是封装查询条件的可复用方法:本地作用域定义在模型内、以scope开头、链式调用自动传入$builder;全局作用域需在boot()中注册、自动应用于所有查询,但不可访问请求上下文。

laravel eloquent如何实现作用域(scopes)来复用查询逻辑? (全局与本地作用域)

直接说结论: Laravel Eloquent 的作用域(Scopes)本质是封装查询条件的可复用方法,本地作用域写在模型里、以 scope 开头,全局作用域需注册到 boot() 中、以 applyScope() 方式注入;二者都返回 $builder,但调用方式和生命周期不同,混用时容易漏掉 return $builder 或错用静态/实例上下文。

本地作用域:定义在模型内部,链式调用时自动传入 $builder

本地作用域是模型类里的普通方法,命名必须以 scope 开头(如 scopeActive()),Eloquent 会自动把当前查询构造器 $builder 作为第一个参数传入。它不支持传参校验,也不参与模型初始化流程。

常见错误包括:忘记 return $builder(导致链式中断)、在作用域里误用 $this->where()$this 是模型实例,不是构造器)、或把带参数的作用域写成 scopePublished($year)(正确应为 scopePublished($builder, $year))。

使用场景:按状态筛选(如草稿/已发布)、按时间范围过滤、多租户数据隔离(tenant_id = ?)等轻量、高频、与当前模型强相关的逻辑。

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

    public function scopePublishedAfter($builder, $date)
    {
        return $builder->where('published_at', '>=', $date);
    }
}

// 调用
Post::active()->publishedAfter('2024-01-01')->get();

全局作用域:一次注册,所有查询自动生效,适合跨模型通用规则

全局作用域是一个实现 Illuminate\Database\Eloquent\Scope 接口的类,或使用闭包定义。它通过在模型的 boot() 方法中调用 static::addGlobalScope() 注册,之后该模型所有查询(包括 find()first()、关联预加载)都会被自动包裹。

关键点:apply() 方法接收 $builder$model,必须返回修改后的 $builder;若需临时取消全局作用域,用 withoutGlobalScopes() 或指定作用域名(如 withoutGlobalScope(TenantScope::class))。

沁言学术
沁言学术

你的论文写作AI助理,永久免费文献管理工具,认准沁言学术

下载

性能影响:全局作用域无条件执行,若逻辑复杂(如子查询、JOIN)可能拖慢所有查询;兼容性上,它不适用于软删除之外的“伪删除”场景(如 is_deleted = 1),除非你手动在每个作用域里处理。

class TenantScope implements Scope
{
    public function apply(Builder $builder, Model $model)
    {
        $builder->where('tenant_id', tenant()->id);
    }
}

class Post extends Model
{
    protected static function boot()
    {
        parent::boot();
        static::addGlobalScope(new TenantScope());
    }
}

什么时候该用本地作用域,什么时候该用全局作用域?

判断依据不是“功能强弱”,而是“是否需要无感介入所有查询”:

  • 本地作用域:你想显式控制何时启用(比如只在后台列表用 ->withTrashed()前端列表不用);或者逻辑依赖运行时参数(如当前用户权限、请求日期);又或者仅对某几个模型有意义(如只有 Order 需要 scopePaid()
  • 全局作用域:你希望强制统一行为,且几乎永不绕过(如多租户隔离、软删除、数据归档标记);但它会让测试变复杂(需 mock tenant 上下文)、调试困难(错误堆里看不到作用域来源)
  • 特别注意:全局作用域不能访问请求上下文(如 request()auth()),因为可能在队列、命令行或 API 中执行;此时应改用本地作用域 + 中间件/服务注入参数

容易被忽略的细节:作用域嵌套、软删除与 withTrashed() 的冲突

全局作用域和本地作用域会叠加执行,顺序是:全局作用域先 apply,再执行本地作用域。但如果模型启用了软删除(SoftDeletes),它的全局作用域(SoftDeletingScope)默认排在最前 —— 这意味着你自定义的全局作用域可能查不到已被软删除的记录,即使你调用了 withTrashed()

解决办法:在自定义全局作用域的 apply() 中检查 $builder->getQuery()->wheres 是否含 deleted_at is null,或更稳妥地,用 withoutGlobalScopes() 手动排除软删除作用域后再加你的条件。

另一个坑:whereHas() 关联查询里不会自动应用父模型的全局作用域,但会应用关联模型自身的全局作用域 —— 如果你期望“只查当前租户的评论”,得在 Comment 模型里加租户作用域,而不是只在 Post 上加。

相关专题

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

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

316

2024.04.09

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

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

275

2024.04.09

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

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

369

2024.04.09

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

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

370

2024.04.10

laravel入门教程
laravel入门教程

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

81

2025.08.05

laravel实战教程
laravel实战教程

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

64

2025.08.05

laravel面试题
laravel面试题

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

67

2025.08.05

什么是中间件
什么是中间件

中间件是一种软件组件,充当不兼容组件之间的桥梁,提供额外服务,例如集成异构系统、提供常用服务、提高应用程序性能,以及简化应用程序开发。想了解更多中间件的相关内容,可以阅读本专题下面的文章。

178

2024.05.11

PHP WebSocket 实时通信开发
PHP WebSocket 实时通信开发

本专题系统讲解 PHP 在实时通信与长连接场景中的应用实践,涵盖 WebSocket 协议原理、服务端连接管理、消息推送机制、心跳检测、断线重连以及与前端的实时交互实现。通过聊天系统、实时通知等案例,帮助开发者掌握 使用 PHP 构建实时通信与推送服务的完整开发流程,适用于即时消息与高互动性应用场景。

3

2026.01.19

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Laravel---API接口
Laravel---API接口

共7课时 | 0.6万人学习

PHP自制框架
PHP自制框架

共8课时 | 0.6万人学习

PHP面向对象基础课程(更新中)
PHP面向对象基础课程(更新中)

共12课时 | 0.7万人学习

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

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