springboot中使用AOP进行日志打印

最新推荐文章于 2025-06-20 13:50:40 发布

原创最新推荐文章于 2025-06-20 13:50:40 发布 · 338 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#springboot

java 专栏收录该内容

1 篇文章

订阅专栏

本文介绍如何在Spring Boot项目中使用AOP实现方法级别的日志记录。通过自定义注解和切面，在不修改业务代码的情况下记录方法的执行时间和参数。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

添加依赖

<dependency>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-aop</artifactId>

</dependency>

定义日志注解

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MethodLog {
}

定义日志切面

@Aspect
@Component
public class MethodLogAspect {

    @Pointcut("@annotation(com.example.demo.common.log.MethodLog)")
    public void log() {
    }

    /**
     * 加入注解自动记录方法日志
     *
     * @param joinPoint
     * @return
     * @throws Throwable
     */
    @Around(value = "log()")
    public Object logAround(ProceedingJoinPoint joinPoint) throws Throwable {
        // 获取执行方法的类的名称（包名加类名）
        String className = joinPoint.getTarget().getClass().getName();
        // 获取实例和方法
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        Logger log = LoggerFactory.getLogger(className);
        Object[] args = joinPoint.getArgs();
        // 记录日志
        log.info(className + "#" + method.getName() + " start..., params:{}", JSON.toJSONString(args));
        long startTime = System.currentTimeMillis();
        // 执行方法获取返回值
        Object proceed = joinPoint.proceed();
        long end = System.currentTimeMillis();
        // 记录日志
        log.info(className + "#" + method.getName() + " end, execute time: [{}],  return: {}", end - startTime, JSON.toJSONString(proceed));
        // 返回
        return proceed;
    }

}

使用

    @MethodLog
    @RequestMapping(method = RequestMethod.POST)
    public ReturnResult<String> login(@RequestBody User validUser) throws BizException {

结果