0

0

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

星夢妙者

星夢妙者

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

|

595人浏览过

|

来源于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 中定义):

<?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

MusicAI
MusicAI

AI音乐生成工具

下载
  • 推荐实现 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())更适合封装完整查询流程,比如带 orderBylimitwith 关联等复合逻辑
  • 注意:scope 方法不能直接调用 get()first(),否则会中断链式;如需立即执行,应另写静态方法

调试与注意事项

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

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

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

1135

2023.10.12

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

340

2023.10.27

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

381

2024.02.23

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

2214

2024.03.06

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

380

2024.03.06

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

1703

2024.04.07

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

586

2024.04.29

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

440

2024.04.29

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

49

2026.03.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Swoole系列-从0到1-新手进阶
Swoole系列-从0到1-新手进阶

共29课时 | 1.5万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号