讲师中心 微信公众号
AI工具推荐 视频效率加速

Hyperf模型查询 scopes怎么用_Hyperf作用域查询自定义技巧【方法】

大敏酱_7518

大敏酱_7518

发布时间:2026-03-14 22:11:03

|

655人浏览过

|

来源于php中文网

原创

Hyperf模型的scopes是封装WHERE条件的便捷方式,分本地作用域(scopeXxx方法,链式调用)和全局作用域(自动注入通用条件,如tenant_id过滤),二者均用于复用查询逻辑,提升可读性与可维护性。

hyperf模型查询 scopes怎么用_hyperf作用域查询自定义技巧【方法】

Hyperf 模型的 scopes(作用域查询)是封装常用 WHERE 条件的便捷方式,让查询逻辑复用、可读性高、不易出错。它不是“写死在控制器里”的重复代码,而是定义在模型或 trait 中、通过方法链调用的动态条件。

本地作用域(Local Scopes)怎么定义和调用

本地作用域是模型或 trait 中以 scope 开头的公共方法,第一个参数固定为 $query(即 QueryBuilder 实例),后续参数接收业务值。

  • 必须是 public 方法,命名格式为 scopeXxx(如 scopeType),调用时用 xxx()(自动去掉 scope 前缀)
  • 方法内直接操作 $query->where(...),不 return,框架自动返回 builder 实例
  • 支持链式调用,比如 User::query()->type('admin')->sex('male')->get()

示例(在 trait 中定义):

Hyperframes Creative
Hyperframes Creative

HyperFrames视频非动画创意指导,包括设计规范(frame.md/design.md)处理、配色、字体设计、旁白及节奏规划等。

下载
<?php
trait LinkQuery {
  public function scopeType($query, $typeVal) {
    $query->where('type', $typeVal);
  }
  public function scopeSex($query, $sexVal) {
    $query->where('sex', $sexVal);
  }
}

全局作用域(Global Scopes)自动注入通用条件

全局作用域适用于所有该模型的查询都需强制附加的条件,比如多租户系统的 tenant_id 过滤,或软删除字段 deleted_at IS NULL。

  • 推荐实现 Scope 接口(如 TenantScope),在 apply() 方法中添加 where
  • 在模型的 boot() 方法中注册:static::addGlobalScope(new TenantScope());
  • 也可用闭包方式快速注册:static::addGlobalScope('tenant', fn($builder) => $builder->where('tenant_id', get_tenant_id()));
  • 临时取消全局作用域:用 withoutGlobalScopes() 或 withoutGlobalScope(TenantScope::class)

静态查询方法 vs scopes:什么时候选哪个

两者都能封装查询逻辑,但语义和扩展性不同:

  • scopes 是 builder 级别增强,天然支持链式、可组合、可被其他 scope 复用;适合「条件片段」
  • 静态方法(如 public static function latestUsers())更适合封装完整查询流程,比如带 orderBy、limit、with 关联等复合逻辑
  • 注意:scope 方法不能直接调用 get() 或 first(),否则会中断链式;如需立即执行,应另写静态方法

调试与注意事项

scopes 看似简单,但容易踩坑:

  • 确保方法名严格遵循 scopeXxx 规则,否则调用时找不到(Hyperf 不报错,只是静默忽略)
  • 不要在 scope 中做 DB 查询、Redis 调用等耗时操作——它是构建 SQL 的阶段,不是执行阶段
  • 多个 scope 同时使用时,where 条件按调用顺序叠加,无隐式优先级;复杂逻辑建议抽成独立 scope 而非嵌套 if
  • 测试 scope 是否生效?可用 toSql() 查看生成的 SQL:User::query()->type('vip')->toSql()

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

相关专题

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

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

2949

2023.06.20

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

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

2228

2023.07.25

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

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

1180

2023.08.02

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

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

1138

2023.08.09

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

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

1316

2023.09.05

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

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

2058

2023.09.20

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

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

3260

2023.09.20

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

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

14555

2023.09.22

FrankenPHP集成Laravel详细教程
FrankenPHP集成Laravel详细教程

本专题提供FrankenPHP集成Laravel的详细配置指南,全面解析运行原理、开发环境搭建、Caddyfile配置、Octane工作模式、数据库连接、队列任务、定时任务和生产环境优化,解决部署过程中常见的报错与兼容性问题。

0

2026.10.08

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Hyperf官方中文手册(3.1)
Hyperf官方中文手册(3.1)

共0课时 | 0人学习

Swoole系列-从0到1-新手进阶
Swoole系列-从0到1-新手进阶

共29课时 | 2.3万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn