springboot的统一异常处理,使用@RestControllerAdvice详解

 更新时间:2024年12月14日 14:53:49   作者:无足鸟丶  
@RestControllerAdvice是Spring Boot中的全局异常处理注解,结合了@ControllerAdvice和@ResponseBody的功能,通过创建自定义异常类和全局异常处理器,可以实现统一异常处理,确保API的一致性和响应的标准化

springboot统一异常处理,使用@RestControllerAdvice

@RestControllerAdviceSpring Boot 中用于全局异常处理的注解,它结合了 @ControllerAdvice@ResponseBody 的功能。

这意味着使用 @RestControllerAdvice 注解的类将应用于所有 @RequestMapping 方法,并且任何从这些方法返回的对象都会被转换为 HTTP 响应体。

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

创建自定义异常类

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

例如:

public class ResourceNotFoundException extends RuntimeException {
    public ResourceNotFoundException(String message) {
        super(message);
    }
}

定义API错误响应格式

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

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 注解的类,用来处理不同类型的异常:

@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 文件中配置一些全局的行为,

例如是否显示堆栈跟踪信息:

# application.properties
server.error.include-stacktrace=never

或者在 YAML 文件中:

# application.yml
server:
  error:
    include-stacktrace: never

通过这种方式,@RestControllerAdvice 提供了一种简洁的方法来集中处理整个应用程序中的异常,确保所有异常都能以一致的方式响应客户端请求。

此外,由于它自带了 @ResponseBody 功能,所以特别适合 RESTful Web 服务。

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Java处理表格的实用工具库

    Java处理表格的实用工具库

    EasyExcel是一个基于Java的简单、省内存的读写Excel的开源项目,在尽可能节约内存的情况下支持读写百M的Excel,下面这篇文章主要给大家分享介绍了一个关于Java处理表格的实用工具库,需要的朋友可以参考下
    2021-11-11
  • Java中Calendar时间操作常用方法详解

    Java中Calendar时间操作常用方法详解

    这篇文章主要为大家详细介绍了Java中Calendar时间操作常用方法,calendar中set方法和静态属性带来的一些坑,感兴趣的小伙伴们可以参考一下
    2016-05-05
  • 一段眼睛跟着鼠标转动的跟踪眼代码

    一段眼睛跟着鼠标转动的跟踪眼代码

    java实现的眼睛跟着鼠标转动的跟踪眼代码
    2008-10-10
  • Spring Boot集成mongodb数据库过程解析

    Spring Boot集成mongodb数据库过程解析

    这篇文章主要介绍了Spring Boot集成mongodb数据库过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-05-05
  • Java double类型比较大小详解

    Java double类型比较大小详解

    这篇文章主要介绍了Java double类型比较大小,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-12-12
  • SpringBoot中实现数据字典的示例代码

    SpringBoot中实现数据字典的示例代码

    这篇文章主要介绍了SpringBoot中实现数据字典的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-09-09
  • MybatisPlus LambdaQueryWrapper使用int默认值的坑及解决

    MybatisPlus LambdaQueryWrapper使用int默认值的坑及解决

    这篇文章主要介绍了MybatisPlus LambdaQueryWrapper使用int默认值的坑及解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教。
    2022-01-01
  • java应用cpu占用过高问题分析及解决方法

    java应用cpu占用过高问题分析及解决方法

    这篇文章主要介绍了java应用cpu占用过高问题分析及解决方法,具有一定参考价值,需要的朋友可以参考下。
    2017-09-09
  • Java交换map的key和value值的步骤和代码示例

    Java交换map的key和value值的步骤和代码示例

    在Java中,我们都知道直接交换Map的key和value是不被允许的,因为Map的接口设计是基于key-value对的,其中key是唯一的,并且是不可变的,所以本文给大家介绍了Java交换map的key和value值的步骤和代码示例,需要的朋友可以参考下
    2024-09-09
  • Java阻塞队列必看类:BlockingQueue快速了解大体框架和实现思路

    Java阻塞队列必看类:BlockingQueue快速了解大体框架和实现思路

    这篇文章主要介绍了Java阻塞队列必看类:BlockingQueue快速了解大体框架和实现思路,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-10-10

最新评论