映射调试上下文MDC

最新推荐文章于 2025-03-20 14:56:13 发布

原创

最新推荐文章于 2025-03-20 14:56:13 发布 · 430 阅读

4 ·

CC 4.0 BY-SA版权

文章标签：

#java #开发语言

本文介绍了MDC（Mapped Diagnostic Context），它是log4j和logback提供的多线程日志记录功能，可看作与当前线程绑定的Map，能添加键值对，子线程会继承父线程的MDC内容。还阐述了其原理，并说明了使用步骤，包括配置TraceId过滤器、启动类开启和配置日志输出格式。

1.简介

MDC 介绍 MDC（Mapped Diagnostic Context，映射调试上下文）是 log4j 和 logback 提供的一种方便在多线程条件下记录日志的功能。MDC 可以看成是一个与当前线程绑定的Map，可以往其中添加键值对。MDC 中包含的内容可以被同一线程中执行的代码所访问。当前线程的子线程会继承其父线程中的 MDC 的内容。当需要记录日志时，只需要从 MDC 中获取所需的信息即可。MDC 的内容则由程序在适当的时候保存进去。对于一个 Web 应用来说，通常是在请求被处理的最开始保存这些数据。简而言之，MDC就是日志框架提供的一个InheritableThreadLocal，项目代码中可以将键值对放入其中，然后使用指定方式取出打印即可。

原理：当请求来时生成一个traceId放在InheritableThreadLocal里，然后打印时去取就行了。但在不改动原有输出语句的前提下自然需要日志框架的支持了。

2.使用

2.1配置TraceId 过滤器

@Order(1)

@WebFilter(urlPatterns = "/*",filterName = "traceIdFilter")
public class TraceIdFilter implements Filter {

    public final static String MDC_TRACE_ID = "traceId";

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain