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 服务。

相关推荐
毕设源码-赖学姐7 分钟前
【开题答辩全过程】以 高校人才培养方案管理系统的设计与实现为例,包含答辩的问题和答案
java
+VX:Fegn089517 分钟前
计算机毕业设计|基于springboot + vue在线音乐播放系统(源码+数据库+文档)
数据库·vue.js·spring boot·后端·课程设计
一起努力啊~19 分钟前
算法刷题-二分查找
java·数据结构·算法
小途软件22 分钟前
高校宿舍访客预约管理平台开发
java·人工智能·pytorch·python·深度学习·语言模型
J_liaty27 分钟前
Java版本演进:从JDK 8到JDK 21的特性革命与对比分析
java·开发语言·jdk
code bean39 分钟前
Flask图片服务在不同网络接口下的路径解析问题及解决方案
后端·python·flask
+VX:Fegn08951 小时前
计算机毕业设计|基于springboot + vue律师咨询系统(源码+数据库+文档)
java·数据库·vue.js·spring boot·后端·课程设计
努力的小郑1 小时前
2025年度总结:当我在 Cursor 里敲下 Tab 的那一刻,我知道时代变了
前端·后端·ai编程
daidaidaiyu1 小时前
一文学习和实践 当下互联网安全的基石 - TLS 和 SSL
java·netty
hssfscv1 小时前
Javaweb学习笔记——后端实战2_部门管理
java·笔记·学习