logback实现链路追踪

引言：链路追踪目的

每一个前端请求下的所有的日志信息都可以基于一个TraceId号，在我们服务器日志中，串联起来，方便查看程序运行和问题排查。

具体技术内容

Aop/Filter && Logback

具体操作

1、引入依赖

<dependency>
	<groupId>org.slf4j</groupId>
	<artifactId>slf4j-api</artifactId>
	<version>${org.slf4j}</version>
</dependency>
<dependency>
	<groupId>ch.qos.logback</groupId>
	<artifactId>logback-classic</artifactId>
	<version>${ch.qos.logback}</version>
</dependency>

2、 生产TraceId放置到MDC变量中

通过随机数生成traceId
我们的目的就是为了生成一个随机的完成线程下的链路ID，这里我们仅仅是举例说明，大家自行采取手段即可。

package com.taikang.trace.support;

import java.util.Base64;
import java.util.UUID;
public abstract class AbstractUUIDShort {

    /**生成唯一ID*/
    public static String generate() {
        UUID uuid = UUID.randomUUID();
        return compressedUUID(uuid);
    }
}

基于过滤器或者Aop实现Mdc赋值
1、通过过滤器实现

import com.baomidou.mybatisplus.core.toolkit.IdWorker;
import org.slf4j.MDC;
import javax.servlet.*;
import java.io.IOException;
 
public class LogFilter implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        // 生成一个链路ID
        String traceId = AbstractUUIDShort.generate();
        // 放置此ID入MDC
        MDC.put("traceId",traceId);
        try {  
            chain.doFilter(request,response);  
        } finally {  
            MDC.clear();//must be,threadLocal  
        }  
    }
}

2、基于Aop实现

    // 配置class的环绕通知,使用在方法aspect()上注册的切入点
    @Around(value = "logPoincut()")
    public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
        // 生成一个链路ID
        String traceId = AbstractUUIDShort.generate();
        // 放置此ID入MDC
        MDC.put("traceId",traceId);
        //实际业务
        Object resultObj = joinPoint.proceed();
        try {  
            chain.doFilter(request,response);  
        } finally {  
            MDC.clear();//must be,threadLocal  
        }  
        return resultObj;
    }

3、配置Logback实现traceId的日志输出

<!-- 控制台输出 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder charset="UTF-8">
            <!-- 输出日志记录格式,并打印 trace-id -->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%trace-id] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

注意事项：MDC赋值之后，在我们的业务执行完毕之后，关键信息打印完毕之后，我们需要调用MDC.clear()方法，保证当我们MDC变量被线程池复用的时候，继续装入新的traceId和线程结束之后被清除掉。

至此：我们已经将一个http请求在后台服务器中打印的所有info级别的日志，使用一个traceId号串联起来，方便问题排查。