laravel为Model设置全局作用域

于 2024-07-20 03:26:28 发布
阅读量603 收藏 21
点赞数 22
文章标签： laravel scope
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/jinborui2/article/details/140562557
版权

如果一个项目中存在这么一个sql条件在任何情况下或大多数情况都会被使用，同时很容易被开发者遗忘，那么就非常适用于今天要提到的这个功能，Eloquent\Model的全局作用域。

        首先看一个示例，有个数据表，结构如下：

现用Laravel写一个查询语句：

$post = PostModel::where('cate_id', 2)->toSql();

打印$post结果是："select * from `news_post` where `cate_id` = ?"

现在就是只想查属于ID为001的学校的post数据，其他许多表都有这个school_id字段，都需要在查询时使用。这就是我们需要解决的简化的操作，实现自动在sql条件中添加"and school_id='ID001'"

结合官方文档和搜索引擎查询结果，找到一个实现方案就是设置全局作用域：

首先创建基础Model并 添加scope：

namespace App\Models;

use App\Models\Scopes\MyScopes;
use Illuminate\Database\Eloquent\Model;

class BaseModel extends Model
{
    public $school_id = '';

    public $alias = '';

    public function __construct(array $attributes = [])
    {
        $this->bootIfNotBooted();

        $this->initializeTraits();

        $this->syncOriginal();

        $token = app()->get('mytoken');
        $user = getDataByToken($token); //根据token获取存储在redis里的用户数据
        if(!empty($user) && isset($user['school_id'])){
            $attributes['school_id'] = $this->school_id = $user['school_id'];
        }

        $this->fill($attributes);
    }

    protected static function boot()
    {
        parent::boot();

        static::addGlobalScope(new MyScopes());
    }

}

在构造方法中通过登录token信息获取用户的基础信息包括所属学校ID，赋值给model属性，同时在boot中addGlobalScope全局添加自定义作用域,MyScopes如下：

namespace App\Models\Scopes;


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

class MyScopes implements Scope{

    public function apply(Builder $builder, Model $model)
    {
        $from = $builder->getQuery()->from;//表 + 别名(如果有的话)
        if(is_string($from)){ //不考虑非字符串情况，如子查询
            $fromArr = explode(' ', str_ireplace(' as ', ' ', $from));
            $alias = isset($fromArr[1]) ? $fromArr[1] : '';
            //添加全局条件
            if(!empty($model->school_id)){
                $fieldName = $alias ? $alias . '.' . 'school_id' : 'school_id';
                $builder->where($fieldName, $model->school_id);
            }
        }
    }
}

根据model属性是否有值决定是否添加查询条件，$builder->getQuery()获取到的是Query\Builder实例：

同时依据from来判断是否存在别名的情况，附加别名，适配为表设置别名或联查情况。

最后在后续创建Model时都需要继承BaseModel即可。

这样重新执行最开始的sql查询语句，打印出来的结果就是：

"select * from `news_post` where `cate_id` = ? and `school_id` = ?"

这样就达到了预期的效果，自动添加查询条件了，下面再试试增删改

更新：

DB::enableQueryLog();
PostModel::where('cate_id', 2)->update(['is_hot' => 1]);
$log = DB::getQueryLog();
var_dump($log);exit;

打印结果：

array(1){
    [
        0
    ]=>array(3){
        [
            "query"
        ]=>string(75)"update `news_post` set `is_hot` = ? where `cate_id` = ? and `school_id` = ?"[
            "bindings"
        ]=>array(3){
            [
                0
            ]=>int(1)[
                1
            ]=>int(2)[
                2
            ]=>string(5)"ID001"
        }[
            "time"
        ]=>float(310.23)
    }
}

删除：

DB::enableQueryLog();
PostModel::where(['title' => '春天', 'is_hot' => 0])->delete();
$log = DB::getQueryLog();
var_dump($log);exit;

打印结果：

