Java 怎么通过注解在控制台打印方法执行日志

酷辰吖_4397

酷辰吖_4397

2026-09-04

601人浏览

原创

Java中可通过自定义@LogExecution注解结合AOP切面实现方法执行日志自动打印:定义运行时注解标记方法,编写@Around切面拦截并记录开始、完成或异常信息及耗时,需确保目标方法为Spring Bean且为public。

java 怎么通过注解在控制台打印方法执行日志

Java 中可以通过自定义注解 + AOP(面向切面编程)实现在控制台打印方法执行日志,无需在每个方法里手动写 System.out.println。核心思路是:定义一个注解(如 @LogExecution),用 AOP 拦截被该注解标记的方法,在其执行前后自动输出日志。

1. 定义日志注解

创建一个运行时保留的自定义注解,用于标记需要记录执行日志的方法:

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

2. 编写 AOP 切面类

使用 Spring AOP(需引入 spring-boot-starter-aop),编写切面,在方法执行前后打印日志:

@Aspect
@Component
public class LoggingAspect {
<pre class="brush:php;toolbar:false;">private static final Logger log = LoggerFactory.getLogger(LoggingAspect.class);

@Around("@annotation(logExecution)")
public Object logExecutionTime(ProceedingJoinPoint joinPoint, LogExecution logExecution) throws Throwable {
    String methodName = joinPoint.getSignature().toShortString();
    String desc = StringUtils.hasText(logExecution.value()) ? 
                  "(" + logExecution.value() + ")" : "";

    log.info("▶ 开始执行: {} {}", methodName, desc);

    long start = System.currentTimeMillis();
    try {
        Object result = joinPoint.proceed();
        long duration = System.currentTimeMillis() - start;
        log.info("✔ 执行完成: {} {},耗时: {}ms", methodName, desc, duration);
        return result;
    } catch (Exception e) {
        long duration = System.currentTimeMillis() - start;
        log.error("✘ 执行异常: {} {},耗时: {}ms,异常: {}", 
                   methodName, desc, duration, e.getMessage());
        throw e;
    }
}

}

说明:

js2java
js2java

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

下载
  • 使用 @Around 可控制方法执行、获取返回值、捕获异常、统计耗时;
  • 推荐用 LoggerFactory(SLF4J)替代 System.out.println,便于后续对接日志框架(如 Logback);
  • 若坚持用控制台打印,可将 log.info(...) 替换为 System.out.println(...),但不建议用于生产环境。

3. 在方法上使用注解

在任意 Spring 管理的 Bean 方法上添加 @LogExecution:

@Service
public class UserService {
<pre class="brush:php;toolbar:false;">@LogExecution("查询用户详情")
public User getUserById(Long id) {
    // 模拟业务逻辑
    try {
        Thread.sleep(100);
    } catch (InterruptedException e) {
        Thread.currentThread().interrupt();
    }
    return new User(id, "张三");
}

}

调用该方法时,控制台会输出类似:

▶ 开始执行: UserService.getUserById(Long) (查询用户详情)
✔ 执行完成: UserService.getUserById(Long) (查询用户详情),耗时: 102ms

4. 注意事项

  • 确保目标类是 Spring Bean(加 @Service/@Component 等),否则 AOP 不生效;
  • AOP 默认只对 public 方法生效(CGLIB/JDK 动态代理限制);
  • 若项目未启用 AOP,需确认已添加依赖并开启支持(Spring Boot 默认开启,传统 Spring 需配置 <aspectj-autoproxy></aspectj-autoproxy>);
  • 如需更细粒度控制(如仅记录入参/出参),可在 joinPoint 中获取 args 或 result 并格式化输出。

不复杂但容易忽略:注解本身不会起作用,必须配合 AOP 切面和 Spring 容器管理才能触发日志打印。

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

相关文章

全能打印神器
全能打印神器

全能打印神器是一款非常好用的打印软件,可以在电脑、手机、平板电脑等设备上使用。支持无线打印和云打印,操作非常简单,使用起来也非常方便,有需要的小伙伴快来保存下载体验吧!

下载

相关标签:

java

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

相关专题

更多
java
java

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

2023.06.15

10397

6

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

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

2023.07.05

7522

9

java自学难吗
java自学难吗

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

2023.07.31

6592

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

2729

5

java在线网站
java在线网站

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

2023.08.03

20051

3

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

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

2023.08.03

1215

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习