spring注解之——@RestControllerAdvice

最新推荐文章于 2024-08-12 22:17:59 发布

二十三年蝉&

最新推荐文章于 2024-08-12 22:17:59 发布

阅读量317

点赞数 8

分类专栏： spring注解文章标签： spring boot 后端 java

本文链接：https://blog.csdn.net/q12ERTYU/article/details/138465942

版权

spring注解专栏收录该内容

5 篇文章 0 订阅

订阅专栏

这篇文章介绍了Spring框架中的@RestControllerAdvice注解在SpringMVC应用中的作用，包括全局异常处理，如何与@ExceptionHandler配合处理不同类型的异常，并以RESTfulAPI格式返回响应。

摘要由CSDN通过智能技术生成

@RestControllerAdvice
是Java中Spring框架提供的一个注解，主要用在Spring MVC应用程序中。它是注释的特殊化@ControllerAdvice

以下是它的作用和使用方法：

全局异常处理：它允许您以集中的方式处理整个应用程序的异常。当应用程序中的任何控制器方法抛出异常时，@RestControllerAdvice带注释的类可以拦截并处理这些异常。
@ControllerAdvice 和 @ResponseBody 的组合：与@ControllerAdvice通常处理基于视图的控制器不同，@RestControllerAdvice是专门为 RESTful API 设计的。它结合了@ControllerAdvice和@ResponseBody，这意味着它不仅拦截异常，而且还以适合 RESTful API（如 JSON 或 XML）的格式直接返回响应，而不需要@ResponseBody在每个处理程序方法上显式注释。
合并异常处理：通常用于合并异常处理逻辑并减少重复。您可以在用@RestControllerAdvice.
自定义：您可以@RestControllerAdvice在应用程序中定义多个类来处理不同类型的异常或对相关的异常处理逻辑进行分组。

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(value = {NullPointerException.class, IllegalArgumentException.class})
    public ResponseEntity<Object> handleBadRequestException(RuntimeException ex, WebRequest request) {
        // Craft a custom response body
        String responseBody = "An error occurred: " + ex.getMessage();
        
        // Return ResponseEntity with appropriate status code and response body
        return ResponseEntity.badRequest().body(responseBody);
    }

    @ExceptionHandler(value = {NotFoundException.class})
    public ResponseEntity<Object> handleNotFoundException(NotFoundException ex, WebRequest request) {
        // Craft a custom response body
        String responseBody = "Resource not found: " + ex.getMessage();
        
        // Return ResponseEntity with appropriate status code and response body
        return ResponseEntity.status(HttpStatus.NOT_FOUND).body(responseBody);
    }

    // More exception handling methods can be defined here
}

@RestControllerAdvice用于将该类标记GlobalExceptionHandler为全局异常处理程序。
@ExceptionHandler用于指定每个方法应该处理哪些异常。该handleBadRequestException方法处理NullPointerExceptionand IllegalArgumentException， whilehandleNotFoundException处理NotFoundException。
在每个方法中，您可以根据需要自定义响应并返回一个ResponseEntity对象。