spring boot的统一异常处理,使用@RestControllerAdvice

@RestControllerAdviceSpring Boot 中用于全局异常处理的注解,它结合了 @ControllerAdvice@ResponseBody 的功能。这意味着使用 @RestControllerAdvice 注解的类将应用于所有 @RequestMapping 方法,并且任何从这些方法返回的对象都会被转换为 HTTP 响应体。

下面是如何使用 @RestControllerAdvice 实现统一异常处理的一个示例:

创建自定义异常类

首先,创建一些自定义异常类来表示不同的错误情况。例如:

java 复制代码
public class ResourceNotFoundException extends RuntimeException {
    public ResourceNotFoundException(String message) {
        super(message);
    }
}

定义 API 错误响应格式

为了确保API返回的一致性,可以创建一个标准的错误响应结构,如 ApiError 类:

java 复制代码
public class ApiError {
    private HttpStatus status;
    private String message;
    private LocalDateTime timestamp;

    public ApiError(HttpStatus status, String message, Throwable throwable) {
        this.status = status;
        this.message = message;
        this.timestamp = LocalDateTime.now();
    }

    // Getters and Setters...
}

使用 @RestControllerAdvice 创建全局异常处理器

然后,你可以创建一个带有 @RestControllerAdvice 注解的类,用来处理不同类型的异常:

java 复制代码
@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(ResourceNotFoundException.class)
    public ResponseEntity<ApiError> handleResourceNotFoundException(ResourceNotFoundException ex) {
        ApiError apiError = new ApiError(HttpStatus.NOT_FOUND, ex.getMessage(), ex);
        return new ResponseEntity<>(apiError, HttpStatus.NOT_FOUND);
    }

    @ExceptionHandler(Exception.class)
    public ResponseEntity<ApiError> handleAllExceptions(Exception ex) {
        ApiError apiError = new ApiError(HttpStatus.INTERNAL_SERVER_ERROR, "An error occurred", ex);
        return new ResponseEntity<>(apiError, HttpStatus.INTERNAL_SERVER_ERROR);
    }

    // 你可以添加更多特定的 @ExceptionHandler 方法来处理其他类型的异常
}

配置全局异常属性(可选)

你还可以在 application.propertiesapplication.yml 文件中配置一些全局的行为,例如是否显示堆栈跟踪信息:

properties 复制代码
# application.properties
server.error.include-stacktrace=never

或者在 YAML 文件中:

yaml 复制代码
# application.yml
server:
  error:
    include-stacktrace: never

通过这种方式,@RestControllerAdvice 提供了一种简洁的方法来集中处理整个应用程序中的异常,确保所有异常都能以一致的方式响应客户端请求。此外,由于它自带了 @ResponseBody 功能,所以特别适合 RESTful Web 服务。

相关推荐
掘金码甲哥3 小时前
超性感的轻量级openclaw平替,我来给你打call
后端
用户8356290780516 小时前
无需 Office:Python 批量转换 PPT 为图片
后端·python
啊哈灵机一动6 小时前
使用golang搭建一个nes 模拟器
后端
日月云棠7 小时前
各版本JDK对比:JDK 25 特性详解
java
间彧7 小时前
SpringBoot + ShardingSphere 读写分离实战指南
后端
砍材农夫7 小时前
订单超时
后端
树獭叔叔8 小时前
06-大模型如何"学习":从梯度下降到AdamW优化器
后端·aigc·openai
用户8307196840828 小时前
Spring Boot 项目中日期处理的最佳实践
java·spring boot
得鹿8 小时前
MySQL基础架构与存储引擎、索引、事务、锁、日志
后端
程序员飞哥8 小时前
Block科技公司裁员四千人,竟然是因为 AI ?
人工智能·后端·程序员