SpringBoot如何全局捕获异常并记录详细日志信息？

Question

在SpringBoot项目中，如何实现全局异常捕获并记录详细的日志信息？当应用程序遇到未处理的异常时，如何通过自定义全局异常处理器（如使用`@ControllerAdvice`或`@ExceptionHandler`注解）捕获所有异常，并结合日志框架（如Logback或Log4j）记录异常堆栈信息、请求参数及用户上下文等关键数据？此外，在生产环境中，如何避免敏感信息泄露，同时确保日志内容足够详尽以支持问题排查？

Answer 1

1. 全局异常捕获的基本概念

在Spring Boot项目中，全局异常捕获是通过`@ControllerAdvice`和`@ExceptionHandler`注解实现的。这两个注解可以集中处理整个应用程序中的未捕获异常，并返回统一的错误响应。例如：

@ControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(Exception.class)
    public ResponseEntity<String> handleException(Exception ex) {
        return new ResponseEntity<>(ex.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

通过这种方式，我们可以捕获所有未处理的异常并提供自定义的错误响应。

2. 结合日志框架记录详细信息

在全局异常处理器中，结合Logback或Log4j等日志框架记录异常堆栈信息、请求参数及用户上下文等关键数据。以下是使用Logback的一个示例：

@Slf4j
@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    public ResponseEntity<String> handleException(HttpServletRequest request, Exception ex) {
        log.error("Request URL: {}, Exception Message: {}", request.getRequestURI(), ex.getMessage(), ex);
        return new ResponseEntity<>(ex.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

在此示例中，我们不仅记录了异常消息，还记录了请求的URL和完整的异常堆栈信息。

3. 避免敏感信息泄露

在生产环境中，直接记录请求参数可能会导致敏感信息泄露。因此，我们需要对请求参数进行过滤。以下是一个简单的过滤器实现：

• 创建一个`SensitiveDataFilter`类，用于过滤敏感字段。
• 在记录日志时调用该过滤器。

public class SensitiveDataFilter {
    public static Map<String, Object> filter(Map<String, Object> params) {
        // 过滤逻辑
        return params;
    }
}

4. 日志内容详尽与安全性的平衡

为了确保日志内容足够详尽以支持问题排查，同时避免敏感信息泄露，可以采取以下措施：

措施	描述
使用占位符	对于敏感字段，使用占位符代替实际值。
日志分级	根据日志级别区分敏感信息和普通信息。

5. 流程图说明

下面是一个流程图，展示了从捕获异常到记录日志的整体流程：

mermaid
sequenceDiagram
    participant Controller
    participant GlobalExceptionHandler
    participant Logger
    Controller->>GlobalExceptionHandler: Throw Exception
    GlobalExceptionHandler->>Logger: Log Request Info and Stack Trace
    Logger-->>GlobalExceptionHandler: Log Completed
    GlobalExceptionHandler-->>Controller: Return Error Response