利用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，按照下面步驟操作。

1. 新建日志攔截器

日志攔截器在請求開始獲取用戶的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);
    }
}

2. 新建配置類

新建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("/*");
    }
}

3. 修改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>

4. 添加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

推薦閱讀

1.SpringBoot中如何優雅的讀取yml配置文件？
2.SpringBoot中如何靈活的實現接口數據的加解密功能？
3.SpringBoot中神奇的@Enable*注解？
4.Java中Integer.parseInt和Integer.valueOf，你還傻傻分不清嗎？
5.SpringCloud系列-整合Hystrix的兩種方式

---

限時領取免費Java相關資料，涵蓋了Java、Redis、MongoDB、MySQL、Zookeeper、Spring Cloud、Dubbo/Kafka、Hadoop、Hbase、Flink等高並發分布式、大數據、機器學習等技術。
關注下方公眾號即可免費領取：