快捷導(dǎo)航

SpringBoot+Logback實(shí)現(xiàn)一個(gè)簡單的鏈路追蹤功能

更新時(shí)間：2019年10月31日 13:37:39 作者：java_lover

Spring Boot默認(rèn)使用LogBack日志系統(tǒng)，并且已經(jīng)引入了相關(guān)的jar包，所以我們無需任何配置便可以使用LogBack打印日志。這篇文章主要介紹了SpringBoot+Logback實(shí)現(xiàn)一個(gè)簡單的鏈路追蹤功能,需要的朋友可以參考下

最近線上排查問題時(shí)候，發(fā)現(xiàn)請求太多導(dǎo)致日志錯(cuò)綜復(fù)雜，沒辦法把用戶在一次或多次請求的日志關(guān)聯(lián)在一起，所以就利用SpringBoot+Logback手寫了一個(gè)簡單的鏈路追蹤，下面詳細(xì)介紹下。

一、實(shí)現(xiàn)原理

Spring Boot默認(rèn)使用LogBack日志系統(tǒng)，并且已經(jīng)引入了相關(guān)的jar包，所以我們無需任何配置便可以使用LogBack打印日志。

MDC（Mapped Diagnostic Context，映射調(diào)試上下文）是log4j和logback提供的一種方便在多線程條件下記錄日志的功能。

實(shí)現(xiàn)思路是在一個(gè)請求開始時(shí)，將請求相關(guān)的上下文信息（例如客戶ID、客戶的IP地址、sessionId、請求參數(shù)等）添加到MDC，然后配置好logback-spring.xml，則Logback組件將會(huì)在每條日志中打印出存放到MDC的信息，從而實(shí)現(xiàn)一個(gè)ID貫穿用戶的所有操作。

二、代碼實(shí)戰(zhàn)

新建一個(gè)spring boot項(xiàng)目spring-boot-log，按照下面步驟操作。

新建日志攔截器

日志攔截器在請求開始獲取用戶的sessionId，當(dāng)然也可以生成一個(gè)UUID，生成后存放到MDC中。

SessionInterceptor代碼如下：

/**
 * 日志攔截器
 * @Author: Java碎碎念
 *
 */
public class SessionInterceptor extends HandlerInterceptorAdapter {
  /**
   * 會(huì)話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代碼如下：

@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到控制臺(tái)和文件，完整配置如下：

<?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("用戶創(chuàng)建了訂單！");
    log.info("請求完成，返回ok！");
    return "ok";
  }
  /**
   * 測試購買
   */
  @RequestMapping(value = "/testPay")
  public String testPay() {
    log.info("用戶付款！");
    return "ok";
  }
}

三、測試

打開瀏覽器連續(xù)訪問接口testLogin、testNewOrder和testPay，模擬用戶登錄、下單、付款操作，控制臺(tái)和文件中打印的日志中已經(jīng)包含了sessonId信息，打印的結(jié)果如下：

[http-nio-8888-exec-1] [CB8E7DB250A31F2BE6C05B30633B9A95] INFO com.example.springbootlog.controller.TestLogController - 用戶登錄成功！
[http-nio-8888-exec-2] [CB8E7DB250A31F2BE6C05B30633B9A95] INFO com.example.springbootlog.controller.TestLogController - 用戶創(chuàng)建了訂單！
[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手寫一個(gè)簡單的鏈路追蹤功能已經(jīng)全部實(shí)現(xiàn)，有問題歡迎留言溝通哦！

完整源碼地址： https://github.com/suisui2019/springboot-study

總結(jié)

以上所述是小編給大家介紹的SpringBoot+Logback實(shí)現(xiàn)一個(gè)簡單的鏈路追蹤功能,希望對(duì)大家有所幫助，如果大家有任何疑問請給我留言，小編會(huì)及時(shí)回復(fù)大家的。在此也非常感謝大家對(duì)腳本之家網(wǎng)站的支持！
如果你覺得本文對(duì)你有幫助，歡迎轉(zhuǎn)載，煩請注明出處，謝謝！

您可能感興趣的文章: