Laravel作用域怎么用_Laravel查询作用域方法【详解】

雨宇小哥_5394

雨宇小哥_5394

2026-05-12

333人浏览

原创

局部作用域必须以scope开头、首参为$query并返回$query,全局作用域须在booted中用addglobalscope注册;选错类型会导致条件漏加或绕过失效,调用不匹配则报方法未定义。

laravel作用域怎么用_laravel查询作用域方法【详解】

局部作用域必须显式调用才生效,全局作用域一旦注册就自动影响所有查询——选错类型会导致条件漏加、绕过失败或测试难覆盖。

scope开头的方法怎么写才有效

局部作用域本质是模型里的普通方法,但 Eloquent 只认以 scope 开头、且第一个参数为 $query(Illuminate\Database\Eloquent\Builder 实例)的方法。漏掉前缀或参数顺序错,调用时直接报 Call to undefined method。

  • 方法名必须是 scopeActive、scopeOfType 这种格式,调用时写成 ->active() 或 ->ofType('admin')
  • 第一个参数固定是 $query,后续才是自定义参数,例如 scopePublishedAfter($query, $date)
  • 必须 return $query,不能 return $query->get() 或 return null,否则链式调用中断
  • 别在作用域里调用 $this->where()——模型实例没有 where 方法,只有 $query 有

全局作用域为什么注册了却没生效

全局作用域必须在模型的 booted(或旧版 boot)静态方法中调用 addGlobalScope() 才会绑定。写在构造函数、属性初始化、或任意其他位置,都不会触发。

laravel-specialist
laravel-specialist

精通 Laravel 10+,遵循现代 PHP 实践的 Laravel 专家。擅长优雅语法、Eloquent ORM、队列系统及企业级特性...

下载
  • 类形式注册:用 static::addGlobalScope(new ActiveScope),排除时必须传 ActiveScope::class
  • 闭包形式注册:必须带字符串键名,如 static::addGlobalScope('active', function ($builder) { ... }),否则无法用 withoutGlobalScope('active') 移除
  • 多个全局作用域叠加时,执行顺序按 addGlobalScope() 调用顺序,后注册的包裹在外层,类似中间件洋葱模型
  • 软删除(SoftDeletes)本身就是一个全局作用域,它会和你的作用域嵌套,注意 where deleted_at is null 和你写的 where status = 'active' 的逻辑层级

什么时候该用 when() 而不是直接链式调用作用域

当某个查询条件是否启用取决于运行时变量(比如搜索表单提交了关键词、或 API 请求带了 include_draft=1),硬编码链式调用会污染查询逻辑,也容易出空值错误。

  • when() 是惰性执行:条件为 false 时,整个闭包被跳过,不会拼进 SQL
  • 适合组合动态参数,例如 User::when($request->filled('city'), fn($q) => $q->city($request->city))->get()
  • 避免在作用域内部做请求/认证判断——auth() 或 request() 在队列、命令行、测试中不可用,应在调用方取好值再传入
  • 如果只是简单开关,when() 比写一堆 if + 多次 ->where() 更语义清晰

如何安全地临时绕过全局作用域

withoutGlobalScope() 和 withoutScopes() 都只对当前查询链生效,但行为差异极大,用错会导致查出不该出现的数据(比如已删除记录)。

  • withoutGlobalScope(ActiveScope::class):只剔除指定类的作用域,软删除等其它全局作用域仍保留
  • withoutGlobalScope('active'):仅适用于闭包注册时用了字符串键名的场景,名称必须严格匹配
  • withoutScopes():清空所有全局作用域,包括 Laravel 自带的软删除约束,结果可能含 deleted_at IS NOT NULL 的记录
  • 事务中慎用全局作用域——auth()->id() 在 DB transaction 内可能为 null,推荐做法是在事务外取好上下文值(如 $tenantId),再用 where('tenant_id', $tenantId) 手动加条件

最常被忽略的是作用域的“生效边界”:局部作用域不调用等于没写,全局作用域注册后连 find() 和关联预加载(with())都会被影响;而 withoutGlobalScope() 的参数必须和注册时完全一致,类名、字符串键、大小写,一个都不能错。

相关文章

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

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

下载

相关标签:

laravel 作用域

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

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

2024.04.09

857

10

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

2024.04.09

835

9

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

2024.04.09

2488

10

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.10

4141

7

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

2025.08.05

5950

22

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

2025.08.05

3956

13

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

2025.08.05

7429

7

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

2026.03.04

1436

29

Laravel 框架安装指南
Laravel 框架安装指南

本指南详解 Laravel 框架安装全流程,涵盖 PHP 8.1+ 环境配置、Composer 依赖管理工具安装及国内镜像源优化。重点演示使用 composer create-project 命令创建 Laravel 10/11 项目,解决常见安装错误与依赖冲突。从环境搭建到项目初始化,助您快速完成 Laravel 开发环境部署,为后续 Web 应用开发奠定基础。适合 PHP 初学者与框架迁移开发者参考。

2026.04.09

215

6

热门下载

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

精品课程

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

共1课时 | 208人学习

Composer手册
Composer手册

共0课时 | 0人学习