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