如何在Hyperf中获取方法上所有注解的顺序_利用Reflection方法配合Collector解析

雨雪酱_7241

雨雪酱_7241

2026-05-23

395人浏览

原创

hyperf中需通过ast的methodnode获取有序注解而非reflectionmethod;因collector会去重归一化,必须用scanner获取methodnode,调用getcomments()后经docparser解析,且须确保scan配置精准覆盖目标文件路径。

如何在hyperf中获取方法上所有注解的顺序_利用reflection方法配合collector解析

Hyperf中ReflectionMethod默认不保留注解顺序

Hyperf底层用的是PHP原生反射,而ReflectionMethod::getDocComment()返回的是原始文档字符串,不带结构化解析;直接用DocParser或AnnotationReader解析时,注解顺序容易丢失——尤其当多个同名注解(如多个@Middleware)连续出现时,Hyperf默认的Collector会按类/方法维度合并去重,而非严格保序。

必须用Hyperf\Di\Annotation\Ast\MethodNode提取原始AST节点

Hyperf在注解扫描阶段会将PHP源码解析为AST,其中MethodNode完整保留了注解在源码中的位置和顺序。绕过运行时反射,改走编译期AST路径才是可靠方案:

  • 确保项目已启用注解扫描(scan配置开启,且目标类在scan.directory内)
  • 通过Hyperf\Di\Annotation\Scanner获取MethodNode实例,而非ReflectionMethod
  • MethodNode->getComments()返回PhpParser\Node\Stmt\ClassMethod关联的全部PhpParser\Node\Comment\Doc,需进一步用Hyperf\Di\Annotation\Ast\DocParser逐条解析

示例关键片段:

Hyperframes Creative
Hyperframes Creative

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

下载
// 假设已知 $className 和 $methodName
$scanner = $container->get(Scanner::class);
$nodes = $scanner->getCollectedMethodNodes($className, $methodName);
foreach ($nodes as $node) {
    $comments = $node->getComments();
    foreach ($comments as $comment) {
        $parsed = DocParser::parse($comment->getText());
        // $parsed 是有序数组,每项含 name、attributes、line 等字段
    }
}

Collector类本身不暴露顺序信息,别试图从Collector::get($name)取

Collector::get('Middleware')这类调用返回的是归一化后的注解实例集合,内部做了array_unique和键重排,原始声明顺序已不可逆。即使你手动调用Collector::clear()再触发重扫,也仅影响缓存,不改变解析逻辑。

  • 真正需要顺序的场景(如中间件执行链、参数校验优先级),应直接基于AST解析结果构建有序列表
  • 若必须复用Collector,可临时修改其collect方法,在add前记录$node->getLine()并存入额外元数据字段(但属侵入式改动,不推荐)
  • 注意:Hyperf 3.x 中MethodNode的getComments()可能为空——此时说明该方法未被AST扫描覆盖,检查scan配置是否遗漏文件后缀(如.php)或命名空间

实际使用时最容易忽略scan.enable和scan.paths的匹配精度

很多开发者以为只要开了scan.enable = true就万事大吉,结果getCollectedMethodNodes始终返回空数组。根本原因常是:

  • scan.paths配置的路径未包含目标控制器所在目录(比如只写了app/Controller,但实际类在app/Http/Controller)
  • 路径末尾漏掉/导致glob匹配失败(Hyperf对路径拼接较敏感)
  • 注解写在use语句之后、class关键字之前,这种“类级注解”不会进入MethodNode,得查ClassNode

验证是否生效最简单的方法:var_dump($scanner->getCollectedMethodNodes('App\Controller\IndexController', 'index')); —— 返回空数组就是扫描没命中,别往下调试解析逻辑。

相关文章

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

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

下载

相关标签:

hyperf

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

相关专题

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

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

2023.06.20

2869

3

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

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

2023.07.25

2188

9

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

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

2023.08.02

1160

5

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

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

2023.08.09

1098

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

1296

5

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

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

2023.09.20

2038

7

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

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

2023.09.20

3180

8

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

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

2023.09.22

14035

6

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

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

2023.09.22

529

3

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共29课时 | 2.3万人学习