SpringBoot+Logback實現一個簡單的鏈路追蹤功能
最近線上排查問題時候，發現請求太多導致日誌錯綜複雜，沒辦法把使用者在一次或多次請求的日誌關聯在一起，所以就利用SpringBoot+Logback手寫了一個簡單的鏈路追蹤，下面詳細介紹下。
一、實現原理
Spring Boot預設使用LogBack日誌系統，並且已經引入了相關的jar包，所以我們無需任何配置便可以使用LogBack列印日誌。
MDC（Mapped Diagnostic Context，對映除錯上下文）是log4j和logback提供的一種方便在多執行緒條件下記錄日誌的功能。
實現思路是在一個請求開始時，將請求相關的上下文資訊（例如客戶ID、客戶的IP地址、sessionId、請求引數等）新增到MDC，然後配置好logback-spring.xml，則Logback元件將會在每條日誌中打印出存放到MDC的資訊，從而實現一個ID貫穿使用者的所有操作。
二、程式碼實戰
新建一個spring boot專案spring-boot-log，按照下面步驟操作。
新建日誌攔截器
日誌攔截器在請求開始獲取使用者的sessionId，當然也可以生成一個UUID，生成後存放到MDC中。
SessionInterceptor程式碼如下：
/**
* 日誌攔截器
* @Author: Java碎碎念
*
*/
public class SessionInterceptor extends HandlerInterceptorAdapter {
/**
* 會話ID
*/
private final static String SESSION_KEY = "sessionId";
@Override
public void postHandle(HttpServletRequest arg0,HttpServletResponse arg1,Object arg2,ModelAndView arg3) throws Exception {
}
@Override
public boolean preHandle(HttpServletRequest request,HttpServletResponse response,Object handler) throws Exception {
// String token = UUID.randomUUID().toString().replaceAll("-","");
//本例測試使用sessionId，也可以使用UUID等
String token = request.getSession().getId();
MDC.put(SESSION_KEY,token);
return true;
}
@Override
public void afterCompletion(HttpServletRequest arg0,Exception arg3)
throws Exception {
// 刪除
MDC.remove(SESSION_KEY);
}
}新建配置類
新建InterceptorConfig，註冊剛才的日誌攔截器。
InterceptorConfig程式碼如下：
@Configuration
public class InterceptorConfig implements WebMvcConfigurer {
@Bean
public SessionInterceptor getSessionInterceptor() {
return new SessionInterceptor();
}
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(getSessionInterceptor()).addPathPatterns("/*");
}
}修改logback-spring.xml
配置logback-spring.xml，獲取日誌攔截器新增的sessionId並列印到日誌中，配置檔案中獲取方式如下：
%X{sessionId}
本例中列印sessionId到控制檯和檔案，完整配置如下：
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<property name="log.base" value="./log/logback"/>
<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern> %date [%thread] [%X{sessionId}] %-5level %logger{80} - %msg%n
</pattern>
</encoder>
</appender>
<appender name="logfile"
class="ch.qos.logback.core.rolling.RollingFileAppender">
<File>${log.base}.log</File>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<FileNamePattern>${log.base}.%d{yyyy -MM-dd}.log.zip</FileNamePattern>
</rollingPolicy>
<encoder>
<pattern> %date [%thread] [%X{sessionId}] %-5level %logger{80} - %msg%n
</pattern>
</encoder>
</appender>
<logger name="com.sample" level="TRACE"/>
<root>
<level value="INFO"/>
<appender-ref ref="stdout"/>
<appender-ref ref="logfile"/>
</root>
</configuration>
新增controller
新建TestLogController，列印日誌。
程式碼如下：
@RestController
public class TestLogController {
Logger log = LoggerFactory.getLogger(getClass());
/**
* 測試登入
*/
@RequestMapping(value = "/testLogin")
public String testLogin() {
log.info("使用者登入成功！");
return "ok";
}
/**
* 測試下單
*/
@RequestMapping(value = "/testNewOrder")
public String testNewOrder() {
log.info("使用者建立了訂單！");
log.info("請求完成，返回ok！");
return "ok";
}
/**
* 測試購買
*/
@RequestMapping(value = "/testPay")
public String testPay() {
log.info("使用者付款！");
return "ok";
}
}
三、測試
開啟瀏覽器連續訪問介面testLogin、testNewOrder和testPay，模擬使用者登入、下單、付款操作，控制檯和檔案中列印的日誌中已經包含了sessonId資訊，列印的結果如下：
[http-nio-8888-exec-1] [CB8E7DB250A31F2BE6C05B30633B9A95] INFO com.example.springbootlog.controller.TestLogController - 使用者登入成功！
[http-nio-8888-exec-2] [CB8E7DB250A31F2BE6C05B30633B9A95] INFO com.example.springbootlog.controller.TestLogController - 使用者建立了訂單！
[http-nio-8888-exec-2] [CB8E7DB250A31F2BE6C05B30633B9A95] INFO com.example.springbootlog.controller.TestLogController - 請求完成，返回ok！
[http-nio-8888-exec-3] [CB8E7DB250A31F2BE6C05B30633B9A95] INFO com.example.springbootlog.controller.TestLogController - 使用者付款！
到此SpringBoot+Logback手寫一個簡單的鏈路追蹤功能已經全部實現，有問題歡迎留言溝通哦！
完整原始碼地址： https://github.com/suisui2019/springboot-study
總結
以上所述是小編給大家介紹的SpringBoot+Logback實現一個簡單的鏈路追蹤功能,希望對大家有所幫助，如果大家有任何疑問請給我留言，小編會及時回覆大家的。在此也非常感謝大家對我們網站的支援！
如果你覺得本文對你有幫助，歡迎轉載，煩請註明出處，謝謝！