array(1){
    [
        0
    ]=>array(3){
        [
            "query"
        ]=>string(80)"delete from `news_post` where (`title` = ? and `is_hot` = ?) and `school_id` = ?"[
            "bindings"
        ]=>array(3){
            [
                0
            ]=>string(6)"春天"[
                1
            ]=>int(0)[
                2
            ]=>string(5)"ID001"
        }[
            "time"
        ]=>float(217.09)
    }
}

 增：

DB::enableQueryLog();
$model = new PostModel();
$model->setAttribute('title', '冬天');
$model->setAttribute('content', '冬天,寒风彻骨！');
$model->setAttribute('uid', 1);
$model->setAttribute('cate_id', 2);
$model->setAttribute('createtime', time());
/* $model->title='冬天';
$model->content='冬天,寒风彻骨！';
$model->uid=1;
$model->cate_id=2;
$model->createtime=time();*/
$model->save();
$log = DB::getQueryLog();
var_dump($log);exit;

打印结果：

array(1){
    [
        0
    ]=>array(3){
        [
            "query"
        ]=>string(115)"insert into `news_post` (`school_id`, `title`, `content`, `uid`, `cate_id`, `createtime`) values (?, ?, ?,
?, ?, ?)"[
            "bindings"
        ]=>array(6){
            [
                0
            ]=>string(5)"ID001"[
                1
            ]=>string(6)"冬天"[
                2
            ]=>string(22)"冬天,寒风彻骨！"[
                3
            ]=>int(1)[
                4
            ]=>int(2)[
                5
            ]=>int(1721413065)
        }[
            "time"
        ]=>float(48.68)
    }
}

插入时也自动加入了school_id的数据

插入有多重形式，试试其他的：

create方法：

DB::enableQueryLog();
$data = [
    'title' => '秋天',
    'content' => '秋天，是收获的季节，也是思念的季节，它以一种宁静而深沉的美，让人沉醉！',
    'uid' => 2,
    'cate_id' => 2,
    'createtime' => time(),
];
PostModel::create($data);
$log = DB::getQueryLog();
var_dump($log);exit;

打印结果：

array(1){
    [
        0
    ]=>array(3){
        [
            "query"
        ]=>string(115)"insert into `news_post` (`title`, `content`, `uid`, `cate_id`, `createtime`, `school_id`) values (?, ?, ?,
?, ?, ?)"[
            "bindings"
        ]=>array(6){
            [
                0
            ]=>string(6)"秋天"[
                1
            ]=>string(105)"秋天，是收获的季节，也是思念的季节，它以一种宁静而深沉的美，让人沉醉！"[
                2
            ]=>int(2)[
                3
            ]=>int(2)[
                4
            ]=>int(1721413472)[
                5
            ]=>string(5)"ID001"
        }[
            "time"
        ]=>float(142.4)
    }
}

由上可知 create方法同样适用。

insert方法：

DB::enableQueryLog();
$data = [
    'title' => '秋天',
    'content' => '秋风送爽，落叶轻舞，绘就一幅金色的画卷。',
    'uid' => 2,
    'cate_id' => 2,
    'createtime' => time(),
];
PostModel::insert($data);
$log = DB::getQueryLog();
var_dump($log);exit;

打印结果：

array(1){
    [
        0
    ]=>array(3){
        [
            "query"
        ]=>string(99)"insert into `news_post` (`title`, `content`, `uid`, `cate_id`, `createtime`) values (?, ?, ?, ?, ?)"[
            "bindings"
        ]=>array(5){
            [
                0
            ]=>string(6)"秋天"[
                1
            ]=>string(60)"秋风送爽，落叶轻舞，绘就一幅金色的画卷。"[
                2
            ]=>int(2)[
                3
            ]=>int(2)[
                4
            ]=>int(1721413774)
        }[
            "time"
        ]=>float(145.6)
    }
}

由上可见insert方法似乎不适用。其实也可以从源码中看出端倪，Illuminate\Database\Eloquent\Builder中有一个属性：

表明了这些方法都是从query builder返回结果的。且在Eloquent\Builder中确实没有找到insert方法的定义，这也就导致基于Eloquent\Builder的一些操作没有生效。

