如何在Hyperf中获取自定义注解的所有应用实例_调用AnnotationCollector::getClassesByAnnotation

千萱大大_9641

千萱大大_9641

2026-05-23

349人浏览

原创

annotationcollector::getclassesbyannotation 返回空数组主因是调用过早,注解扫描尚未完成;需确保在 onworkerstart 或命令行 handle() 中调用,且注解类位于扫描路径、正确声明 @annotation 并继承 abstractannotation。

如何在hyperf中获取自定义注解的所有应用实例_调用annotationcollector::getclassesbyannotation

AnnotationCollector::getClassesByAnnotation 返回空数组?

多数时候不是注解没写对,而是 AnnotationCollector 还没完成扫描 —— Hyperf 的注解收集发生在容器启动的「扫描阶段」,早于你手动调用的位置。比如在 __construct 里直接查,类可能尚未被扫描;在 onWorkerStart 或命令行 handle() 中调用才安全。

  • 确保注解类已正确声明 @Annotation 并继承 AbstractAnnotation
  • 自定义注解类必须放在 app/Annotation(或配置中指定的扫描路径)下,且命名空间与目录结构一致
  • 检查 config/autoload/annotations.php 中的 scan 配置是否包含你的注解类所在目录
  • 运行 php bin/hyperf.php di:scan 后再启动服务(开发时建议开启 scan.enable

getClassesByAnnotation 第二个参数 $includeSubclasses 是干啥的?

这个布尔参数控制是否递归查找子类上标注了该注解的类。默认为 false,只返回直接标注了该注解的类;设为 true 后,若 A 类用了 @MyAnnotation,B 类继承 A 但没加注解,getClassesByAnnotation(MyAnnotation::class, true) 仍会返回 B —— 因为它“间接拥有”该注解语义。实际项目中极少需要开启,除非你在构建类似 Spring 的 AOP 继承链模型。

Hyperframes Creative
Hyperframes Creative

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

下载
  • 绝大多数场景保持默认 false 即可
  • 开启后性能无明显损耗,但语义容易混淆,调试时难定位真实标注位置
  • 若依赖继承传播,建议改用 AnnotationCollector::getMethodsByAnnotation + 手动向上遍历反射类

为什么 getClassesByAnnotation 找不到 Controller 方法上的注解?

getClassesByAnnotation 只查类级别注解(即写在 class 关键字上方的),方法、属性、参数上的注解得用对应方法:getMethodsByAnnotationgetPropertiesByAnnotationgetParametersByAnnotation。Controller 方法上常见的 @GetMapping@Middleware 都是方法级注解,不会出现在 getClassesByAnnotation 结果里。

  • 确认注解目标(@Target)是否为 Target::CLASS
  • 方法级注解请改用 AnnotationCollector::getMethodsByAnnotation(MyAnnotation::class)
  • 返回值是二维数组:[类名 => [方法名 => 注解实例]],注意遍历方式

生产环境调用 AnnotationCollector 要注意什么?

扫描结果在容器启动时固化为静态数组,后续调用是纯内存读取,无 IO 开销。但要注意:热重载(如 Swoole reload)不会自动刷新注解缓存,修改注解后必须重启 Worker;另外,getClassesByAnnotation 不做运行时校验,若传入不存在的注解类名(如拼错类名),会静默返回空数组,不报错。

  • 上线前用单元测试断言关键注解是否被正常收集,例如:$this->assertNotEmpty(AnnotationCollector::getClassesByAnnotation(MyRoute::class))
  • 避免在高频请求路径中反复调用(虽然快,但没必要),可考虑首次调用后缓存结果
  • 注解类名必须带完整命名空间,MyAnnotation::class 比字符串 'MyAnnotation' 更安全
复杂点在于注解生命周期和作用域的错位——你以为它“随时可用”,其实它只在扫描完成后才存在;你以为它“全局统一”,其实每个 Worker 进程的 Collector 实例是独立的(不过扫描结果相同)。别依赖运行时动态注册注解。

相关文章

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

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

下载

相关标签:

hyperf

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

相关专题

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

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

2023.06.20

2509

3

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

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

2023.07.25

2068

9

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

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

2023.08.02

1060

5

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

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

2023.08.09

978

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

1236

5

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

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

2023.09.20

1878

7

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

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

2023.09.20

2820

8

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

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

2023.09.22

12055

6

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

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

2023.09.22

509

3

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共29课时 | 2.2万人学习