OkHttp异步调用如何保留日志中的自定义线程名称？

使用OkHttp发起异步请求时，请求日志通过%t占位符能正确显示设备ID（比如[Device_778445]），但响应日志的线程名被OkHttp线程池的线程名（如OkHttp http://localhost:8080/...）替换，无法关联到对应的设备ID。期望请求和响应日志能显示同一个设备ID标识。

现有请求代码：

public void sendRequest(String requestJson) {    
    LOG.info("Sending payload: {}", requestJson);
    Request httpRequest = buildRequest(requestJson, url);
    okHttpClient.newCall(httpRequest).enqueue(new Callback() {
        @Override
        public void onResponse(Call call, Response response) {
            LOG.info("Received response: {}", response.body().string());
            // 处理响应逻辑...
        }
    });
}

当前日志效果：

[11:54:29:025] INFO  [Device_778445] TestDeviceClient - Sending payload:...
[11:54:30:011] INFO  [OkHttp http://localhost:8080/...] TestDeviceClient - Received response: ...

期望日志效果：

[11:54:29:025] INFO  [Device_778445] TestDeviceClient - Sending payload:...
[11:54:30:011] INFO  [Device_778445] TestDeviceClient - Received response: ...

用户尝试的临时方案是传入deviceId并在onResponse中修改线程名，但不确定是否合适：

public void sendRequest(String requestJson, String deviceId) {    
    LOG.info("Sending payload: {}", requestJson);
    Request httpRequest = buildRequest(requestJson, url);
    okHttpClient.newCall(httpRequest).enqueue(new Callback() {
        @Override
        public void onResponse(Call call, Response response) {
            Thread.currentThread().setName(deviceId);
            LOG.info("Received response: {}", response.body().string());
            // 处理响应逻辑...
        }
    });
}

临时方案的问题 #

OkHttp使用线程池复用线程，直接修改线程名会污染整个线程池：后续其他请求复用该线程时，线程名会保留之前设置的deviceId，导致日志标识混乱，无法对应正确的请求上下文。

更优方案：使用MDC（映射诊断上下文） #

MDC是SLF4J等日志框架提供的上下文传递机制，能在多线程场景下安全传递请求标识，无需修改线程名，是日志追踪的标准做法。

实现步骤 #

1. 在请求线程中存入设备ID到MDC，并保存上下文快照
2. 在回调线程中恢复MDC上下文，日志输出后清理上下文，避免线程复用污染
3. 修改日志格式，用%X{deviceId}替代或配合%t显示设备ID

代码示例：

import org.slf4j.MDC;
import java.util.Map;

public void sendRequest(String requestJson, String deviceId) {    
    // 请求线程中存入设备ID到MDC
    MDC.put("deviceId", deviceId);
    LOG.info("Sending payload: {}", requestJson);
    
    // 保存当前MDC上下文快照，用于异步回调恢复
    Map<String, String> mdcContext = MDC.getCopyOfContextMap();
    
    Request httpRequest = buildRequest(requestJson, url);
    okHttpClient.newCall(httpRequest).enqueue(new Callback() {
        @Override
        public void onResponse(Call call, Response response) {
            // 回调线程中恢复MDC上下文
            if (mdcContext != null) {
                MDC.setContextMap(mdcContext);
            }
            try {
                LOG.info("Received response: {}", response.body().string());
                // 处理响应逻辑...
            } finally {
                // 清理MDC，避免线程复用污染
                MDC.clear();
            }
        }

        @Override
        public void onFailure(Call call, IOException e) {
            if (mdcContext != null) {
                MDC.setContextMap(mdcContext);
            }
            try {
                LOG.error("Request failed for device", e);
            } finally {
                MDC.clear();
            }
        }
    });
    
    // 主线程移除设备ID，避免后续请求污染
    MDC.remove("deviceId");
}

修改日志格式 #

以Logback为例，修改logback.xml中的日志pattern：

<pattern>[%d{HH:mm:ss:SSS}] INFO  [Device_%X{deviceId}] %c - %m%n</pattern>

这样日志会自动显示Device_xxx的标识，无需依赖线程名。

其他可选方案 #

如果必须依赖线程名实现，可通过自定义OkHttp Dispatcher创建带上下文传递的线程池，但实现复杂度高，且仍存在线程复用的标识覆盖风险，因此不推荐。

内容的提问来源于stack exchange，提问作者Rajkishan Swami