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() 是模型类加载完成后的钩子,确保作用域注册时机正确。

蕉点AI
蕉点AI

AI电商商品图生成平台 | 智能商品素材制作工具

下载
  • 若作用域类带构造参数(如上例的 $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()。如果忘记这点,在统计总数或判断是否存在时可能得到错误结果。

相关专题

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

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

2846

2023.09.01

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

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

1697

2023.10.11

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

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

1556

2023.10.11

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

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

1058

2023.10.23

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

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

1505

2023.10.23

html怎么上传
html怎么上传

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

1256

2023.11.03

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

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

1629

2023.11.09

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

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

1308

2023.11.13

c++ 根号
c++ 根号

本专题整合了c++根号相关教程,阅读专题下面的文章了解更多详细内容。

24

2026.01.23

热门下载

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

精品课程

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

共137课时 | 9.2万人学习

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

共6课时 | 10.4万人学习

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

共13课时 | 0.9万人学习

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

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