java 如何实现日志追踪MDC

Java实现日志追踪MDC攻略

1. 什么是MDC？

MDC全称为Mapped Diagnostic Context，即映射的诊断上下文。MDC提供了一种在并发系统中记录日志信息的方式，它在不同线程中存储不同的值，保证线程安全的同时，能够让日志信息具有可追溯性。

2. 实现MDC日志追踪的步骤

以下是实现MDC日志追踪的步骤：

2.1 初始化MDC

一般情况下，在应用程序初始化的时候需要初始化MDC。MDC的初始化可以通过静态代码块来实现，示例代码如下：

static {
    MDC.put("user", "unknown");
}

或者在web应用程序中，我们可以在Filter的init方法中进行MDC的初始化，示例代码如下：

public void init(FilterConfig config) throws ServletException {
    MDC.put("user", "unknown");
}

2.2 设置MDC值

在需要记录相关上下文的地方，需要设置MDC的值。示例代码如下：

MDC.put("user", "chenxiang");

2.3 记录相关日志

在记录日志的地方，可以使用MDC的值。示例代码如下：

LOGGER.info("User did something interesting", MDC.get("user"));

2.4 清除MDC

在不需要MDC时，需要清空MDC中的值，示例代码如下：

MDC.clear();

3. 示例说明

以下是两个示例，分别说明了MDC如何在web应用程序中和spring应用程序中实现日志追踪。

示例1：web应用程序

在web应用程序中，我们可以使用Filter来实现MDC的初始化和清空。示例代码如下：

public class MDCLoggingFilter implements Filter {

  @Override
  public void doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain) throws IOException, ServletException {
    HttpServletRequest httpRequest = (HttpServletRequest) request;
    HttpServletResponse httpResponse = (HttpServletResponse) response;

    // 初始化MDC
    MDC.put("ipAddress", httpRequest.getRemoteAddr());
    MDC.put("userAgent", httpRequest.getHeader("User-Agent"));

    try {
      filterChain.doFilter(request, response);
    } finally {
      // 清空MDC
      MDC.clear();
    }
  }

  // ... other methods ...
}

在log4j配置文件中，可以使用log4j的标准Layout的方式来输出MDC的值。例子如下：

<PatternLayout pattern="%d{ISO8601} [%thread] %-5level %logger{36} - %msg %X{ipAddress} | %X{userAgent} %n" />

上面配置中的%X{ipAddress} | %X{userAgent}表示输出MDC中的ipAddress和userAgent的值。

示例2：spring应用程序

在spring应用程序中，我们可以使用spring的AOP来实现MDC的设置和清空。示例代码如下：

@Aspect
@Component
public class LoggingAspect {

  @Around("execution(* com.example.*.*(..))")
  public Object profile(ProceedingJoinPoint joinPoint) throws Throwable {
    HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.currentRequestAttributes()).getRequest();

    // 设置MDC
    MDC.put("ipAddress", request.getRemoteAddr());
    MDC.put("userAgent", request.getHeader("User-Agent"));

    Object result = joinPoint.proceed();

    // 清空MDC  
    MDC.clear();

    return result;
  }

}

需要注意的是，上面的示例中使用了Around，也就是说，在它所包围的方法执行前和执行后都会执行。注意在Aspect类上使用@Aspect和@Component注解，这样spring才能扫描到这个类，并注册为切面。