SpringBoot实现简单的日志链路追踪

<dependencies>
 ?<dependency>
 ? ?<groupId>org.springframework.boot</groupId>
 ? ?<artifactId>spring-boot-starter-web</artifactId>
 ?</dependency>
 ?<dependency>
 ? ?<groupId>org.springframework.boot</groupId>
 ? ?<artifactId>spring-boot-starter-logging</artifactId>
 ?</dependency>
?
 ?<dependency>
 ? ?<groupId>org.projectlombok</groupId>
 ? ?<artifactId>lombok</artifactId>
 ? ?<optional>true</optional>
 ?</dependency>
 ?<dependency>
 ? ?<groupId>org.springframework.boot</groupId>
 ? ?<artifactId>spring-boot-starter-test</artifactId>
 ? ?<scope>test</scope>
 ?</dependency>
</dependencies>

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
 ?<!--日志存储路径-->
 ?<property name="log" value="/Users/username/Downloads"/>
 ?<!-- 控制台输出 -->
 ?<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
 ? ?<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
 ? ? ?<!--输出格式化-->
 ? ? ?<pattern>[%X{TRACE_ID}] %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
 ? ?</encoder>
 ?</appender>
 ?<!-- 按天生成日志文件 -->
 ?<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
 ? ?<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
 ? ? ?<!--日志文件名-->
 ? ? ?<FileNamePattern>${log}/%d{yyyy-MM-dd}.log</FileNamePattern>
 ? ? ?<!--保留天数-->
 ? ? ?<MaxHistory>30</MaxHistory>
 ? ?</rollingPolicy>
 ? ?<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
 ? ? ?<pattern>[%X{TRACE_ID}] %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
 ? ?</encoder>
 ? ?<!--日志文件最大的大小-->
 ? ?<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
 ? ? ?<MaxFileSize>10MB</MaxFileSize>
 ? ?</triggeringPolicy>
 ?</appender>
?
 ?<!-- 日志输出级别 -->
 ?<root level="INFO">
 ? ?<appender-ref ref="console"/>
 ? ?<appender-ref ref="file"/>
 ?</root>
</configuration>

server:
  port: 8080
logging:
  config: classpath:logback-springboot.xml
  pattern:
 ?  dateformat: MM-dd HH:mm:ss

public class LogInterceptor implements HandlerInterceptor {
?
 ?private static final String TRACE_ID = "TRACE_ID";
?
 ?@Override
 ?public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
 ? ?// 使用UUID自动生成链路ID
 ? ?String tid = UUID.randomUUID().toString().replace("-", "");
 ? ?// 客户端可以传入链路ID，需要唯一性
 ? ?String traceId = request.getHeader(TRACE_ID);
 ? ?if (!StringUtils.isEmpty(traceId)) {
 ? ? ?tid = request.getHeader(TRACE_ID);
 ?  }
 ? ?// MDC(Mapped Diagnostic Context)诊断上下文映射，是@Slf4j提供的一个支持动态打印日志信息的工具
 ? ?MDC.put(TRACE_ID, tid);
 ? ?return true;
  }
?
 ?@Override
 ?public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
 ? ?MDC.remove(TRACE_ID);
  }
}

@Configuration
public class WebConfigurerAdapter implements WebMvcConfigurer {
?
 ?@Bean
 ?public LogInterceptor logInterceptor() {
 ? ?return new LogInterceptor();
  }
?
 ?@Override
 ?public void addInterceptors(InterceptorRegistry registry) {
 ? ?registry.addInterceptor(logInterceptor())
 ? ? ?// 自定义需要拦截的和不需要拦截的
 ? ?  .addPathPatterns("/**")
 ? ?  .excludePathPatterns("/test***.html");
?
  }
}

@RestController
@Slf4j
public class TestController {
?
 ?@Resource(name = "userService")
 ?private IUserService userService;
?
 ?@PostMapping("/test")
 ?public String testTrace01(@RequestParam("name") final String name) {
 ? ?log.info("入参 name={}", name);
 ? ?testTrace02();
 ? ?log.info("调用结束name={}", name);
 ? ?return "Hello," + name;
  }
}