Hyperf中如何给带有注解的方法增加日志埋点_编写统一的Aspect切面处理类

秋静姑娘_4965

秋静姑娘_4965

2026-05-24

380人浏览

原创

默认情况下,Hyperf 的 @Trace 注解仅触发性能追踪(如 SkyWalking),不自动打业务日志;要实现方法进出结构化日志,必须手动编写 Aspect 切面类,且目标方法所在类须为容器管理对象(如标记 @Controller/@Service)、非 private/static,并正确配置 @Aspect 与切入点。

hyperf中如何给带有注解的方法增加日志埋点_编写统一的aspect切面处理类

Hyperf中用@Trace注解标记方法后,日志埋点没生效?

默认情况下,Hyperf 的 @Trace 注解仅触发性能追踪(如 SkyWalking),不自动打业务日志。要实现「方法进入/退出时输出结构化日志」,必须手动编写 Aspect 切面类,不能只依赖注解本身。

关键前提是:目标方法所在类必须是 Hyperf 的容器管理对象(即通过 @Inject 或 make() 获取的实例),否则 AOP 代理不会生效。

  • 确保方法所在类被 @Controller、@Service 或 @Component 等注解标记
  • 方法不能是 private 或 static —— AOP 无法代理
  • 切面类需继承 AbstractAspect 并正确配置 @Aspect

如何写一个支持 @LogTrace 的自定义切面类

Hyperf 不内置 @LogTrace,需要自己定义注解 + 切面。推荐路径:先建注解类,再写切面逻辑,最后注册到容器。

示例步骤:

  • 新建注解 App\Annotation\LogTrace,带 level 和 includeArgs 属性
  • 新建切面类 App\Aspect\LogTraceAspect,继承 AbstractAspect
  • 在 pointCut() 中匹配所有带 @LogTrace 的 public 方法:execution(public * ..*->*(..)) && @annotation(App\Annotation\LogTrace)
  • 在 process() 中用 $this->logger->info() 打入参、耗时、返回或异常

注意:$proceedingJoinPoint->getArguments() 返回的是原始参数数组,若需 JSON 化日志,得手动 json_encode($args, JSON_UNESCAPED_UNICODE),避免中文乱码。

为什么切面里 $proceedingJoinPoint->getClassName() 返回空?

这是常见错觉——getClassName() 实际返回的是代理类名(类似 Proxy\Hyperf\Di\Container),不是原始类。真要获取目标类,得用 $proceedingJoinPoint->getOriginalClass()。

Hyperframes Creative
Hyperframes Creative

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

下载
  • getClassName() → 代理类名(无业务意义)
  • getOriginalClass() → 原始类的 FQCN(如 App\Controller\UserController)
  • getMethodName() → 方法名(安全可用)

日志中想打印「UserController.login」这种格式,必须拼接 $proceedingJoinPoint->getOriginalClass() . '.' . $proceedingJoinPoint->getMethodName()。

切面中记录耗时但结果被缓存了怎么办?

如果方法上同时用了 @Cacheable,AOP 切面会在缓存命中时仍执行(因为 CacheAspect 是另一个切面,顺序靠前),导致日志重复且耗时不准确。

解决办法只有两个:

  • 调整切面优先级:给 LogTraceAspect 加 @Aspect(order=100),确保它在 CacheAspect(order=50)之后执行;但即使如此,缓存命中时 $proceedingJoinPoint->proceed() 不会真正调用原方法,耗时仍是 0ms
  • 更可靠的做法:不在切面里测耗时,改用 Hyperf\Utils\Timer::tick() 或直接读取 microtime(true) 手动计时,绕过代理链干扰

实际项目中,建议对缓存敏感的方法单独处理,比如加个 skipTiming=true 参数,避免误导性日志。

相关文章

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

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

下载

相关标签:

hyperf

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

相关专题

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

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

2023.06.20

3649

3

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

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

2023.07.25

2448

9

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

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

2023.08.02

1380

5

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

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

2023.08.09

1338

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

1416

5

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

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

2023.09.20

2358

7

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

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

2023.09.20

3920

8

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

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

2023.09.22

18515

6

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

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

2023.09.22

549

3

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共29课时 | 2.4万人学习