Java多线程使用MDC追踪日志方式

在Java应用程序中，多线程并发执行的情况很常见。在这种情况下，如果想追踪某个请求或操作的日志，需要借助线程本地变量和MDC（Mapped Diagnostic Context）技术来实现。

1. MDC是什么？

MDC是Logback和log4j等日志框架提供的一种日志追踪技术，用于在多线程环境中将一组关联的日志事件关联起来，便于后续查询和分析。MDC技术通过ThreadLocal实现，将一个Map对象与当前线程关联起来，Map对象中存放了所有需要传递到后续线程的数据。

2. MDC使用步骤

2.1 配置logback.xml

首先需要在logback.xml中配置MDC参数，将MDC标签添加到appender中。如下所示：

<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
    <mdcKey>traceId</mdcKey>
</appender>

在上例中，配置了mdcKey为traceId。在输出日志时，可以通过如下格式来输出traceId：

[%X{traceId}]

2.2 在代码中设置MDC参数

在代码中，需要设置相关的MDC参数。使用MDC.put()方法将需要传递的参数添加到MDC中。例如：

public class LogUtils {

    public static void log(String traceId, String message) {
        MDC.put("traceId", traceId);
        Logger logger = LoggerFactory.getLogger(LogUtils.class);
        logger.info("{}", message);
        MDC.remove("traceId");
    }
}

在上面的代码中，首先将traceId参数添加到MDC中，然后使用Logger输出日志。输出日志的格式需要根据logback.xml中对应的格式来设置。最后，需要将MDC中的参数从当前线程移除。

2.3 示例1

假设有一个并发应用场景，需要统计一个请求的执行时间。可以通过设置MDC参数来实现。

public class RequestHandler {

    public void handleRequest() {
        String traceId = UUID.randomUUID().toString();
        MDC.put("traceId", traceId);

        long startTime = System.currentTimeMillis();
        // 处理请求
        // ...

        long endTime = System.currentTimeMillis();
        long elapsedTime = endTime - startTime;
        LogUtils.log(traceId, "Request completed in " + elapsedTime + "ms.");
    }
}

在上述代码中，首先生成一个唯一的traceId，然后将其添加到MDC中。在处理完请求后，使用LogUtils.log()方法输出日志信息，此时会自动输出traceId。

2.4 示例2

假设有一个并发线程池，需要处理多个任务，并希望在每个任务中追踪一些关联的数据，可以通过设置MDC参数来实现。

public class TaskExecutor {

    public void executeTask(Task task) {
        String traceId = task.getTraceId();
        MDC.put("traceId", traceId);

        // 处理任务
        // ...

        LogUtils.log(traceId, "Task completed.");
    }
}

在上述代码中，首先从Task对象中获取traceId，然后将其添加到MDC中，以便在后续输出日志时能够输出traceId信息。

3. 总结

使用MDC技术可以方便地实现在多线程环境下的日志追踪。要使用MDC，需要在logback.xml中进行相关配置，并在代码中添加MDC参数。在上述代码示例中，展示了如何将traceId添加到MDC中，并输出日志信息。在实际应用中，还可以将其他关联数据添加到MDC中，以便更方便地进行日志追踪和查询。