Springboot 实现微服务间日志链路追踪Tranceid

1. 增加 logback 记录日志
2. 使用 AOP 统一控制输入输出
3. 使用 MDC 存储 trace id

场景：web应用A、微服务B，用户触发使用web应用A，A调用B，需要链路追踪查看问题

一、web应用A

1、新增切面 LogAspect

package com.ecsemir.order.ecsemirorderdispose.common.aop;

import cn.hutool.core.lang.UUID;
import com.ecsemir.order.ecsemirorderdispose.common.constants.Constants;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.slf4j.MDC;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import javax.servlet.http.HttpServletRequest;


/**
 * 日志aop
 * 记录对外，依赖服务的请求数据
 */
@Component
@Aspect
public class LogAspect {

    @Autowired
    HttpServletRequest request;

    /**
     * 接口调用的日志监控
     */
    @Before(value = "execution(* com.ecsemir.order.ecsemirorderdispose..*Controller.*(..))")
    public void beforeLog() {
        if (request != null && request.getHeader(Constants.HTTP_HEADER_TRACE_ID) != null) {
            MDC.put(Constants.HTTP_HEADER_TRACE_ID, request.getHeader(Constants.HTTP_HEADER_TRACE_ID));
        }else{
            MDC.put(Constants.HTTP_HEADER_TRACE_ID, UUID.randomUUID().toString());
        }
    }
}

2、logback-spring.xml 修改格式

<encoder>
    <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%X{traceId}] %p [%c] [%t] %m%n</pattern>
    <charset>UTF-8</charset>
</encoder>

3、设置请求头 traceId

//设置请求头
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
String traceId = MDC.get(Constants.HTTP_HEADER_TRACE_ID);
if (StringUtils.isNotEmpty(traceId)) {
    headers.set(Constants.HTTP_HEADER_TRACE_ID,traceId);
}

二、微服务B

1、拦截器 UrlInterceptor新增对上游服务请求的解析

/** 提取请求头traceId 统一上游服务在当前MDC的traceId 的一致性*/
String traceId = request.getHeader(Constants.HTTP_HEADER_TRACE_ID);
if (StringUtils.isNotEmpty(traceId)) {
    MDC.put(Constants.HTTP_HEADER_TRACE_ID, traceId);
}

2、新增切面 LogAspect

package com.ecsemir.ecslave.common.aop;
import cn.hutool.core.lang.UUID;
import com.ecsemir.ecslave.common.constants.Constants;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.annotation.*;
import org.slf4j.MDC;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import javax.servlet.http.HttpServletRequest;

/**
 * @Author: zhuxiaofan
 * @Description: Aop切面日志，记录对外，依赖服务的请求数据
 * @Date Create In 15:52 2023-05-14
 */
@Component
@Slf4j
@Aspect
public class LogAspect {

    @Autowired
    HttpServletRequest request;

    /**
     * 接口调用的日志监控
     */
    @Before(value = "execution(public * com.ecsemir.ecslave.remote..*.*(..))")
    public void beforeLog() {
        if (request != null && request.getHeader(Constants.HTTP_HEADER_TRACE_ID) != null) {
            MDC.put(Constants.HTTP_HEADER_TRACE_ID, request.getHeader(Constants.HTTP_HEADER_TRACE_ID));
        }else{
            MDC.put(Constants.HTTP_HEADER_TRACE_ID, UUID.randomUUID().toString());
        }
    }
}

3、logback-spring.xml 修改格式

<encoder>
    <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%X{traceId}] %p [%c] [%t] %m%n</pattern>
    <charset>UTF-8</charset>
</encoder>