SpringBoot+MDC實現鏈路呼叫紀錄檔的方法

2022-12-21 14:01:21

1.首先介紹什麼是MDC

MDC（Mapped Diagnostic Context，對映偵錯上下文）是 log4j 、logback及log4j2 提供的一種方便在多執行緒條件下記錄紀錄檔的功能。MDC 可以看成是一個與當前執行緒繫結的雜湊表，可以往其中新增鍵值對。MDC 中包含的內容可以被同一執行緒中執行的程式碼所存取。當前執行緒的子執行緒會繼承其父執行緒中的 MDC 的內容。當需要記錄紀錄檔時，只需要從 MDC 中獲取所需的資訊即可。MDC 的內容則由程式在適當的時候儲存進去。對於一個 Web 應用來說，通常是在請求被處理的最開始儲存這些資料

1.1MDC作用

MDC 全稱是 Mapped Diagnostic Context，可以粗略的理解成是一個執行緒安全的存放診斷紀錄檔的容器。
一般是結合log4j一起使用，為我們的紀錄檔根據執行緒鏈路加一個表示traceId,在微服務盛行的當下，鏈路跟蹤是個難題，而藉助 MDC 去埋點，巧妙實現鏈路跟蹤應該不是問題

2.MDC結合logback的使用demo

1.logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
    <!--紀錄檔儲存路徑-->
    <property name="log" value="D://Xiangmu//TrackMeta//src//main//resources//log" />
    <!-- 控制檯輸出 -->
    <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>
            <!--保留天數-->
            <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>

2.所需依賴

<dependencies>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.7</version>
    </dependency>
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-core</artifactId>
        <version>1.2.3</version>
    </dependency>
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-access</artifactId>
        <version>1.2.3</version>
    </dependency>
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
        <version>1.2.3</version>
    </dependency>
</dependencies>

3.yml
這裡需要注意Swagger2和SpringBoot2的依賴問題有版本衝突，需要指定匹配策略

server:
  port: 8826
logging:
  config: classpath:logback-spring.xml
spring:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher  # 解決SpringBoot 和Swagger2版本衝突

4.自定義的紀錄檔攔截器
根據使用者請求進行前置攔截，判斷使用者的請求頭中是否含有TRACE_ID，如果有的話進行（當然不可能有），沒有的話我們進行設定並且賦值（用UUID生成一個唯一序列放到TRACE_ID中），然後放到MDC中

後置處理器中，我們從MDC移除TRACE_ID

package com.wyh.trackmeta.interceptor;

import org.slf4j.MDC;
import org.springframework.util.StringUtils;
import org.springframework.web.servlet.HandlerInterceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.UUID;

//自定義紀錄檔攔截器：每一次鏈路，執行緒維度，新增最終的鏈路ID ：Trace_ID
public class LogInterceptor implements HandlerInterceptor {

    private static final String TRACE_ID = "TRACE_ID";

    /**
     * 1.前置攔截器
     * @param request
     * @param response
     * @param handler
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        String tid = UUID.randomUUID().toString().replace("-", "");
        //1.這裡我們是讓使用者端傳入鏈路ID，然後進行前置攔截捕獲
        if(!StringUtils.isEmpty(request.getHeader("TRACE_ID"))){
            tid=request.getHeader("TRACE_ID");
        }
        //2.利用MDC將請求的上下文資訊儲存到當前執行緒的上下文對映中
        MDC.put(TRACE_ID,tid);
        return true;
    }


    /**
     * 2.後置處理器
     * @param request
     * @param response
     * @param handler
     * @param ex
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        MDC.remove(TRACE_ID);
    }
}

註冊攔截器

package com.wyh.trackmeta.interceptor;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebConfigurerAdapter implements WebMvcConfigurer {

    //1.註冊紀錄檔攔截器
    @Bean
    public LogInterceptor logInterceptor() {
        return new LogInterceptor();
    }

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(logInterceptor());
    }
}

4.多執行緒下MDC工具類

1.定義方法，將父執行緒向執行緒池提交任務的時候，將自身MDC中的資料複製給子執行緒——>存放上下文判斷是否為null，不為空就將資料context放到MDC中，然後設定TraceID——>然後執行任務

總的來說就是對任務進行了一次封裝

package com.wyh.trackmeta.config;

import org.slf4j.MDC;

import java.util.Map;
import java.util.UUID;
import java.util.concurrent.Callable;
 
/**
 * @Author: JCccc
 * @Date: 2022-5-30 11:14
 * @Description:
 */
public final class ThreadMdcUtil {
    private static final String TRACE_ID = "TRACE_ID";
 
    // 獲取唯一性標識
    public static String generateTraceId() {
        return UUID.randomUUID().toString();
    }
 
    public static void setTraceIdIfAbsent() {
        if (MDC.get(TRACE_ID) == null) {
            MDC.put(TRACE_ID, generateTraceId());
        }
    }
 
