如何使用SLF4J关联REST错误与日志条目？

在Java REST服务的异常处理场景中，我们需要返回不包含敏感信息的安全响应，同时确保响应能与日志条目关联以便后续调试。由于日志框架的LOGGER.error()方法返回void，无法直接获取日志标识，手动生成时间戳或随机数又会导致冗余或重复。以下是几种通用的解决方案：

1. 使用请求ID实现全链路追踪 #

这是业界最常用的方案，通过在请求入口生成唯一标识，贯穿整个请求生命周期：

• 实现步骤：
  • 通过拦截器/过滤器在请求进入时生成requestId（如UUID），存入请求上下文（Spring可使用RequestContextHolder或ThreadLocal）
  • 日志配置中添加requestId输出（Logback示例：%X{requestId}）
  • 异常处理时从上下文取出requestId并返回给响应体
• Spring拦截器代码示例：

public class RequestIdInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        String requestId = UUID.randomUUID().toString();
        request.setAttribute("requestId", requestId);
        MDC.put("requestId", requestId); // 存入MDC方便日志输出
        return true;
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        MDC.remove("requestId"); // 清理MDC，避免线程复用污染
    }
}

• 异常处理返回响应：

@ExceptionHandler(Exception.class)
public ResponseEntity<ErrorResponse> handleGenericException(HttpServletRequest request, Exception ex) {
    String requestId = (String) request.getAttribute("requestId");
    LOGGER.error("Unexpected error in REST call", ex);
    return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
            .body(new ErrorResponse("Unexpected error", requestId));
}

• 优点：支持全链路日志追踪，可关联整个请求的所有日志；无冗余信息，统一标识请求。

2. 自定义日志包装器生成异常关联ID #

如果仅需针对异常场景生成关联标识，可以封装日志方法：

• 实现步骤：
  • 编写日志包装类，在调用日志方法时生成唯一errorId
  • 将errorId与异常信息一同写入日志
  • 返回errorId给响应体
• 日志包装器代码示例：

public class LogWrapper {
    private static final Logger LOGGER = LoggerFactory.getLogger(LogWrapper.class);

    public static String error(String message, Throwable throwable) {
        String errorId = UUID.randomUUID().toString();
        LOGGER.error("{} - {}", errorId, message, throwable);
        return errorId;
    }
}

• 业务代码中使用：

String errorId = LogWrapper.error("Unexpected error in REST call", exception);
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
        .body(new ErrorResponse("Unexpected error", errorId));

• 优点：无需依赖请求上下文，灵活控制异常场景的标识；日志直接包含errorId，便于检索。

3. 利用MDC存储异常关联ID #

日志框架（Logback、Log4j2）的MDC（映射诊断上下文）支持在当前线程绑定键值对，适合轻量集成：

• 实现步骤：
  • 生成errorId并存入MDC
  • 日志配置中添加errorId输出（如%X{errorId}）
  • 响应体返回errorId，并清理MDC避免线程复用污染
• 异常处理代码示例：

@ExceptionHandler(Exception.class)
public ResponseEntity<ErrorResponse> handleException(Exception ex) {
    String errorId = UUID.randomUUID().toString();
    MDC.put("errorId", errorId);
    LOGGER.error("Unexpected error in REST call", ex);
    MDC.remove("errorId");
    return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
            .body(new ErrorResponse("Unexpected error", errorId));
}

• Logback日志配置示例：

<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
        <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %X{errorId} - %msg%n</pattern>
    </encoder>
</appender>

• 优点：集成日志框架原生功能，无需额外封装；基于ThreadLocal实现，线程安全。

以上方案均避免了时间戳重复或随机数冗余的问题，通过唯一标识实现响应与日志的关联，同时保证响应的安全性。可根据业务场景选择：全链路追踪用请求ID，仅异常场景用自定义包装器，轻量集成用MDC。

内容的提问来源于stack exchange，提问作者Adam Wise