Java 注解实现日志记录切面怎么写

老明大大_9291

老明大大_9291

2026-08-12

308人浏览

原创

核心是结合spring aop与自定义注解实现日志切面:先定义@target(method)@retention(runtime)的@logexecution注解作标记,再通过@aspect+@around切面拦截,自动记录方法描述、参数、耗时、返回值或异常,业务方法仅需添加注解即可,零侵入、易维护。

java 注解实现日志记录切面怎么写

用 Java 注解实现日志记录切面,核心是结合 Spring AOP 和自定义注解,在方法执行前后自动打印日志,避免在业务代码里硬编码 log 语句。

定义自定义日志注解

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

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface LogExecution {
    String value() default ""; // 可选描述,如 "用户登录"
}

这个注解本身不带逻辑,只是个“标记”,后续由切面识别并处理。

编写日志切面类

使用 @Aspect 声明切面,配合 @Around 或 @Before/@AfterReturning 实现日志行为。推荐用 @Around,便于记录入参、返回值和耗时:

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

    long start = System.currentTimeMillis();
    log.info("【开始】{},参数:{}", desc, Arrays.toString(joinPoint.getArgs()));

    try {
        Object result = joinPoint.proceed();
        long cost = System.currentTimeMillis() - start;
        log.info("【完成】{},耗时:{}ms,返回:{}", desc, cost, result);
        return result;
    } catch (Exception e) {
        long cost = System.currentTimeMillis() - start;
        log.error("【异常】{},耗时:{}ms,异常:{}", desc, cost, e.getMessage(), e);
        throw e;
    }
}

}

js2java
js2java

JavaScript 到 Java 全栈翻译助手,专为前端开发者学习 Java 或快速实现后端业务逻辑而设计。当用户提到以下场景时必须使用此技能: - "帮我把这段 JS 代码转成 Java" - "用 Java 怎么写这个逻辑" - "我习惯用 JS 写,想翻译成 Java" - "教我 Java,我要写后端接...

下载
  • 确保项目已引入 spring-boot-starter-aop 和 Lombok(或手动写 Logger)
  • @Around 拦截所有标注了 @LogExecution 的方法
  • 日志中包含方法描述、参数、耗时、返回值或异常堆栈,信息完整且结构清晰

在业务方法上使用注解

直接加在需要监控的方法上,轻量无侵入:

@Service
public class UserService {
<pre class="brush:java;toolbar:false;">@LogExecution("查询用户详情")
public User getUserById(Long id) {
    return userMapper.selectById(id);
}

@LogExecution
public void updateUser(User user) {
    userMapper.updateById(user);
}

}

不加 value 时默认用方法签名作日志前缀,加了则按描述显示,灵活可控。

可选增强:支持异步与敏感字段脱敏

实际生产中常需避开日志泄露密码、手机号等敏感信息:

  • 对 joinPoint.getArgs() 做白名单过滤或调用脱敏工具(如用正则替换手机号为 138****1234)
  • 若方法是异步(@Async),注意 AOP 默认不生效,需启用 exposeProxy=true 或改用 AspectJ 编译织入
  • 可通过注解属性控制日志级别(如 level = LogLevel.INFO),让切面动态选择 log.info 还是 log.debug

不复杂但容易忽略细节,关键是把注解当开关、把切面当统一日志入口,既干净又易维护。

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

10337

6

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

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

2023.07.05

7462

9

java自学难吗
java自学难吗

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

2023.07.31

6532

8

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

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

2023.08.01

1124

3

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

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

2023.08.02

928

3

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

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

2023.08.02

1356

5

java有什么用
java有什么用

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

2023.08.02

2709

5

java在线网站
java在线网站

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

2023.08.03

20031

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人学习