快捷導(dǎo)航

SpringBoot項目使用MDC給日志增加唯一標識的實現(xiàn)步驟

更新時間：2025年03月22日 13:59:08 作者：TOP灬小朋友

本文介紹了如何在SpringBoot項目中使用MDC（Mapped?Diagnostic?Context）為日志增加唯一標識,以便于日志追蹤,通過創(chuàng)建日志攔截器、配置攔截器以及修改日志配置文件,可以實現(xiàn)這一功能,文章還提供了源碼地址,方便讀者學習和參考,感興趣的朋友一起看看吧

【JAVA】SpringBoot項目使用MDC給日志增加唯一標識,方便日志追蹤

1.日志效果

2.實現(xiàn)步驟

2.1.創(chuàng)建日志攔截器 LoggingInterceptor

@Component
public class LoggingInterceptor implements HandlerInterceptor {
    private static final String LOG_ID = "logId";
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        String simpleUUID = IdUtil.simpleUUID();
        String logId =String.format("[logId:%s]", simpleUUID);
        MDC.put(LOG_ID, logId);
        return true;
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        MDC.remove(LOG_ID);
    }
}

2.2.配置攔截器

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Resource
    private LoggingInterceptor loggingInterceptor;
    /**
     * 注冊攔截器
     *
     * @param registry 入?yún)?
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 注冊日志攔截器
        registry.addInterceptor(loggingInterceptor).addPathPatterns("/**");
    }
}

2.3.修改日志配置文件

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 讀取application.yml中的日志配置 -->
    <springProperty scope="context" name="LOG_PATH" source="logging.file.path"/>
    <springProperty scope="context" name="LOG_NAME" source="logging.file.log-name"/>
    <springProperty scope="context" name="MAX_HISTORY" source="logging.file.days"/>
    <!-- 定義控制臺輸出格式 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %X{logId} %-5level %logger{50} - %msg%n</pattern>
        </encoder>
    </appender>
    <!-- 定義每天生成一個日志文件，并歸檔生成壓縮包 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>./${LOG_NAME}.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 每天生成一個日志文件 -->
            <fileNamePattern>${LOG_PATH}/%d{yyyy-MM-dd}.log</fileNamePattern>
            <!-- 最多保留指定天數(shù)的日志文件 -->
            <maxHistory>${MAX_HISTORY}</maxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %X{logId} %-5level %logger{50} - %msg%n</pattern>
        </encoder>
    </appender>
    <!-- 日志級別設(shè)置 -->
    <root level="INFO">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE"/>
    </root>
</configuration>