SpringBoot项目使用MDC给日志增加唯一标识的实现步骤

 更新时间:2025年03月22日 13:59:08   作者:TOP灬小朋友  
本文介绍了如何在SpringBoot项目中使用MDC(Mapped Diagnostic Context)为日志增加唯一标识,以便于日志追踪,通过创建日志拦截器、配置拦截器以及修改日志配置文件,可以实现这一功能,文章还提供了源码地址,方便读者学习和参考,感兴趣的朋友一起看看吧

【JAVA】SpringBoot项目使用MDC给日志增加唯一标识,方便日志追踪

1.日志效果

2.实现步骤

2.1.创建日志拦截器 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 入参
     */
    @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>
            <!-- 最多保留指定天数的日志文件 -->
            <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>
    <!-- 日志级别设置 -->
    <root level="INFO">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE"/>
    </root>
</configuration>

3.源码地址

https://gitee.com/xhs101/spring-boot-demo

到此这篇关于SpringBoot项目使用MDC给日志增加唯一标识的文章就介绍到这了,更多相关SpringBoot MDC日志增加唯一标识内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java使用jcifs读取Windows的共享文件

    Java使用jcifs读取Windows的共享文件

    这篇文章主要为大家详细介绍了Java如何使用jcifs实现读取Windows的共享文件,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2026-04-04
  • Thymeleaf中th:each及th:if使用方法解析

    Thymeleaf中th:each及th:if使用方法解析

    这篇文章主要介绍了Thymeleaf中th:each及th:if使用方法解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-08-08
  • Spring Security6配置方法(废弃WebSecurityConfigurerAdapter)

    Spring Security6配置方法(废弃WebSecurityConfigurerAdapter)

    本文主要介绍了Spring Security6配置方法(废弃WebSecurityConfigurerAdapter),就像文章标题所说的,SpringSecurity已经废弃了继承WebSecurityConfigurerAdapter的配置方式,下面就来详细的介绍一下,感兴趣的可以了解一下
    2023-12-12
  • Spring 注入集合实现过程示例详解

    Spring 注入集合实现过程示例详解

    这篇文章主要为大家介绍了Spring 注入集合实现过程示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-09-09
  • Java使用Apache POI和EasyExcel读取Excel文件的实现方案

    Java使用Apache POI和EasyExcel读取Excel文件的实现方案

    Java 读取 Excel 文件核心依赖 Apache POI(兼容 .xls(Excel 97-2003)和 .xlsx(Excel 2007+))或 EasyExcel(阿里开源,低内存、高性能),以下是两种主流方案的完整实现,需要的朋友可以参考下
    2025-12-12
  • Spring Boot如何集成模板引擎FreeMarker

    Spring Boot如何集成模板引擎FreeMarker

    这篇文章主要介绍了Spring Boot如何集成模板引擎FreeMarker,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-10-10
  • java Arrays.asList 返回什么与普通 ArrayList 区别介绍

    java Arrays.asList 返回什么与普通 ArrayList 区别介

    Arrays.asList()返回一个固定大小的List视图,而不是java.util.ArrayList,它不支持add和remove操作,但支持set操作,本文介绍java Arrays.asList返回什么与普通 ArrayList区别,感兴趣的朋友跟随小编一起看看吧
    2026-01-01
  • 归并排序的实现代码与思路

    归并排序的实现代码与思路

    归并排序是建立在归并操作上的一种有效的排序算法。该算法是采用分治法(Divide and Conquer)的一个非常典型的应用。
    2013-03-03
  • MyBatis-Plus解决逻辑删除与唯一索引的问题

    MyBatis-Plus解决逻辑删除与唯一索引的问题

    本文主要介绍了MyBatis-Plus解决逻辑删除与唯一索引的问题,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-08-08
  • Java唯一订单编号生成代码例子

    Java唯一订单编号生成代码例子

    在项目中,我们经常遇到需要生成订单编号、字典编号等唯一值场景,下面这篇文章主要给大家介绍了关于Java唯一订单编号生成的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2024-07-07

最新评论