基于Logback的MDC实现HTTP请求日志的全链路跟踪

原理

• 使用InheritableThreadLocal(旧版)或者ThreadLocal(新版本)维护一个Map

final ThreadLocal> copyOnThreadLocal = new ThreadLocal();

• 关键操作put,向当前线程的map中添加元素

public void put(String key, String val) throws IllegalArgumentException {
    if (key == null) {
      throw new IllegalArgumentException("key cannot be null");
    } else {
      Map oldMap = (Map)this.copyOnThreadLocal.get();
      Integer lastOp = this.getAndSetLastOperation(1);
      if (!this.wasLastOpReadOrNull(lastOp) && oldMap != null) {
        oldMap.put(key, val);
      } else {
        Map newMap = this.duplicateAndInsertNewMap(oldMap);
        newMap.put(key, val);
      }

    }
  }

• 日志输出
  在线程上下文中，维护一个 Map 属性来支持日志输出的时候，配置文件logback.xml 中配置了%X{key}，则后台日志打印出对应的 key 的值。
• 注意事项
  由于使用ThreadLocal,虽然每个线程间相互独立,但在不同的环境中,线程存在复用,因此,当前线程将本次业务逻辑处理完后.需及时清理线程中的变量.否则可能出现数据错误.
  另外, ThreadLocalMap内部Entry中key使用的是对ThreadLocal对象的弱引用, 及时清理,避免可能出现的内存溢出

步骤

• 使用拦截器或者过滤器拦截请求
• 处理逻辑前添加traceId到MDC
• 处理完城后移除添加的traceId

举例使用过滤器如下

过滤器拦截请求,并添加 traceId到MDC中, 请求处理完毕后,移除MDC中的traceId
MDC中的traceId添加后, 日志输出中可以打印traceId对应的值,每次请求重新生成traceId,确保每个请求traceId不同

package com.xxx.filter;

import java.io.IOException;
import java.util.UUID;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.annotation.WebFilter;
import org.slf4j.MDC;

@WebFilter(urlPatterns = "/*", filterName = "mdcFilter")
public class MdcFilter implements Filter {
    private static final String TRACE_ID = "traceId";

    @Override
    public void init(FilterConfig filterConfig) {
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        
        try {
            MDC.put(TRACE_ID, UUID.randomUUID().toString().replace("-", ""));
            chain.doFilter(request, response);
        } finally {
            MDC.remove(TRACE_ID);
        }
    }

    @Override
    public void destroy() {
    }
}

logback日志格式修改,添加[%X[traceId]] 到日志输出格式中

%d{yy-MM-dd HH:mm:ss.SSS} [%X[traceId]]  [%thread] %-5level %logger{50}:%line - %msg%n