laravel怎么实现一个全局的查询作用域(Global Scope)_laravel全局查询作用域实现方法

30次阅读

通过定义全局查询 作用域 可自动为 laravel 模型的所有查询添加条件。1、创建实现 Scope接口 的 ActiveScope 类并在 apply 方法中设置 where 约束;2、在模型的 booted 方法中用 addGlobalScope 注册该作用域;3、也可直接使用 闭包 方式在模型中定义简单全局作用域,无需独立类文件。

laravel 怎么实现一个全局的查询作用域(Global Scope)_laravel 全局查询作用域实现方法

如果您希望在 Laravel 的 Eloquent 模型中自动为所有查询添加特定的条件限制,可以通过定义全局查询 作用域 来实现。这样可以确保每次从 数据库 中检索数据时都应用相同的过滤规则。

本文运行环境:macBook Pro,macOS Sonoma

一、创建全局作用域类

通过实现一个独立的作用域类,可以在多个模型中复用相同的查询逻辑。该类需要实现 IlluminatedatabaseEloquentScope 接口,并重写 apply 方法以添加查询约束。

1、在命令行中执行 Artisan 命令创建自定义作用域类:php artisan make:scope ActiveScope

2、打开生成的 app/Scopes/ActiveScope.php 文件,编辑内容如下:

use IlluminateDatabaseEloquentBuilder;

use IlluminateDatabaseEloquentModel;

use IlluminateDatabaseEloquentScope;

class ActiveScope implements Scope

{

    public function apply(Builder $builder, Model $model)

    {

        $builder->where(‘status’, ‘=’, ‘active’);

    }

}

3、此方法会在查询构建时自动附加 status = ‘active’ 的条件。

二、在模型中注册全局作用域

将已定义的作用域类注册到指定的 Eloquent 模型中,使得该模型的所有数据库查询默认包含作用域中的约束条件。

1、打开需要应用作用域的模型文件,例如 app/Models/User.php

2、在模型类的 booted 方法中调用 addGlobalScope 方法注册作用域:

laravel 怎么实现一个全局的查询作用域(Global Scope)_laravel 全局查询作用域实现方法

奇域

奇域是一个专注于中式美学的国风 AI 绘画创作平台

laravel 怎么实现一个全局的查询作用域(Global Scope)_laravel 全局查询作用域实现方法 30

查看详情 laravel 怎么实现一个全局的查询作用域(Global Scope)_laravel 全局查询作用域实现方法

protected Static function booted()

{

    static::addGlobalScope(new AppScopesActiveScope);

}

3、完成注册后,所有对 User 模型的查询都将自动包含 status 为 active 的条件。

三、使用闭包方式定义全局作用域

对于简单的查询约束,可以直接在模型中使用闭包形式定义全局作用域,无需创建额外的类文件。

1、在模型的 booted 方法内部,使用闭包传递给 addGlobalScope 方法:

protected static function booted()

{

    static::addGlobalScope(‘active’, function (Builder $builder) {

        $builder->where(‘status’, ‘=’, ‘active’);

}

2、此处的 ‘active’ 是作用域的名称,可用来后续移除该作用域。

四、移除全局查询作用域

在某些特殊情况下,可能需要临时忽略某个全局作用域的影响,可以使用 withoutGlobalScope 方法绕过特定或全部作用域。

1、若要移除某一命名作用域,使用 withoutGlobalScope(‘active’) 方法:

$users = User::withoutGlobalScope(‘active’)->get();

2、若要移除所有全局作用域,调用 withoutGlobalScopes() 方法:

$users = User::withoutGlobalScopes()->get();

3、也可选择性地传入数组参数,仅移除指定的作用域类列表。

以上就是 laravel 怎么实现一个全局的查询 作用域 (Global Scope)_laravel 全局查询作用域实现方法的详细内容,更多请关注php 中文网其它相关文章!

站长
版权声明:本站原创文章,由 站长 2025-11-12发表,共计1695字。
转载说明:除特殊说明外本站文章皆由CC-4.0协议发布,转载请注明出处。
1a44ec70fbfb7ca70432d56d3e5ef742
text=ZqhQzanResources