如何使用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,                HttpServletResponse arg1, Object arg2, Exception arg3)      throws Exception {    // 刪除    MDC.remove(SESSION_KEY);  }}

新建配置類

新建InterceptorConfig，注冊剛才的日志攔截器。

InterceptorConfig代碼如下：

@Configurationpublic 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，打印日志。

代碼如下：

@RestControllerpublic 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實現鏈路追蹤功能”這篇文章的所有內容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內容對大家有所幫助，如果還想學習更多知識，歡迎關注億速云行業資訊頻道！