Spring Boot中如何用唯一ID记录错误并在REST响应中返回该ID？

这是一个非常实用的生产级需求，我来帮你落地实现！核心思路是在全局异常处理流程中生成唯一追踪ID，将ID与异常详情绑定记录到日志，同时把ID返回给用户用于后续问题排查。下面是具体的实现方案：

1. 定义错误响应DTO #

首先创建一个用于返回给用户的错误响应实体，只包含必要的信息（避免泄露敏感异常细节）：

public class ErrorResponse {
    private String errorId;
    private String message;

    // 构造器
    public ErrorResponse(String errorId, String message) {
        this.errorId = errorId;
        this.message = message;
    }

    // Getter方法（或使用Lombok的@Data注解简化代码）
    public String getErrorId() {
        return errorId;
    }

    public String getMessage() {
        return message;
    }
}

2. 完善全局异常处理器 #

在你的@ControllerAdvice类中，添加生成唯一ID、记录日志和返回响应的逻辑：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import java.util.UUID;

@ControllerAdvice
public class GlobalExceptionHandler {

    // 初始化日志器
    private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);

    // 捕获所有全局异常
    @ExceptionHandler(Exception.class)
    public ResponseEntity<ErrorResponse> handleAllExceptions(Exception ex) {
        // 生成唯一错误ID（UUID保证足够的唯一性）
        String errorId = UUID.randomUUID().toString();

        // 记录日志：将错误ID与异常栈信息绑定，方便后续排查
        logger.error("系统异常，错误ID: {}", errorId, ex);

        // 返回给用户的友好响应，仅包含错误ID和提示语
        ErrorResponse errorResponse = new ErrorResponse(
            errorId,
            "系统出现未知错误，请联系技术支持并提供此错误ID"
        );
        return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
    }

    // 可选：针对特定异常定制处理逻辑（比如空指针、参数校验异常等）
    @ExceptionHandler(IllegalArgumentException.class)
    public ResponseEntity<ErrorResponse> handleIllegalArgument(IllegalArgumentException ex) {
        String errorId = UUID.randomUUID().toString();
        logger.error("参数非法，错误ID: {}", errorId, ex);
        ErrorResponse errorResponse = new ErrorResponse(
            errorId,
            "请求参数非法，请检查后重试，如需帮助请提供此错误ID"
        );
        return new ResponseEntity<>(errorResponse, HttpStatus.BAD_REQUEST);
    }
}

3. 日志格式优化（可选） #

如果使用默认的Logback日志框架，可以在src/main/resources/logback-spring.xml中配置日志格式，让所有日志都能关联到错误ID（如果需要跨请求追踪的话）：

<configuration>
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - errorId: %X{errorId} - %msg%n</pattern>
        </encoder>
    </appender>
    
    <!-- 其他appender配置（比如文件输出） -->
    
    <root level="info">
        <appender-ref ref="CONSOLE"/>
    </root>
</configuration>

此时可以通过MDC.put("errorId", errorId)将ID存入MDC上下文，让整个请求链路的日志都自动带上这个ID，进一步提升排查效率。

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