举手之劳，轻松搞定SpringBoot中统一异常处理

2023-10-26 12:56:42

在开发Web应用时，尤其是在使用SpringBoot框架的项目中，有效地管理异常显得尤为重要。良好的异常处理机制不仅能提升用户体验，还能帮助开发者快速定位并解决问题。本文将介绍如何通过@ControllerAdvice注解来实现SpringBoot中的统一异常处理。

@ControllerAdvice：统一全局异常处理

在SpringBoot应用中，@ControllerAdvice是一个非常强大的工具，用来定义跨多个控制器的全局异常处理器和公共数据绑定方法。它能帮助开发者集中管理并响应不同类型的异常，而不是在每个控制器的方法里都添加try-catch块来捕获异常。

实现步骤

创建一个新的类，并使用@ControllerAdvice注解标记。
在该类中定义处理特定类型异常的方法，通过@ExceptionHandler注解指定要捕获的异常类型。
为方法提供必要的参数和返回值，以便生成适当的响应信息。

示例代码：

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(ResourceNotFoundException.class)
    public ResponseEntity<?> resourceNotFoundException(ResourceNotFoundException ex) {
        ErrorDetails errorDetails = new ErrorDetails(HttpStatus.NOT_FOUND, "Resource not found", ex.getMessage());
        return new ResponseEntity<>(errorDetails, HttpStatus.NOT_FOUND);
    }

    // 其他异常处理方法可以类似定义
}

上述代码中，GlobalExceptionHandler类使用@ControllerAdvice注解标记为全局异常处理器。其中定义了针对特定异常（如ResourceNotFoundException）的方法，并返回一个包含状态码和错误信息的ResponseEntity对象。

ErrorDetails实体

为了更好地组织响应数据，通常会创建一个ErrorDetails实体来封装错误信息：

public class ErrorDetails {
    private HttpStatus status;
    private String message;
    private String details;

    public ErrorDetails(HttpStatus status, String message, String details) {
        this.status = status;
        this.message = message;
        this.details = details;
    }

    // Getters and setters omitted for brevity
}

捕获系统异常

除了自定义的业务逻辑异常，还应该处理由框架或运行时抛出的一般性异常。可以通过在@ControllerAdvice类中添加相应的@ExceptionHandler方法来实现。

示例代码：

import org.springframework.web.HttpRequestMethodNotSupportedException;
import org.springframework.http.ResponseEntity;

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(HttpRequestMethodNotSupportedException.class)
    public ResponseEntity<?> handleMethodNotAllowed(HttpRequestMethodNotSupportedException ex) {
        ErrorDetails errorDetails = new ErrorDetails(HttpStatus.METHOD_NOT_ALLOWED, "Method Not Allowed", ex.getMessage());
        return new ResponseEntity<>(errorDetails, HttpStatus.METHOD_NOT_ALLOWED);
    }

    // 其他系统异常处理方法
}