0

0

如何为Laravel模型定义全局作用域(Global Scope)? (自动应用查询条件)

穿越時空

穿越時空

发布时间:2026-01-24 16:03:09

|

570人浏览过

|

来源于php中文网

原创

全局作用域是laravel模型层面自动注入的查询条件,只要使用该模型进行eloquent查询(where、get、find等),就会无感地加上你定义的约束。

如何为laravel模型定义全局作用域(global scope)? (自动应用查询条件)

什么是全局作用域,它在什么场景下必须用

全局作用域是 Laravel 模型层面自动注入的查询条件,只要使用该模型进行 Eloquent 查询(wheregetfind 等),就会无感地加上你定义的约束。典型场景包括:多租户系统中自动过滤 tenant_id,软删除之外的业务级状态隔离(如只查 status = 'active'),或租户内数据自动绑定当前用户所属组织。

注意:它不是中间件或服务层逻辑,而是直接嵌入到 Eloquent 的查询构建器中,对所有静态/实例查询生效(除非显式移除)。

如何定义一个可复用的全局作用域类

推荐用独立类实现 Illuminate\Database\Eloquent\Scope 接口,避免闭包作用域带来的测试与维护问题。关键点在于 apply() 方法必须调用 $builder->where() 或类似方法修改查询构建器。

  • 类必须实现 apply() 方法,接收 $builder$model 两个参数
  • 不要在 apply() 中调用 $builder->get() 或执行查询——那会破坏链式调用
  • 若需动态值(如当前租户 ID),应在作用域构造时传入,而非在 apply() 中读取全局状态(如 session()auth()),否则会导致队列任务或 API 请求上下文错乱
namespace App\Scopes;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Scope;

class TenantScope implements Scope
{
    protected $tenantId;

    public function __construct($tenantId)
    {
        $this->tenantId = $tenantId;
    }

    public function apply(Builder $builder, Model $model)
    {
        $builder->where('tenant_id', $this->tenantId);
    }
}

如何在模型中注册全局作用域

在模型的 booted() 方法中调用 static::addGlobalScope()。注意不是 boot(),因为 booted() 是模型类加载完成后的钩子,确保作用域注册时机正确。

  • 若作用域类带构造参数(如上例的 $tenantId),必须在 booted() 中获取该值(例如从请求上下文、服务容器或配置中读取)
  • 多个全局作用域按注册顺序叠加,但彼此独立;若逻辑冲突(如都改 where 同一字段),后注册的会覆盖先注册的
  • 不能在模型构造函数中注册,否则每次 new Model() 都会重复添加,导致作用域被多次应用
use App\Scopes\TenantScope;

class Post extends Model
{
    protected static function booted()
    {
        $tenantId = request()->user()?->tenant_id ?? config('app.default_tenant');
        static::addGlobalScope(new TenantScope($tenantId));
    }
}

如何临时取消某个全局作用域

withoutGlobalScope() 可跳过单个作用域,withoutGlobalScopes() 则跳过全部。这在后台管理、数据迁移或调试时非常必要——否则连 php artisan tinker 查数据都会被拦截。

  • withoutGlobalScope(TenantScope::class):只移除指定类的作用域
  • withoutGlobalScopes():彻底清空所有全局作用域(含 Laravel 自带的软删除)
  • 不支持按名字移除(如字符串标识),必须传类名或作用域实例
  • 这个方法只对当前查询链有效,不影响后续其他查询
// 跳过租户作用域查所有文章
$allPosts = Post::withoutGlobalScope(TenantScope::class)->get();

// 完全绕过所有全局作用域(含软删除)
$forceAll = Post::withoutGlobalScopes()->get();

真正容易被忽略的是:全局作用域对 count()exists()pluck() 等所有基于 Builder 的方法都生效,而不仅是 get()。如果忘记这点,在统计总数或判断是否存在时可能得到错误结果。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

阿里巴巴推出的全能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的相关内容,可以阅读本专题下面的文章。

772

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 后端服务体系。

463

2026.03.04

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

热门下载

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

精品课程

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

共137课时 | 13.4万人学习

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号