同时使用Illuminate\Support\Facades\DB的操作也是基于query builder的亦无法使用作用域或model属性添加额外条件。

在Illuminate\Database\Query\Builder中找到了一个属性如下介绍：

 感觉似乎可以在query执行前进行干预，查询相关资料，在provider中尝试注册了下但没有生效，若有成功的大佬希望能交流一下。

接下来尝试下连表查询：

$log = PostModel::from('post as p')
    ->leftjoin('user as u', 'p.uid', '=', 'u.id')
    ->where(['p.cate_id' => '2'])
    ->toSql();

打印结果：

 "select * from `news_post` as `news_p` left join `news_user` as `news_u` on `news_p`.`uid` = `news_u`.`id` where (`news_p`.`cate_id` = ?) and `news_p`.`school_id` = ?"

 子表查询：

DB::enableQueryLog();
$subQuery = PostModel::where('is_hot', 1)->select(['uid', 'title','cate_id']);
$post = PostModel::fromSub($subQuery, 'p')->where('cate_id', 2)->select(['title'])->get();
$log = DB::getQueryLog();
var_dump($log);exit;

打印结果：

array(1){
    [
        0
    ]=>array(3){
        [
            "query"
        ]=>string(142)"select `title` from (select `uid`, `title`, `cate_id` from `news_post` where `is_hot` = ? and `school_id` =
?) as `news_p` where `cate_id` = ?"[
            "bindings"
        ]=>array(3){
            [
                0
            ]=>int(1)[
                1
            ]=>string(5)"ID001"[
                2
            ]=>int(2)
        }[
            "time"
        ]=>float(23.76)
    }
}

 子表条件查询：

DB::enableQueryLog();
$subQuery = PostModel::where('is_hot', 1)->select([DB::raw('DISTINCT(uid)')]);
UserModel::whereIn('uid', $subQuery)->get(['username']);
$log = DB::getQueryLog();
var_dump($log);exit;

打印结果：

array(1){
    [
        0
    ]=>array(3){
        [
            "query"
        ]=>string(148)"select `username` from `news_user` where `uid` in (select DISTINCT(uid) from `news_post` where `is_hot` = ?
and `school_id` = ?) and `school_id` = ?"[
            "bindings"
        ]=>array(3){
            [
                0
            ]=>int(1)[
                1
            ]=>string(5)"ID001"[
                2
            ]=>string(5)"ID001"
        }[
            "time"
        ]=>float(31.77)
    }
}

 测试的差不多了，综上除了insert方法，基于Model的增删改查操作，全局作用域基本都能生效，

且insert方法可以被save或create方法代替。

而基于Facades\DB的数据库操作如何全局添加条件还未找到可实现的方案，目前想到的是把Facades\DB进行封装，调用封装好的方法或对象，另外可以从Query\Builder的$beforeQueryCallbacks找突破口。希望有好的解决方案的大佬能分享出来，感谢！

