如何在Hyperf中拦截带有特定注解的方法_编写Aspect切面并配置annotations属性

落雪同学_4369

落雪同学_4369

2026-05-26

647人浏览

原创

hyperf中@aspect切面不生效,需检查切面类是否在scan目录、带#[aspect]注解且非abstract/final,运行di:dump验证是否被扫描;代理类未生成则需确认aspectcontainer注册并清缓存;目标方法未拦截须核对切入规则是否精确匹配。

如何在hyperf中拦截带有特定注解的方法_编写aspect切面并配置annotations属性

Hyperf中Aspect切面不生效?检查@Aspect类是否被正确扫描

Hyperf的AOP依赖注解扫描,如果切面类没被自动加载,@Pointcut和@Around等注解就完全不会触发。默认情况下,Hyperf只扫描app/Aspect目录下的类,且该类必须满足两个条件:带有@Aspect注解、类名以Aspect结尾(如UserOperationAspect)。

常见错误是把切面放在app/Service/Aspect/这种非标准路径下,或类名写成UserAspectHandler——Hyperf会直接忽略它。

  • 确保切面类路径为app/Aspect/xxxAspect.php
  • 类顶部必须声明@Aspect,且不能漏掉use Hyperf\Di\Annotation\Aspect;
  • 在config/autoload/annotations.php中确认scan配置已包含app/Aspect目录

如何匹配带自定义注解的方法?用@Pointcut写对表达式

Hyperf的@Pointcut不支持直接写@MyAnnotation这种语法,必须用execution + annotation组合。比如你想拦截所有标有@NeedAudit的方法,表达式得写成:

@Pointcut(
    "execution(public * App\Controller\*->*(*)) && annotation(App\Annotation\NeedAudit)"
)

注意三点:第一,annotation()括号里填的是**完整命名空间+类名**,不是短名;第二,execution部分要足够宽泛但又不能太宽——写成*->*()可能误伤框架内部方法;第三,Hyperf 3.x 要求annotation必须是类注解(@Target("CLASS"))或方法注解(@Target("METHOD")),不能是参数或属性注解。

  • 自定义注解类必须加@Retention(RetentionType.RUNTIME),否则运行时读不到
  • 如果想同时匹配类上和方法上的@NeedAudit,得写两个@Pointcut,Hyperf不支持||逻辑或
  • 表达式里的空格和括号必须严格匹配,多一个空格会导致解析失败且无报错

@Around方法里怎么拿到被拦截方法的注解值?

Hyperf的@Around回调函数签名是public function process(ProceedingJoinPoint $proceedingJoinPoint),它本身不暴露注解实例。你需要手动从反射中提取:

Hyperframes Creative
Hyperframes Creative

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

下载
$method = $proceedingJoinPoint->getOriginalMethod();
$annotation = $method->getAnnotation(\App\Annotation\NeedAudit::class);
if ($annotation && $annotation->level === 'high') {
    // 执行审计逻辑
}

这里容易出错的是:getAnnotation()返回null时直接调用属性会报错;另外,如果注解用了@Repeatable,得用getAnnotations()并遍历。

  • 别用$proceedingJoinPoint->getMethod()->getAnnotation(),因为getMethod()返回的是代理方法,反射信息可能不全
  • 如果注解字段是array类型,Hyperf默认不自动转换,需手动json_decode($annotation->rules, true)
  • 获取类级注解要用$proceedingJoinPoint->getClass()->getAnnotation()

为什么annotations配置项不起作用?它根本不是给切面用的

很多人在config/autoload/annotations.php里配annotations数组,以为能控制哪些注解参与AOP扫描——其实这个配置只影响AnnotationCollector的静态收集行为,和@Pointcut的运行时匹配完全无关。切面匹配靠的是PHP反射+表达式解析,不走这个配置项。

真正影响切面行为的是scan下的paths和ignore_annotations(后者用于排除某些注解不被收集,但也不影响@Pointcut)。

  • annotations配置项只在你主动调用AnnotationCollector::getAnnotationsByClass()时才生效
  • 想调试切面是否匹配成功,可在@Around里加var_dump($proceedingJoinPoint->getMethodName()),而不是查日志
  • Hyperf 2.2+ 开始,ignore_annotations默认包含Doctrine\ORM\Mapping\*等ORM注解,避免干扰AOP性能

最常被忽略的一点:切面方法必须是public,且不能有类型声明冲突(比如void返回值但process里忘了return $proceedingJoinPoint->process();),否则整个请求会静默失败。

相关文章

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

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

下载

相关标签:

hyperf

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

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

10644

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

6241

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2135

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

3928

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4634

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3651

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

5197

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

4082

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

12002

4

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共29课时 | 2.3万人学习