AOP统一记录Java业务操作日志的核心是通过自定义注解标记方法、环绕通知捕获上下文、组装脱敏日志并异步落库,实现零侵入、无重复代码。

用 AOP 统一记录 Java 业务操作日志,核心是把日志逻辑从每个 Controller 或 Service 方法里抽出来,通过切面自动拦截、采集、封装和落库。不写重复代码,也不侵入业务,关键就三步:定义注解标记目标方法、编写切面捕获上下文、组装日志对象并保存。
自定义操作日志注解
注解是控制日志开关和携带元信息的入口,推荐按模块+操作粒度设计:
- 用 @Target(ElementType.METHOD) 限定只能加在方法上,避免误标类或字段
- 包含 module(如“用户管理”)、operation(如“创建账号”)、needSave(是否入库,默认 true)等字段
- 加上 @Retention(RetentionPolicy.RUNTIME) 和 @Documented,确保运行时可反射读取
编写环绕通知切面
环绕通知(@Around)最实用,能拿到方法执行前的参数、执行后的返回值、耗时和异常,适合完整日志链路:
- 切点表达式用 @annotation(你的注解全类名),精准匹配带注解的方法
- 通过 JoinPoint.getArgs() 获取原始参数,对 Map/DTO 等复杂类型用 JSON.toJSONString() 格式化
- 调用 joinPoint.proceed() 执行原方法,用 try-catch 包裹,捕获异常并记录失败状态
- 从 RequestContextHolder 拿到当前请求,提取 IP、URL、HTTP 方法、登录用户(如从 Token 或 SecurityContext 中取)
组装并持久化日志数据
日志实体类要覆盖审计刚需字段,建议至少包括:
当用户要求为 Java 代码添加注释、修改注释、审查注释、整理注释格式,或要求按照代码注释规范处理 Java 文件时,使用本技能。本技能用于统一生成和维护 Java 类注释模板、按 Git 对比 release 判断版本号、补充每行代码上方中文块注释、调整注释空行规则,并保持 Java 文件 UTF-8 无 BOM 编码。典型触发场景包括:补充类注释、更新 @version、检查 @author 来源、整理行尾注释、把注释放到代码上一行、检查注释是否符合规范、构建前检查 Java 注释风格。
- 操作人 ID / 姓名:从认证上下文获取,不能为空
- 模块 + 操作描述:来自注解,语义清晰,比如 “订单管理-取消订单”
- 请求 URL + HTTP 方法 + 客户端 IP:辅助定位调用来源
- 请求参数(脱敏后) + 返回结果(截断防过大):敏感字段如手机号、身份证号需正则替换
- 执行耗时(毫秒) + 状态(SUCCESS/FAIL) + 异常堆栈(仅 FAIL 时记录)
- 入库建议异步处理(如用线程池 or Spring 的 @Async),避免阻塞主流程
使用时只需两行代码
在需要记录日志的业务方法上加注解即可,例如:
@OperateLog(module = "商品管理", operation = "上架商品")
public Result
无需改任何业务逻辑,也不用手动 new Log()、setXXX()、save() —— 日志自动产生、自动落库、自动归档。
Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南










