Java 注解怎么在日志框架中通过注解自动记录方法执行耗时与审计日志

老晨吖_7239

老晨吖_7239

2026-08-28

353人浏览

原创

java注解本身不执行逻辑,需配合aop实现自动日志记录:定义@methodtimer和@auditlog两个职责分离的自定义注解,编写@around切面统一处理耗时统计与审计日志,集成mdc、securitycontext等增强可追溯性,并注意代理限制、异步写入等避坑点。

java 注解怎么在日志框架中通过注解自动记录方法执行耗时与审计日志

Java 注解本身不执行逻辑,但可以配合 AOP(面向切面编程)在方法执行前后自动织入日志记录逻辑。要实现「自动记录方法执行耗时」和「审计日志」,核心是:定义自定义注解 + 编写切面(@Aspect)+ 在切点中提取参数、计算耗时、构造日志内容。

定义耗时与审计两个自定义注解

建议分开定义,职责清晰,也便于单独启用或组合使用:

  • @MethodTimer:仅标记需统计耗时的方法,可选是否输出到日志(如 DEBUG 级别);
  • @AuditLog:标记需审计的方法,支持配置业务操作类型(如 "CREATE_USER")、是否记录参数/返回值、是否脱敏等。

示例(简洁版):

Java Maven Secondary Analysis
Java Maven Secondary Analysis

分析ZIP压缩包或GitLab仓库中的Java Maven项目,确定二次开发范围、类数量、模块分布及生产相关指标。

下载
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MethodTimer {
    String value() default ""; // 日志前缀,如 "UserService#login"
}

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface AuditLog {
    String operation();        // 必填,如 "USER_LOGIN"
    boolean includeArgs() default false;
    boolean includeResult() default false;
    boolean maskArgs() default true; // 敏感参数是否脱敏
}

编写切面统一处理逻辑

使用 Spring AOP(需引入 spring-boot-starter-aop),一个切面类即可覆盖两种注解:

  • 用 @Around 拦截带 @MethodTimer 或 @AuditLog 的方法;
  • 通过 joinPoint.getSignature() 获取方法签名,joinPoint.getArgs() 获取参数;
  • 用 System.nanoTime() 计算精确耗时(毫微秒级,转为毫秒更实用);
  • 结合 SLF4J(如 Logback)记录结构化日志,例如用 log.info("TIMER [{}] cost {}ms", method, costMs) 和 log.info("AUDIT [{}] op={} args={} result={}", ...);
  • 对敏感字段(如 password、idCard)做简单脱敏(如 StringUtils.substring(str, 0, 2) + "***"),或集成 Jackson 的 @JsonIgnore / 自定义序列化器。

增强日志可读性与可追溯性

光记耗时和参数不够,生产环境需要上下文支撑排查:

  • 在日志中加入唯一 traceId(如通过 MDC 集成 Sleuth 或自定义 UUID),让一次请求的所有日志可串联;
  • 审计日志中记录操作人(从 SecurityContext 获取当前 Subject)、客户端 IP(从 RequestContextHolder)、时间戳(ISO 格式);
  • 对异常情况单独记录 ERROR 级别审计日志(如权限拒绝、参数校验失败),并在切面中捕获 throwing;
  • 避免在切面中记录大对象(如整个 Entity 列表),可只记 size、class、关键 ID 字段。

注意事项与避坑点

实际落地时容易忽略的关键细节:

  • 切面默认不代理 private / final / static 方法,注解必须打在 public 实例方法上;
  • 同一类内方法调用(A → B)不会触发切面,因为未经过代理对象 —— 需改为注入自身 Bean 调用,或改用 AspectJ 编译期织入;
  • 避免在切面中执行耗时操作(如远程调用、DB 写入),否则会拖慢主流程;审计日志建议异步(如用 Logback 的 AsyncAppender);
  • 注解属性尽量用字符串字面量,避免运行时反射取常量类,影响启动性能;
  • 测试时记得开启 AOP:确保 @EnableAspectJAutoProxy(Spring Boot 默认已开)且切面类被 Spring 扫描到(加 @Component)。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

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

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

下载

相关标签:

java

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

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

10137

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

7282

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

6392

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1104

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

908

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1336

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2669

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

19991

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1195

8

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习