    /**
     * 用於父執行緒向執行緒池中提交任務時，將自身MDC中的資料複製給子執行緒
     *
     * @param callable
     * @param context
     * @param <T>
     * @return
     */
    public static <T> Callable<T> wrap(final Callable<T> callable, final Map<String, String> context) {
        return new Callable<T>() {
            @Override
            public T call() throws Exception {
                if (context == null) {
                    MDC.clear();
                } else {
                    MDC.setContextMap(context);
                }
                setTraceIdIfAbsent();
                try {
                    return callable.call();
                } finally {
                    MDC.clear();
                }
            }
        };
    }
 
    /**
     * 用於父執行緒向執行緒池中提交任務時，將自身MDC中的資料複製給子執行緒
     *
     * @param runnable
     * @param context
     * @return
     */
    public static Runnable wrap(final Runnable runnable, final Map<String, String> context) {
        return () -> {
            if (context == null) {
                MDC.clear();
            } else {
                MDC.setContextMap(context);
            }
            setTraceIdIfAbsent();
            try {
                runnable.run();
            } finally {
                MDC.clear();
            }
        };
    }
}

5.自定義執行緒池

**為什麼要自定義執行緒池呢？**因為子執行緒在列印紀錄檔的過程會造成traceId丟失，解決方式就是重寫執行緒池

package com.wyh.trackmeta.config;

import org.slf4j.MDC;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;

import java.util.concurrent.Callable;
import java.util.concurrent.Future;
 
/**
 * @Author: Fairy
 * @Description:
 */
public class MyThreadPoolTaskExecutor  extends ThreadPoolTaskExecutor  {
    public MyThreadPoolTaskExecutor() {
        super();
    }
    
    @Override
    public void execute(Runnable task) {
        super.execute(ThreadMdcUtil.wrap(task, MDC.getCopyOfContextMap()));
    }

 
    @Override
    public <T> Future<T> submit(Callable<T> task) {
        return super.submit(ThreadMdcUtil.wrap(task, MDC.getCopyOfContextMap()));
    }
 
    @Override
    public Future<?> submit(Runnable task) {
        return super.submit(ThreadMdcUtil.wrap(task, MDC.getCopyOfContextMap()));
    }
}

6.執行緒池設定類

package com.wyh.trackmeta.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.EnableAsync;

import java.util.concurrent.Executor;

@Configuration
@EnableAsync
public class ThreadPoolConfig {
    public static void main(String[] args) {
        Thread thread = new Thread();
    }

    /**
     * 宣告一個執行緒池
     * @return
     */
    @Bean("MyExecutor")
    public Executor asyncExecutor() {
        MyThreadPoolTaskExecutor executor = new MyThreadPoolTaskExecutor();
        //核心執行緒數5：執行緒池建立時候初始化的執行緒數
        executor.setCorePoolSize(5);
        //最大執行緒數5：執行緒池最大的執行緒數，只有在緩衝佇列滿了之後才會申請超過核心執行緒數的執行緒
        executor.setMaxPoolSize(10);
        //緩衝佇列500：用來緩衝執行任務的佇列
        executor.setQueueCapacity(500);
        //允許執行緒的空閒時間60秒：當超過了核心執行緒出之外的執行緒在空閒時間到達之後會被銷燬
        executor.setKeepAliveSeconds(60);
        //執行緒池名的字首：設定好了之後可以方便我們定位處理任務所在的執行緒池
        executor.setThreadNamePrefix("asyncJCccc");
        executor.initialize();
        return executor;
    }
}

7.測試介面

package com.wyh.trackmeta.controller;

import com.wyh.trackmeta.service.UserServiceImpl;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@Api(tags = "鏈路紀錄檔測試")
@RestController
@Slf4j
public class TestController {

    @Autowired
    private UserServiceImpl userService;

    @SneakyThrows
    @ApiOperation("紀錄檔測試Test介面")
    @RequestMapping("doTest")
    public String doTest(@RequestParam("name")String name){
       log.info("入參 name={}",name);
       testTrace();
       userService.insertUser();
       log.info("呼叫結束 name={}",name);
       return "Hello,"+name;
    }

    /**
     * 2.紀錄檔方法
     */
    private void testTrace(){
        log.info("這是一行info紀錄檔");
        log.info("這是一行error紀錄檔");
        testTrace2();
    }

    private void testTrace2() {
        log.info("這也是一行紀錄檔");
    }

}

8.非同步的業務類

在執行的任務方法上標註註解@Async（“執行緒池”）

package com.wyh.trackmeta.service;

import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import org.springframework.scheduling.annotation.Async;
import org.springframework.stereotype.Service;

import static java.lang.Thread.sleep;

@Slf4j
@Service
public class UserServiceImpl {
    @SneakyThrows
    @Async("MyExecutor")
    public void insertUser() throws InterruptedException {
        sleep(2000);
        log.info("正在插入資料...");
    }

}

到此這篇關於SpringBoot+MDC實現鏈路呼叫紀錄檔的文章就介紹到這了,更多相關SpringBoot MDC鏈路呼叫紀錄檔內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！