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

相关推荐
onejason1 分钟前
《PHP 爬虫实战指南:获取淘宝店铺详情》
前端·后端·php
码事漫谈9 分钟前
你的代码可能在偷偷崩溃!
后端
hty6215 分钟前
Spring Boot 注解式大文件 Excel 导入工具:excel‑import‑spring‑boot‑starter
java
李少兄15 分钟前
解决IntelliJ IDEA 项目名称后带中括号问题(模块名不一致)
java·ide·intellij-idea
dylan_QAQ15 分钟前
【附录】Spring容器的启动过程是怎样的?
后端·spring
白应穷奇18 分钟前
编写高性能数据处理代码 02
后端·python
这个做不了20 分钟前
基于模板方法与工厂模式的多支付公司/产品接入方案
后端
Alt.928 分钟前
SpringMVC(一)
java·mvc
Moonbit36 分钟前
MoonBit Pearls Vol.03:01背包问题
后端·算法·编程语言
干了这杯柠檬多37 分钟前
使用maven-shade-plugin解决es跨版本冲突
java·elasticsearch·maven