Java 自定义注解中怎么通过拦截器自动记录带有特定注解的方法执行日志

冬婷小哥_2485

冬婷小哥_2485

2026-07-30

653人浏览

原创

在spring中应使用@aspect切面而非handlerinterceptor实现跨层方法日志记录,因后者仅适用于controller层;需定义@logexecution注解并编写切面类,在目标方法上标注该注解即可自动记录执行耗时、参数与结果。

java 自定义注解中怎么通过拦截器自动记录带有特定注解的方法执行日志

在 Spring 项目中,可以通过自定义注解 + 拦截器(或更常用的是 AOP 切面)实现对特定方法的自动日志记录。注意:Spring 的 HandlerInterceptor 主要用于 Web 层(Controller 方法),无法拦截 Service 或普通 Bean 中的方法;若需拦截任意 Spring 管理的 Bean 方法(如 @Service、@Component 内的方法),应使用 @Aspect 切面。

1. 定义自定义日志注解

创建一个运行时保留、可作用于方法的注解:

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface LogExecution {
    String value() default "执行日志";
    boolean includeParams() default true;
    boolean includeResult() default true;
}

2. 编写 AOP 切面处理日志逻辑

使用 @Aspect 拦截标注了 @LogExecution 的方法,记录入参、耗时、返回值或异常:

@Aspect
@Component
@Slf4j
public class LogExecutionAspect {
<pre class="brush:java;toolbar:false;">@Around("@annotation(logExecution)")
public Object logExecutionTime(ProceedingJoinPoint joinPoint, LogExecution logExecution) throws Throwable {
    String methodName = joinPoint.getSignature().toShortString();
    Object[] args = joinPoint.getArgs();

    long start = System.currentTimeMillis();
    String params = logExecution.includeParams() ? Arrays.toString(args) : "[hidden]";
    log.info("▶ {} 开始执行 | 参数: {}", methodName, params);

    try {
        Object result = joinPoint.proceed();
        long duration = System.currentTimeMillis() - start;
        String resultStr = logExecution.includeResult() 
            ? String.valueOf(result) 
            : "[hidden]";
        log.info("✔ {} 执行完成 | 耗时: {}ms | 返回: {}", methodName, duration, resultStr);
        return result;
    } catch (Exception e) {
        long duration = System.currentTimeMillis() - start;
        log.error("✘ {} 执行异常 | 耗时: {}ms | 异常: {}", methodName, duration, e.getMessage(), e);
        throw e;
    }
}

}

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载
  • 确保类被 @Component 管理,并开启 AOP 支持(@EnableAspectJAutoProxy 或 spring-boot-starter-aop 已默认启用)
  • 使用 @Slf4j(Lombok)简化日志;也可用 LoggerFactory.getLogger(...)
  • joinPoint.proceed() 是关键,必须调用才能真正执行原方法

3. 在目标方法上使用注解

只需在需要记录日志的方法上添加 @LogExecution:

@Service
public class UserService {
<pre class="brush:java;toolbar:false;">@LogExecution(includeParams = true, includeResult = false)
public User getUserById(Long id) {
    return new User(id, "Alice");
}

}

  • 支持细粒度控制:是否打印参数、是否打印返回值
  • 注解可重复使用,无需修改业务代码逻辑

4. 补充说明:为什么不用 HandlerInterceptor?

HandlerInterceptor 只能拦截进入 DispatcherServlet 的 HTTP 请求,即 Controller 层方法。它无法感知 Service、DAO 或普通工具方法的调用。若强行在 Controller 中加拦截,会丢失内部方法调用链路,且耦合 Web 层。

  • Controller 方法 → 拦截器 ✅
  • Service 方法 → AOP 切面 ✅(推荐)
  • 非 Spring 管理对象的方法 → AOP 不生效,需改用字节码增强(如 ByteBuddy)或手动埋点

不复杂但容易忽略:确保切面类被 Spring 扫描到(放在主启动类同包或子包),且项目已引入 spring-boot-starter-aop 依赖。

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

相关专题

更多
java
java

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

2023.06.15

10057

6

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

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

2023.07.05

7202

9

java自学难吗
java自学难吗

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

2023.07.31

6332

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

2649

5

java在线网站
java在线网站

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

2023.08.03

19971

3

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

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

2023.08.03

1175

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习