Laravel作用域Scope_模型查询作用域定义方法【指南】

冬杰吖_5823

冬杰吖_5823

2026-05-02

679人浏览

原创

作用域是查询逻辑的封装契约,非语法糖;本地作用域须为public方法、首参$query、显式return;全局作用域应在booted()中注册,慎用闭包;关联筛选需withwherehas,避免orwhere滥用。

laravel作用域scope_模型查询作用域定义方法【指南】

作用域不是语法糖,是查询逻辑的封装契约——写错签名、漏掉返回、混用 orWhere,查出来的数据就可能出错。

本地作用域必须是 public 方法,且第一个参数固定为 $query

常见错误现象:Call to undefined method App\Models\User::active() 或链式调用中断(比如 ->active()->orderBy(...) 报错)。这通常是因为:方法没加 public 修饰符、首参不是 $query、或者忘了 return $query。

  • 定义时签名必须是 public function scopeActive($query),不能是 static(Laravel 10+ 允许 static,但非必需;非 static 更直观,也兼容所有版本)
  • $query 类型是 Illuminate\Database\Eloquent\Builder,不是 $this,也不是模型实例
  • 必须显式 return $query,否则后续链式调用会丢失上下文
  • 调用时写 ->active(),不能省略括号;写成 ->active 会直接报错

带参数的本地作用域要防御空值,避免生成无效 where

使用场景:按关键词搜索、按状态筛选、按时间范围过滤——这些条件往往来自请求参数,可能为空或缺失。硬写 where('keyword', $kw) 会导致 SQL 报错或语义错误。

Laravel Creem Agent
Laravel Creem Agent

Creem 支付商店助理 — 查询订阅、客户、交易、产品,执行心跳检查,管理本地 Laravel支付商店。

下载
  • 参数应设默认值,例如 scopeKeyword($query, $kw = '')
  • 内部用 if (! blank($kw)) { $query->where('title', 'like', "%{$kw}%"); } 控制是否追加条件
  • 不要依赖全局变量或 request(),所有输入必须显式传入,保证作用域可测试、可复用
  • 多个参数顺序必须紧贴 $query,如 scopeBetween($query, $start, $end),调用为 ->between('2026-01-01', '2026-04-30')

全局作用域注册必须在 booted() 中,闭包方式慎用于多模型共享

常见错误现象:全局作用域只生效一次、部分查询漏掉条件、测试环境下条件意外叠加——根源常在于注册时机或作用域类构造方式。

  • 必须用 protected static function booted(),不是 boot();booted() 是模型类完全加载后的钩子,确保作用域只注册一次
  • 闭包方式(addGlobalScope('tenant', function ($builder, $model) { ... }))适合单模型轻量逻辑;但无法被其他模型复用,也不易单元测试
  • 若作用域类需传参(如租户 ID),应在 booted() 中获取,例如 static::addGlobalScope(new TenantScope(request()->header('X-Tenant-ID')))
  • 多个全局作用域按注册顺序叠加,但 WHERE 条件是 AND 合并;若两个作用域都改 status 字段,后注册的会覆盖前一个

作用域不自动下推到关联查询,withWhereHas 才是正确解法

容易踩的坑:写 User::active()->with('posts')->get(),以为 active() 也会筛出「用户启用且文章启用」的数据——其实 active() 只作用于 User 表,posts 关联查的是全部。

  • 想约束关联模型,必须显式用 withWhereHas('posts', function ($q) { $q->active(); })
  • has('posts.active') 仅判断是否存在匹配的关联,不加载数据;需加载 + 筛选时,withWhereHas 是唯一可靠方式
  • 作用域内避免直接写 orWhere;它会脱离当前 AND 分组,导致逻辑爆炸。真需要 OR,用闭包包裹:$query->where(function ($q) { $q->where(...)->orWhere(...); })

最常被忽略的一点:全局作用域一旦注册,连 count()、exists()、pluck() 这些“非 get”查询都会生效——它不挑操作类型,只认模型。调试时别只看 get() 结果,得查原始 SQL 才能确认条件是否真被加上了。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

laravel 作用域

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

2989

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2268

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1200

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1138

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1336

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2098

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3300

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

14795

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
如何安装 Composer
如何安装 Composer

共1课时 | 201人学习

Composer手册
Composer手册

共0课时 | 0人学习