快捷導(dǎo)航

SpringBoot實現(xiàn)簡單的日志鏈路追蹤

更新時間：2023年10月10日 11:49:56 作者：Ethan

隨著分布式應(yīng)用的普及,現(xiàn)在的一些應(yīng)用系統(tǒng)不再像以前,所有的文件（前后端程序）都打包在一個包中,本文通過一個簡單的SpringBoot應(yīng)用來總結(jié),我們?nèi)绾螌⑷罩敬?lián)起來,文中有詳細的代碼示例,需要的朋友可以參考下

一. 背景

隨著分布式應(yīng)用的普及，現(xiàn)在的一些應(yīng)用系統(tǒng)不再像以前，所有的文件（前后端程序）都打包在一個包中，現(xiàn)在的很多應(yīng)用都是模塊化開發(fā)，開發(fā)的團隊也是不一樣，服務(wù)與服務(wù)之間的調(diào)用也比較多，在這種情況下，系統(tǒng)的日志就顯得尤其的重要，然而，在多數(shù)情況下，當我們的系統(tǒng)出現(xiàn)了異常，需要查看日志時，就會很抓狂。為了避免這種情況，我們需要把同一次的業(yè)務(wù)調(diào)用鏈上的日志串聯(lián)起來。

本次通過一個簡單的SpringBoot應(yīng)用來總結(jié)，我們?nèi)绾螌⑷罩敬?lián)起來，以下截圖是最終的實現(xiàn)效果

二. 代碼演示

1. 創(chuàng)建一個SpringBoot項目

使用idea創(chuàng)建一個SpringBoot項目的詳細步驟，本文不介紹了，具體的步驟，網(wǎng)上有很多例子可以參考

1.1. 我的SpringBoot項目名稱是：springboot-track，以下是工程pom.xml文件中所需要的必要依賴

<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>

1.2. 在項目的resource目錄下，創(chuàng)建日志框架整合配置文件：logback-spring.xml文件內(nèi)容配置如下：

<?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>
 ? ? ?<!--保留天數(shù)-->
 ? ? ?<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>

1.3. 在項目的resource目錄下的主配置文件(application.yml)中添加日志整合配置信息，添加內(nèi)容如下：

需要注意的是：使用idea創(chuàng)建的SpringBoot項目，application文件的默認后綴是.properties，本人比較喜歡.yml文件，所以將文件后綴名修改了一下

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

1.4. 自定義日志攔截器：LogInterceptor.java

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提供的一個支持動態(tài)打印日志信息的工具
 ? ?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);
  }
}

自定義的攔截器需要實現(xiàn)HandlerInterceptor.java接口，然后重寫preHandle方法；MDC(Mapped Diagnostic Context)診斷上下文映射，@Slf4j提供的動態(tài)打印日志工具。

1.5. 添加攔截器：WebConfigurerAdapter.java

@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");
?
  }
}

經(jīng)過上述的幾個步驟，基本上就可以簡單的將同一次的業(yè)務(wù)調(diào)用鏈上的日志串聯(lián)起來了。

2. 測試驗證

簡單的寫一個測試類：TestController.java

@RestController
@Slf4j
public class TestController {
?
 ?@Resource(name = "userService")
 ?private IUserService userService;
?
 ?@PostMapping("/test")
 ?public String testTrace01(@RequestParam("name") final String name) {
 ? ?log.info("入?yún)?name={}", name);
 ? ?testTrace02();
 ? ?log.info("調(diào)用結(jié)束name={}", name);
 ? ?return "Hello," + name;
  }
}

使用Postman調(diào)用接口：http://localhost:8080/test?name=張三

控制臺的輸出如下：