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

Java Spring AOP 怎么实现自定义注解的日志记录拦截

轻辰大大_7424

轻辰大大_7424

发布时间:2026-09-04 17:42:17

|

269人浏览过

|

来源于php中文网

原创

Spring AOP可通过自定义注解@LogExecutionTime与@Aspect切面实现方法级日志记录,自动记录执行耗时、结果及异常,无需侵入业务代码,且支持上下文标识、参数脱敏与链路追踪等进阶功能。

java spring aop 怎么实现自定义注解的日志记录拦截

Spring AOP 通过自定义注解 + 切面(@Aspect)可以优雅地实现方法级日志记录,无需在业务代码中硬编码日志逻辑。

1. 定义自定义日志注解

创建一个运行时保留、可作用于方法的注解,用于标记需要记录日志的方法:

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

说明:value() 可选,方便在不同方法中标识日志上下文(如“用户登录耗时”、“订单查询耗时”)。

2. 编写切面类记录日志

使用 @Aspect + @Around 拦截带该注解的方法,记录开始时间、执行结果、异常和耗时:

立即学习“Java免费学习笔记(深入)”;

@Aspect
@Component
@Slf4j
public class LoggingAspect {
<pre class='brush:java;toolbar:false;'>@Around("@annotation(logExecutionTime)")
public Object logExecutionTime(ProceedingJoinPoint joinPoint, LogExecutionTime logExecutionTime) throws Throwable {
    String methodName = joinPoint.getSignature().toShortString();
    String context = StringUtils.hasText(logExecutionTime.value()) 
        ? logExecutionTime.value() : methodName;

    long start = System.currentTimeMillis();
    log.info("【日志】{} 开始执行", context);

    try {
        Object result = joinPoint.proceed();
        long duration = System.currentTimeMillis() - start;
        log.info("【日志】{} 执行成功,耗时 {} ms,返回: {}", context, duration, result);
        return result;
    } catch (Exception e) {
        long duration = System.currentTimeMillis() - start;
        log.error("【日志】{} 执行失败,耗时 {} ms,异常: {}", context, duration, e.getMessage(), e);
        throw e;
    }
}

}

deep-java-review
deep-java-review

Java项目代码review工具。分析Git变更+完整调用链路上下文,推断业务需求,进行多维度评分和分类汇总,生成完整PRD文档。包含细粒度Java代码审查清单(Null安全、异常处理、Streams、并发、equals/hashCode、资源管理、API设计、性能、MyBatis/ORM、事务边界、SQL/DD...

下载

关键点:

  • @Around 必须接收 ProceedingJoinPoint 和注解参数(形参名需与注解类名一致)
  • joinPoint.proceed() 是真正执行目标方法的入口,必须调用
  • 建议对 result 做 toString() 限制(如 JSON.toJSONString(result, SerializerFeature.WriteClassName)),避免日志过大或敏感信息泄露
  • log.error 的第三个参数传入异常对象,才能打印完整堆栈

3. 在方法上使用注解

只需在 Controller、Service 等任意 Bean 方法上添加 @LogExecutionTime 即可生效:

@RestController
public class UserController {
<pre class='brush:java;toolbar:false;'>@LogExecutionTime("获取用户详情")
@GetMapping("/users/{id}")
public User getUser(@PathVariable Long id) {
    return userService.findById(id);
}

}

注意:确保目标类是 Spring 管理的 Bean(加了 @Service/@Controller/@Component 等),且项目已启用 AOP(Spring Boot 默认开启;传统 Spring 需配置 <aop:aspectj-autoproxy/> 或 @EnableAspectJAutoProxy)。

4. 进阶建议(可选)

提升日志实用性与安全性:

  • 用 @Pointcut 抽取公共切入点表达式,便于复用和统一管理
  • 结合 MDC(Mapped Diagnostic Context)注入 traceId,实现链路追踪(配合 Sleuth 或手动传递)
  • 对入参脱敏(如手机号、身份证号字段),避免日志泄露敏感数据
  • 按日志级别分流:info 记耗时,debug 记参数,error 记异常,避免生产环境日志爆炸

热门AI工具

更多
LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

豆包大模型

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

火山引擎

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

WorkBuddy

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

DeepSeek

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

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

立刻MV
立刻MV Hot

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

切问学术

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

相关专题

更多
java
java

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

9497

2023.06.15

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

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

6642

2023.07.05

java自学难吗
java自学难吗

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

5912

2023.07.31

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

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

1044

2023.08.01

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

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

868

2023.08.02

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

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

1236

2023.08.02

java有什么用
java有什么用

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

2489

2023.08.02

java在线网站
java在线网站

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

19831

2023.08.03

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

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

20

2026.09.30

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

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