SpringBoot + MDC 实现全链路调用日志跟踪

写在前面

通过本文将了解到什么是 MDC、MDC 应用中存在的问题、如何解决存在的问题。

MDC 介绍

简介

MDC（Mapped Diagnostic Context，映射调试上下文）是 log4j 、logback及log4j2 提供的一种方便在多线程条件下记录日志的功能。MDC 可以看成是一个与当前线程绑定的哈希表，可以往其中添加键值对。MDC 中包含的内容可以被同一线程中执行的代码所访问。当前线程的子线程会继承其父线程中的 MDC 的内容。当需要记录日志时，只需要从 MDC 中获取所需的信息即可。MDC 的内容则由程序在适当的时候保存进去。对于一个 Web 应用来说，通常是在请求被处理的最开始保存这些数据。

API 说明

• clear() => 移除所有 MDC

• get (String key) => 获取当前线程 MDC 中指定 key 的值

• getContext() => 获取当前线程 MDC 的 MDC

• put(String key, Object o) => 往当前线程的 MDC 中存入指定的键值对

• remove(String key) => 删除当前线程 MDC 中指定的键值对

优点

代码简洁，日志风格统一，不需要在 log 打印中手动拼写 traceId，即

LOGGER.info("traceId:{} ", traceId)

暂时只能想到这一点。

MDC 使用

添加拦截器

public class LogInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //如果有上层调用就用上层的ID
        String traceId = request.getHeader(Constants.TRACE_ID);
        if (traceId == null) {
            traceId = TraceIdUtil.getTraceId();
        }

        MDC.put(Constants.TRACE_ID, traceId);
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)
            throws Exception {
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
            throws Exception {
        //调用结束后删除
        MDC.remove(Constants.TRACE_ID);
    }
}

修改日志格式

<property name="pattern">[TRACEID:%X{traceId}] %d{HH:mm:ss.SSS} %-5level %class{-1}.%M()/%L - %msg%xEx%n</property>

重点是 %X{traceId}，traceId 和 MDC 中的键名称一致。

简单使用就这么容易，但是在有些情况下 traceId 将获取不到。