爬山虎还上班
关注
  • 22
    点赞
  • 踩
  • 21
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Laravel开发-eloquent-rest-filter
08-27
作用域是一种定义在模型上的全局查询修改器，可以在任何时候应用到查询上。它们通常用于封装常见的查询条件，例如只获取已激活的用户或按某种状态排序等。作用域的定义一般在模型类中，以`scope`前缀的静态方法形式...
Laravel开发-eloquent-acl
08-27
Gates可以在全局作用域中定义，而Policies则为每个模型提供单独的授权方法。 6. **中间件**：使用自定义的中间件，我们可以对整个应用的路由或特定控制器方法进行权限过滤，这样可以确保只有具有相应权限的用户才能...
【Laravel】为Eloquent 模型设置全局作用域和局部作用域进行查询
unber的博客
10-02 214
【Laravel】为Eloquent 模型设置全局作用域和局部作用域进行查询
laravel model 作用域
迷失的鱼的博客
09-08 324
全局作用域 所谓「全局作用域」，指的是预置过滤器在注册该「全局作用域」的模型类的所有查询中生效，不需要指定任何额外条件。 以User模型类为例，我们在系统中可能只想针对已经验证过邮箱的用户进行操作，在没有介绍「作用域」之前，可能你会在应用中到处编写这样的代码： $users = User::whereNotNull('email_verified_at')->... 通过全局作用域类实现 要实现「全局作用域」，首先需要编写一个实现Illuminate\Database\Eloquen...
scope全局作用域php,laravel scope作用域的使用
weixin_31226805的博客
03-27 204
场景在项目中 经常会面对一些条件的查询，这些查询条件好些是相同的。scope可以实现这些相同条件的复用.局部作用域这种用法是最常见的场景. eg: 一个论坛的问题的发布系统肯定是有一项是隐藏帖子，不显示给其他人看.写法1. 命名方式. scope+自定义的方法名2. 传参. 第一个参数是查询生成器. 如果传入参数 那么可以生成动态的效果 eg: scopePublished($...
php 局部和全局作用域,Laravel 使用全局作用域和局部作用域进行查询
weixin_33835461的博客
03-17 223
全局作用域是指在模型类中预设过滤器，在模型类的所有查询中都生效。通过全局作用域类实现编写一个实现Illuminate\Database\Eloquent\Scope 接口的全局作用域类，这里我们将其命名为 EmailVerifiedAtScope，并将其放到 app/Scopes 目录下：namespace App\Scopes;use Illuminate\Database\Eloquent\B...
karir
03-17
2. **变量作用域**：PHP有四种变量作用域：局部（local）、全局（global）、静态（static）和超全局（superglobal）。超全局变量如`$_GET`、`$_POST`用于处理HTTP请求数据。 3. **函数**：PHP支持自定义函数，可以...
php-modularity
03-12
命名空间提供了一种在全局作用域中避免命名冲突的方式，使得相同名字的类或函数在不同模块间可以共存。 ```php namespace MyModule; class MyClass { // ... } use MyModule\MyClass; ``` #### 2.3 自动加载...
PHP笔试+面试题1-4
04-22
- 变量：了解变量的声明、作用域（global, local, static）以及其生命周期。 - 数据类型：包括字符串、整型、浮点型、布尔型、数组、对象、NULL等。 - 运算符：算术、比较、逻辑、位运算符等。 - 控制流程：if.....
数据分析的核心技能和方法
07-19
数据分析的核心技能和方法
毕业设计javajsp人寿保险销售网站(ssh)-qkrp源码含文档工具包
07-19
毕业设计javajsp人寿保险销售网站(ssh)-qkrp源码含文档工具包 后台是ssh框架，页面是jsp，数据库mysql，jdk1.8，开发工具用ecplise、myecplise、sts、idea都可以 平湖人寿保险公司保险销售网站分为用户和管理员两个部分 前台部分（用户界面）： 1、资讯浏览功能： （1）新闻资讯浏览 （2）新闻资讯查询 （3）公司简介 （4）通知公告 2、用户登录注册功能： （1）注册 （2）登录 3、用户管理功能 （1）个人信息管理 （2）订单管理 4、保险购买功能： （1）保险产品浏览 （2）保险产品查询 （3）保险产品购买 后台管理（管理员界面） 1、管理员登录功能： 管理员在管理员登录界面输入用户名和密码，即可登录管理员的界面。 2、资讯管理功能： （1）新闻资讯管理 （2）公司简介管理 （3）通知公告管理 3、保险产品管理： （1）保险产品信息管理 （2）保险产品查询 4、会员管理： （1）会员删除 （2）会员级别管理 5、统计管理： （1）保险产品销售量统计 （2）有效会员数量统计 包含：源码、数据库脚本、论文、环境工具包、相同框架项目的安装教程
毕业设计javajsp公共课考试系统(ssh)-qlkrp源码工具包
07-19
毕业设计javajsp公共课考试系统(ssh)-qlkrp源码工具包 后台是ssh框架，页面是jsp，数据库mysql，jdk1.8，开发工具用ecplise、myecplise、sts、idea都可以 题库 试卷信息管理 阅卷 统计功能 包含：源码、数据库脚本、环境工具包、相同框架项目的安装教程（在说明文档中）
揭秘黑箱：YOLO预测结果的可解释性探究
07-19
YOLO（You Only Look Once）是一种流行的实时对象检测系统，最初由 Joseph Redmon 等人在 2015 年提出。它的核心思想是将对象检测任务视为一个回归问题，直接从图像像素到边界框坐标和类别概率的映射。YOLO 以其快速和高效而闻名，特别适合需要实时处理的应用场景。 以下是 YOLO 的一些关键特点： 1. **单次检测**：YOLO 模型在单次前向传播中同时预测多个对象的边界框和类别概率，不需要多次扫描图像。 2. **速度快**：YOLO 非常快速，能够在视频帧率下进行实时检测，适合移动设备和嵌入式系统。 3. **端到端训练**：YOLO 模型可以从原始图像直接训练到最终的检测结果，无需复杂的后处理步骤。 4. **易于集成**：YOLO 模型结构简单，易于与其他视觉任务（如图像分割、关键点检测等）结合使用。 5. **多尺度预测**：YOLO 可以通过多尺度预测来检测不同大小的对象，提高了检测的准确性。 YOLO 已经发展出多个版本，包括 YOLOv1、YOLOv2（也称为 YOLO9000）、YOLOv3、YOLOv4 和 YOLOv5 等。
吃鸡pubg适用于罗技GHUB的鼠标宏
07-19
安装步骤如下！ 导入lua宏到GHUB的步骤如下： 1. 打开GHUB，选择你的罗技鼠标。 2. 转到“宏”选项卡，创建一个新的宏。 3. 在宏编辑器中，点击“导入”，选择"pubg1.lua"文件。 4. 宏会自动加载lua文件中的所有操作，你可以调整它们的顺序或延迟时间，以适应自己的游戏风格。 5. 将这个宏绑定到鼠标上的任意按键，就可以在游戏中使用了
基于海洋捕食者优化算法MPA-VMD实现信号去噪目标函数为包络信息熵 包络熵 排列熵 样本熵最小附matlab代码.rar
07-19
1.版本：matlab2014/2019a/2021a 2.附赠案例数据可直接运行matlab程序。 3.代码特点：参数化编程、参数可方便更改、代码编程思路清晰、注释明细。 4.适用对象：计算机，电子信息工程、数学等专业的大学生课程设计、期末大作业和毕业设计。 5.作者介绍：某大厂资深算法工程师，从事Matlab算法仿真工作10年；擅长智能优化算法、神经网络预测、信号处理、元胞自动机等多种领域的算法仿真实验，更多仿真源码、数据集定制私信+。 替换数据可以直接使用，注释清楚，适合新手
工业控制系统安全测评指导书（二级）
最新发布
07-20
工业控制系统安全测评指导书（二级）
基于springboot+jsp的毕业生信息管理系统数据库表
07-19
设计一个毕业生信息管理系统，可实现管理员、辅导员、学生用户进行登录的系统，去除掉一些不必要的功能并添加一些新的功能使得页面更加简洁，用户可简单直接地进行操作该系统，并且更好地使用该系统，从而对毕业生的信息进行更好的管理。
高分项目-基于SpringBoot框架实现的旧物置换网站（包含全套源码 + 数据库sql + 论文）.zip
07-19
高分项目-基于SpringBoot框架实现的旧物置换网站（包含全套源码 + 数据库sql + 论文）
model的addattribute作用域
04-11
Q: "model的addattribute作用域" A: 在不同作用域中使用model的addAttribute方法会导致不同的结果。通常，addAttribute方法在控制器中使用，以将数据添加到视图中，这些数据可以在视图中使用EL表达式进行访问。在控制器方法中，addAttribute方法只能在该方法中使用，不能在其他方法中访问。在Spring MVC中，使用@RequestMapping注解指定的控制器方法的作用域是请求作用域。这意味着addAttribute方法添加到model的所有属性只在请求期间有效，请求结束后将被丢弃。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值