spring cloud脚手架项目(五)日志模块之出入参数和日志链路追踪UUID

前言

之前4篇已经构建完成了一个基本的spring boot项目。换在我之前工作的时候，就是一个标准的SSM的Web项目了，已经可以配合数据库做一个单机Web后端服务器使用了。接下来需要开发的就是日志模块了。
参考博客：
https://www.cnblogs.com/quanxiaoha/p/10789843.html
https://blog.csdn.net/xubin320121/article/details/93857126
https://www.jianshu.com/p/b74ade8bbb57

代码

引入aop jar包

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>

自定义Aop注解
ParamsLog

import java.lang.annotation.*;

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Documented
public @interface ParamsLog {
    String description() default "";
}

TraceLog

import java.lang.annotation.*;

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Documented
public @interface TraceLog {
    String description() default "";
}

ParamsLogAspect

import com.google.gson.Gson;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;



@Aspect
@Component
@Slf4j
@Order(100)
public class ParamsLogAspect {

    /**
     * 以自定义注解为切点
     */
    @Pointcut("@annotation(com.chen.common.logAop.ParamsLog)")
    public void paramsLog() {
    }

    /**
     * 在切点之前织入
     *
     * @param joinPoint
     */
    @Before("paramsLog()")
    public void doBefore(JoinPoint joinPoint) {
        log.info("ClassMethod:{}.{},RequestArgs:{}", joinPoint.getSignature().getDeclaringTypeName(),
                joinPoint.getSignature().getName(),
                new Gson().toJson(joinPoint.getArgs()));
    }


    /**
     * 环绕
     *
     * @param proceedingJoinPoint
     * @return
     * @throws Throwable
     */
    @Around("paramsLog()")
    public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        long startTime = System.currentTimeMillis();
        Object result = proceedingJoinPoint.proceed();
        //最终需要的日志格式
        log.info("ClassMethod:{}.{},ResponseArgs:{},Time-Consuming:{}ms", proceedingJoinPoint.getSignature().getDeclaringTypeName(),
                proceedingJoinPoint.getSignature().getName(),
                new Gson().toJson(result),
                System.currentTimeMillis() - startTime);
        return result;
    }

}

TraceLogAspect

import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.slf4j.MDC;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

import java.util.UUID;


@Aspect
@Component
@Slf4j
@Order(90)
public class TraceLogAspect {

    private static final String TRACE_ID = "TRACE_ID";

    /**
     * 以自定义注解为切点
     */
    @Pointcut("@annotation(com.chen.common.logAop.TraceLog)")
    public void traceLog() {
    }

    /**
     * 在切点之前织入
     */
    @Before("traceLog()")
    public void doBefore() {
        String traceId = UUID.randomUUID().toString();
        MDC.put(TRACE_ID, traceId);
    }

    /**
     * 环绕
     */
    @Around("traceLog()")
    public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        MDC.clear();
        Object result = proceedingJoinPoint.proceed();
        return result;
    }


}

实现效果，直接在需要打印AOP日志的类上添加自定义注解即可打印出对应的日志，还会有UUID的日志链路追踪

[88b5430e-98b8-4e6e-86e0-b1c25175c137] 2020-05-11 20:49:10.295 logback [http-nio-8761-exec-3] INFO  c.chen.common.logAop.ParamsLogAspect - ClassMethod:com.chen.core.service.impl.CommonServiceImpl.test8,RequestArgs:[3]
[88b5430e-98b8-4e6e-86e0-b1c25175c137] 2020-05-11 20:49:10.295 logback [http-nio-8761-exec-3] INFO  c.c.c.p.service.impl.Test1Process - test1 coming
[88b5430e-98b8-4e6e-86e0-b1c25175c137] 2020-05-11 20:49:10.295 logback [http-nio-8761-exec-3] INFO  c.c.c.p.service.impl.Test2Process - test2 coming
[88b5430e-98b8-4e6e-86e0-b1c25175c137] 2020-05-11 20:49:10.299 logback [http-nio-8761-exec-3] INFO  c.chen.common.logAop.ParamsLogAspect - ClassMethod:com.chen.core.service.impl.CommonServiceImpl.test8,ResponseArgs:{"code":"200","msg":"成功","data":"scuuess"},Time-Consuming:12ms

[88b5430e-98b8-4e6e-86e0-b1c25175c137]
就是我添加的日志
ClassMethod:com.chen.core.service.impl.CommonServiceImpl.test8,RequestArgs:[3]
这个是添加的方法入参
ClassMethod:com.chen.core.service.impl.CommonServiceImpl.test8,ResponseArgs:{“code”:“200”,“msg”:“成功”,“data”:“scuuess”},Time-Consuming:12ms
这个是方法的出参和耗时

说明

@interface就是配置一个自定义注解的核心
@Retention是配置注解的编译位置
@Target是配置注解应该添加的位置，方法或者类或者枚举等等
@Order是spring bean的注入优先级。
应为有的时候我们需要同时添加多个自定义注解，通过@Order可以设置注解的先后顺序，例如我这里UUID必须在出入参数之前放入，所以我设置@TraceLog的比@ParamsLog小，这样uuid会先答应出来，也可以试着改变一下order大小，就会发现uuid在方法入参数log显示出来之后才会添加到下一条的log中。

结尾

这样我们的全局AOP出入参数统计和日志追踪id就有了。下一节做的是全局异常捕获处理
github：https://github.com/alex9567/SpringCloudScaffold