讲师中心 微信公众号
AI工具推荐 视频效率加速

Hyperf如何优雅记日志_基于Hyperf AOP注解实现业务日志自动记录

秋敏吖_1625

秋敏吖_1625

发布时间:2026-05-19 10:24:39

|

302人浏览过

|

来源于php中文网

原创

Hyperf业务日志应通过自定义@Log注解与Around切面实现,需延迟组装日志、显式捕获异常、用ApplicationContext获取协程上下文、配置maskFields脱敏、设priority≥100避免事务冲突,并控制日志开关与序列化性能。

hyperf如何优雅记日志_基于hyperf aop注解实现业务日志自动记录 - php中文网

Hyperf 的业务日志不能靠手动写 Logger::info() 堆出来,用 AOP 注解自动织入才是正解——但直接套用官方 @Before 或 @Around 容易漏参数、丢上下文、日志格式混乱,甚至引发协程上下文错乱。

为什么不能直接在切面里调 Logger::info()

Hyperf 默认日志驱动(如 Monolog)本身是协程安全的,但问题出在「日志内容构造时机」:如果在 @Before 中就拼接完整日志字符串,方法还没执行,就拿不到返回值;若改用 @AfterReturning,又可能因异常跳过,导致日志缺失。更隐蔽的是:Context::get() 在非主协程中可能读不到当前请求的 request_id 或用户 ID。

  • 必须在 @Around 中统一控制执行前后,并显式捕获异常
  • 所有日志字段(入参、出参、耗时、异常堆栈)需延迟到方法执行完毕再组装
  • 务必通过 ApplicationContext::get(ContainerInterface::class)->get(ContextInterface::class) 获取当前协程上下文,而不是直接用静态 Context::get()

@Log 注解定义和切面实现的关键细节

自定义注解不能只声明一个空类,得带上可配置字段,比如是否记录参数、是否脱敏、是否包含堆栈。切面类里也要区分同步/异步方法——对 Coroutine::create 启动的协程,Context 需要手动传递。

  • 注解类必须加 @Annotation 和 @Target({Target::METHOD}),否则扫描不到
  • 切面 process 方法中,用 $proceedingJoinPoint->getArguments() 拿原始参数,别用 $proceedingJoinPoint->getMethod()->getParameters() 反射取名——它不包含实际传入值
  • 记录耗时时,用 microtime(true) 而非 date('H:i:s'),避免跨秒误差
  • 敏感字段(如 password、id_card)需按注解配置的 maskFields=["password"] 自动替换为 "***"
/**
 * @Annotation
 * @Target({Target::METHOD})
 */
class Log
{
    public $maskFields = [];
    public $includeArgs = true;
    public $includeResult = true;
}// 切面中序列化参数示例:
$args = $this->includeArgs ? $this->maskSensitive($joinPoint->getArguments(), $annotation->maskFields) : [];

如何避免日志刷屏和性能拖累

高频接口(如心跳、状态轮询)打满日志会迅速占满磁盘,且 JSON 序列化本身有开销。Hyperf 的 Logger 是异步写入,但切面里的序列化、字符串拼接、上下文提取全在主协程中同步执行。

  • 加开关控制:注解默认关闭,只对 @Log(enabled=true) 的方法生效
  • 对 GET 类查询接口,默认 includeArgs=false,只记 URL 和耗时
  • 避免在日志里 var_export($hugeArray, true) —— 改用 json_encode($arr, JSON_UNESCAPED_UNICODE | JSON_PARTIAL_OUTPUT_ON_ERROR) 并限制深度
  • 异常堆栈只取前 3 层(explode("\n", $e->getTraceAsString(), 4)[0] ?? ''),防止单条日志超 1MB

最常被忽略的一点:AOP 切面的 priority 值会影响执行顺序。如果你同时用了 @Transaction 和 @Log,而 @Log 的 priority 太高(数值小),就会在事务开启前就记录日志,导致事务回滚后日志却已落盘。建议把 @Log 的 priority 设为 100 以上,确保它在事务、验证等前置切面之后运行。

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

热门AI工具

更多
火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

相关专题

更多
Hyperf协程并发编程实操指南
Hyperf协程并发编程实操指南

本专题深度解析 Hyperf 协程底层机制,解决协程环境下全局变量污染、Context 上下文丢失等核心痛点,提供规范化的 PHP 高并发编程实战代码建议。

180

2026.05.19

深入理解Hyperf AOP切面与注解使用
深入理解Hyperf AOP切面与注解使用

详尽介绍 Hyperf 依赖注入容器与 AOP 面向切面编程的使用技巧,包含自定义注解开发流程及注解不生效的排查方案,助力开发者掌握框架核心架构。

444

2026.05.19

Hyperf 数据库操作与连接池优化方案
Hyperf 数据库操作与连接池优化方案

针对 Hyperf Eloquent 模型在大数据量下的表现进行深度优化,讲解连接池断线重连、超时设置及事务处理等生产环境常见技术疑难。

204

2026.05.19

基于 Hyperf 的微服务架构集成实战
基于 Hyperf 的微服务架构集成实战

本专题涵盖 Hyperf 微服务全栈解决方案,包括服务注册与发现、配置中心集成、JsonRPC 调用以及分布式限流熔断的落地实践。

236

2026.05.19

Hyperf 高并发缓存与分布式系统应用
Hyperf 高并发缓存与分布式系统应用

讲解在协程模式下如何高效操作 Redis,实现高性能分布式锁、处理缓存击穿/雪崩问题,并提供基于 Hyperf 的分布式事务处理思路。

408

2026.05.19

Hyperf 项目部署运维与性能调优手册
Hyperf 项目部署运维与性能调优手册

聚焦 Hyperf 在生产环境的落地,包含 Docker 高效打包、Swoole 配置优化、常见的内存溢出(OOM)问题排查方法以及热更新方案。

385

2026.05.19

Hyperf PHP 微服务框架高性能开发实战
Hyperf PHP 微服务框架高性能开发实战

本专题围绕 Hyperf 框架展开,讲解微服务架构设计、协程异步处理、服务注册与发现、RPC 通信及性能优化策略。通过完整项目示例,帮助开发者构建高效、稳定、可扩展的 PHP 分布式服务系统。

176

2026.06.08

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

0

2026.09.30

LLVM RISC-V参数配置教程
LLVM RISC-V参数配置教程

本专题介绍LLVM对RISC-V基础ISA和扩展的支持方式,涵盖RV32、RV64、标准扩展、实验性扩展、厂商扩展、-menable-experimental-extensions和版本差异。

0

2026.09.30

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn