SpringBoot logback日志打印增加trace_uuid追踪接口请求输出日志（包括线程池统一配置）

为方便项目日志查询，可在日志配置文件中加入自定义标识，在日志头添加uuid，以达到为同一次接口请求标识添加唯一标识的目的。

下面介绍一种简单的方式：
1、通过查看slf4j源码注释，org.slf4j包中MDC类为log4j和logback提供了MDC【MDC ( Mapped Diagnostic Contexts )，它是一个线程安全的存放诊断日志的容器。）】功能，MDC类中静态方法put(String key, String val)可将自定义标识key放入MDCAdapter中，最后通过反射机制将key与xml配置中的标识key对应上，将key标识的value添加进日志内容。

2、logback-spring.xml配置文件中添加自定义标识。将[%X{trace_uuid}]加入配置中。

<?xml version="1.0" encoding="UTF-8" ?>
<configuration>
    <!-- 控制台输出日志 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>[%X{trace_uuid}] %d{yyyy-MM-dd HH:mm:ss.SSS} [%level] [%thread] [%c] %L - %msg%n</pattern>
        </encoder>
    </appender>
    <!--每天生成一个日志文件，保存30天的日志文件。-->
    <appender name="DayFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>logs/log.log</File>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>logs/log.%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>[%X{trace_uuid}] %d{yyyy-MM-dd HH:mm:ss.SSS} [%level] [%thread] [%c] %L - %msg%n</pattern>
        </encoder>
    </appender>
    <!--指定logger name为包名或类全名 指定级别 additivity设置是否传递到root logger -->
    <logger name="slf4j" level="INFO" additivity="false">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="DayFile"/>
    </logger>
    <!--slf4j2包下的类在ERROR级别时候传递到root logger中-->
    <logger name="slf4j2" level="ERROR"/>
    <!--根logger控制-->
    <root level="INFO">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="DayFile"/>
    </root>
</configuration>

根据项目实际情况而定，找到项目接口请求入口，可以是拦截器、Controller层的AOP、token验证等位置，添加以下一行代码即可：

MDC.put("trace_uuid", UUID.randomUUID().toString());

原文链接：https://blog.csdn.net/qq_36599564/article/details/99947049

但是具体实现还没有说明。

一、web请求打印uuid

可以使用 拦截器、Controller层的AOP、token验证等方式，我这里使用拦截器的方式实现。

1.定义一个拦截器

import org.slf4j.MDC;
import org.springframework.web.servlet.HandlerInterceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.UUID;

/**
 * 链路Id拦截器
 *
 */
public class TraceIdInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        MDC.put("trace_uuid", UUID.randomUUID().toString());
        return true;
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // Do nothing
    }


}

2.配置拦截器

import cn.quant_cloud.ly.interceptor.TraceIdInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * web配置类
 *
 */
@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new TraceIdInterceptor());
    }
}

二、线程池统一配置打印UUID

我这里实际上配置的是Spring Boot的schdule线程池，转换成其他线程池也一样的。

import org.slf4j.MDC;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;

import javax.validation.constraints.NotNull;
import java.util.UUID;
import java.util.concurrent.RejectedExecutionHandler;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ScheduledThreadPoolExecutor;
import java.util.concurrent.ThreadFactory;

/**
 * 定时任务配置类
 *
 */
@EnableScheduling
@Configuration
public class ScheduleConfig implements SchedulingConfigurer {
    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        // 开启一个线程调度池
        ThreadPoolTaskScheduler taskScheduler = new CustomerThreadPoolTaskScheduler();
        // 设置线程池大小为 1 ：防止多个定时任务并发执行
        taskScheduler.setPoolSize(1);
        taskScheduler.initialize();
        taskRegistrar.setTaskScheduler(taskScheduler);
    }

    public static class CustomerThreadPoolTaskScheduler extends ThreadPoolTaskScheduler {
        @Override
        protected ScheduledExecutorService createExecutor(int poolSize, ThreadFactory threadFactory, RejectedExecutionHandler rejectedExecutionHandler) {
            return new CustomerScheduledExecutorService(poolSize, threadFactory, rejectedExecutionHandler);
        }
    }
    public static class CustomerScheduledExecutorService extends ScheduledThreadPoolExecutor {
        @Override
        protected void beforeExecute(Thread t, Runnable r) {
            // 执行前绑定链路追踪ID到线程上下文
            MDC.put("trace_uuid", UUID.randomUUID().toString());
        }
        @Override
        protected void afterExecute(Runnable r, Throwable t) {
            // 执行后清除链路追踪ID
            MDC.remove("trace_uuid");
        }
        public CustomerScheduledExecutorService(int corePoolSize, @NotNull ThreadFactory threadFactory, @NotNull RejectedExecutionHandler handler) {
            super(corePoolSize, threadFactory, handler);
        }
    }
}