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日志增加唯一标识内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 在Spring中利用@Order注解对bean和依赖进行排序

    在Spring中利用@Order注解对bean和依赖进行排序

    在Spring框架中,@Order是一个经常被忽视但非常重要的注解,在项目开发中,当我们需要维护bean的特定顺序或者存在许多相同类型的bean时,这个注解就发挥了作用,这篇文章讲的就是如何利用@Order注解对bean和依赖进行排序,需要的朋友可以参考下
    2023-11-11
  • idea搭建可运行Servlet的Web项目

    idea搭建可运行Servlet的Web项目

    在网上看到一篇很详细的 intelliJ IDEA 创建web项目并简单部署servlet的图文教程,今天自己也配置一下,留个笔记,感兴趣的可以了解一下
    2021-06-06
  • Spring-AOP 静态正则表达式方法如何匹配切面

    Spring-AOP 静态正则表达式方法如何匹配切面

    这篇文章主要介绍了Spring-AOP 静态正则表达式方法如何匹配切面的操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • Quartz+Spring Boot实现动态管理定时任务

    Quartz+Spring Boot实现动态管理定时任务

    最近做项目遇到动态管理定时任务的需求,刚拿到这个需求还真不知道从哪下手,经过一番思考,终于找出实现思路,接下来通过本文给大家介绍了Quartz+Spring Boot实现动态管理定时任务的相关知识,需要的朋友可以参考下
    2018-09-09
  • 探索Java I/O 模型的演进

    探索Java I/O 模型的演进

    什么是同步?什么是异步?阻塞和非阻塞又有什么区别?本文先从 Unix 的 I/O 模型讲起,介绍了5种常见的 I/O 模型。而后再引出 Java 的 I/O 模型的演进过程,并用实例说明如何选择合适的 Java I/O 模型来提高系统的并发量和可用性。,需要的朋友可以参考下
    2019-06-06
  • SpringBoot中的五种对静态资源的映射规则的实现

    SpringBoot中的五种对静态资源的映射规则的实现

    这篇文章主要介绍了SpringBoot中的五种对静态资源的映射规则的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-12-12
  • spring cloud gateway中netty线程池小优化

    spring cloud gateway中netty线程池小优化

    这篇文章主要介绍了spring cloud gateway中netty线程池小优化技巧示例,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-07-07
  • 基于Java语言在窗体上实现飞机大战小游戏的完整步骤

    基于Java语言在窗体上实现飞机大战小游戏的完整步骤

    这篇文章主要给大家介绍了基于Java语言在窗体上实现飞机大战小游戏的完整步骤,文中通过图文以及实例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2022-02-02
  • Java详细分析讲解泛型

    Java详细分析讲解泛型

    在正式进入内容之前说明一下:泛型的内容太多,也太复杂。这里因为Java中写数据结构的时候会使用到,所以加上。关于泛型我找了挺多文章,再结合自己的理解,尽可能将其讲清楚。不求会使用泛型,只要求后面数据结构出现泛型的时候能够知道是在干什么即可
    2022-05-05
  • Java19新特性虚拟线程的具体使用

    Java19新特性虚拟线程的具体使用

    Java 19 引入了虚拟线程,这是 JDK Project Loom 项目中的重要新特性,目的是简化 Java 中的并发编程,并提高线程管理的效率和性能,下面就来具体介绍下
    2024-09-09

最新评论