【Spring Boot 异常处理】

文章目录

• [一、Spring Boot 中的异常处理概述](#一、Spring Boot 中的异常处理概述)
• • [1. 异常处理的重要性](#1. 异常处理的重要性)
  • [2. Spring Boot的默认异常处理机制](#2. Spring Boot的默认异常处理机制)
• 二、自定义异常处理
• • [1. 创建自定义异常类](#1. 创建自定义异常类)
  • • 示例代码
  • [2. 使用`@ExceptionHandler`注解](#2. 使用@ExceptionHandler注解)
  • • 示例代码
  • [3. `@ControllerAdvice`的使用](#3. @ControllerAdvice的使用)
  • • 示例代码
• 三、进阶异常处理
• • [1. 异常处理与REST API](#1. 异常处理与REST API)
  • • 使用`@RestControllerAdvice`
  • [2. 使用`ResponseEntityExceptionHandler`](#2. 使用ResponseEntityExceptionHandler)
  • • 扩展`ResponseEntityExceptionHandler`
  • [3. 异常与日志管理](#3. 异常与日志管理)
  • • 集成日志管理

一、Spring Boot 中的异常处理概述

1. 异常处理的重要性

良好的异常处理机制不仅关乎应用程序的稳定性和安全性，还直接影响到用户体验：

• 提高应用稳定性：有效的异常处理可以防止应用程序因未预料的错误而崩溃，确保应用即使在异常情况下也能继续运行，或至少能够优雅地失败，从而提高整体的应用稳定性。
• 增强用户体验：通过友好的错误提示和异常反馈，用户可以了解操作失败的原因，甚至得到如何解决问题的指引，很大程度上增强了用户体验。
• 便于问题定位和调试：合理的异常处理和记录机制能够帮助开发者快速定位问题根源，简化调试和修复过程，提高开发效率。

2. Spring Boot的默认异常处理机制

• 内置异常处理器 ：Spring Boot内部集成了BasicErrorController，自动处理所有的HTTP错误映射。对于常见的HTTP错误，比如404（资源未找到）或500（服务器内部错误），Spring Boot会自动映射到相应的错误页面。
• 默认错误页面：当发生异常时，如果是Web应用，Spring Boot会默认提供一个简单的错误页面，显示异常的状态码和简要信息。这提供了一个基本的用户反馈机制，避免了用户面对白屏或不友好的错误提示。
• 可定制性：虽然Spring Boot提供了默认的异常处理机制，但它也允许开发者通过简单的配置或添加自定义代码来覆盖默认行为，比如自定义错误页面、错误信息的格式化输出等。

二、自定义异常处理

虽然Spring Boot提供了默认的异常处理机制，但在很多情况下，还是需要根据应用程序的特定需求来自定义这些行为。

1. 创建自定义异常类

示例代码

public class CustomException extends RuntimeException {
    public CustomException(String message) {
        super(message);
    }
    // 其他构造函数和方法可以根据需要添加，例如，错误代码或者错误详细信息等
}

通过继承RuntimeException或其他标准Java异常类，我们可以创建具有特定错误信息或状态的异常类。这样的设计使得异常的抛出和处理更为灵活和清晰。

2. 使用@ExceptionHandler注解

@ExceptionHandler注解允许我们处理由控制器（Controller）抛出的特定类型的异常。通过定义异常处理方法，并将其与异常类关联，我们可以定制异常的处理逻辑，包括返回错误信息和状态码。

示例代码

@ControllerAdvice
public class CustomExceptionHandler {

    @ExceptionHandler(CustomException.class)
    public ResponseEntity<Object> handleCustomException(CustomException ex) {
        // 创建一个适合的响应实体，包含错误信息和适当的HTTP状态码
        Map<String, Object> body = new LinkedHashMap<>();
        body.put("timestamp", LocalDateTime.now());
        body.put("message", ex.getMessage());

        return new ResponseEntity<>(body, HttpStatus.BAD_REQUEST);
    }
}

3. @ControllerAdvice的使用

@ControllerAdvice注解用于定义全局异常处理器，它能够捕获并处理所有控制器中抛出的异常。通过与@ExceptionHandler结合使用，我们可以在一个地方集中管理和处理应用程序中的所有异常。

示例代码

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    public ResponseEntity<Object> handleGlobalException(Exception ex, WebRequest request) {
        Map<String, Object> body = new LinkedHashMap<>();
        body.put("timestamp", LocalDateTime.now());
        body.put("message", "An unexpected error occurred");

        return new ResponseEntity<>(body, HttpStatus.INTERNAL_SERVER_ERROR);
    }

    // 可以添加更多的异常处理方法来处理不同类型的异常
}

三、进阶异常处理

1. 异常处理与REST API

@RestControllerAdvice结合了@ControllerAdvice和@ResponseBody，提供了一个跨所有@RestController的异常处理方案。

使用@RestControllerAdvice

@RestControllerAdvice
public class RestExceptionHandler {

    @ExceptionHandler(CustomException.class)
    public ResponseEntity<?> handleCustomException(CustomException ex) {
        ApiError error = new ApiError(HttpStatus.BAD_REQUEST, ex.getMessage());
        return new ResponseEntity<>(error, error.getStatus());
    }

    // 其他异常处理方法
}

这种方法使得处理异常时自动将异常信息序列化为JSON或其他响应体格式，从而为客户端提供了一致和标准化的错误响应结构。

2. 使用ResponseEntityExceptionHandler

ResponseEntityExceptionHandler用于处理Spring MVC抛出的所有异常。通过扩展这个类，并覆盖其中的方法，我们可以自定义异常的处理逻辑，包括自定义HTTP响应的状态码和错误信息。

扩展ResponseEntityExceptionHandler

@ControllerAdvice
public class RestResponseEntityExceptionHandler extends ResponseEntityExceptionHandler {

    @Override
    protected ResponseEntity<Object> handleMethodArgumentNotValid(MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
        List<String> errors = new ArrayList<>();
        for (FieldError error : ex.getBindingResult().getFieldErrors()) {
            errors.add(error.getField() + ": " + error.getDefaultMessage());
        }
        ApiError apiError = new ApiError(HttpStatus.BAD_REQUEST, "Validation failed", errors);
        return handleExceptionInternal(ex, apiError, headers, apiError.getStatus(), request);
    }

    // 其他重写方法
}

这个方法特别适用于处理各种Spring MVC层面的异常，如表单验证失败(MethodArgumentNotValidException)等。

3. 异常与日志管理

合理的异常日志记录对于定位和分析生产环境中的问题至关重要。通过结合日志管理工具（如SLF4J、Logback或Log4j2），可以记录关键的异常信息，包括异常类型、消息、堆栈跟踪和发生时间等。

集成日志管理

@ControllerAdvice
public class GlobalExceptionHandler {

    private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);

    @ExceptionHandler(value = { Exception.class })
    public ResponseEntity<Object> handleAnyException(Exception ex, WebRequest request) {
        logger.error("Unhandled exception caught: ", ex);
        ApiError apiError = new ApiError(HttpStatus.INTERNAL_SERVER_ERROR, ex.getLocalizedMessage(), "error occurred");
        return new ResponseEntity<>(apiError, new HttpHeaders(), apiError.getStatus());
    }
}