[Spring~源码] ControllerAdvice揭秘

系统管理员 2024-02-05 14:22 7阅读 0赞

> 在Spring MVC中，我们经常使用`@ControllerAdvice`注解，可以实现全局统一异常处理、全局数据绑定等功能。但是，它的实现原理是什么呢？在本文中，我们将深入探究`@ControllerAdvice`的实现原理。

--------------------

#### 文章目录 ####

*   *  什么是@ControllerAdvice
     *  @ControllerAdvice的实现原理
     *   *  @RestControllerAdvice的实现原理
         *  @ControllerAdvice的实现原理
     *  总结

### 什么是@ControllerAdvice ###

`@ControllerAdvice`是一个类级别的注解，它可以指定一个或多个包含`@Controller`注解的类，用于处理控制器中发生的异常和数据绑定。它的主要作用有以下三点：

1.  全局统一异常处理
2.  全局数据绑定
3.  全局模型属性设置

### @ControllerAdvice的实现原理 ###

在Spring MVC中，`@ControllerAdvice`是通过`@RestControllerAdvice`和`@ControllerAdvice`两个注解来实现的。`@RestControllerAdvice`是在Spring 4.0中新增的注解，它只能用于处理JSON响应；`@ControllerAdvice`则是用于处理HTML响应。

#### @RestControllerAdvice的实现原理 ####

`@RestControllerAdvice`实现的原理和`@ControllerAdvice`基本一致。它可以指定一个或多个包含`@RestController`注解的类，用于处理控制器中发生的异常和数据绑定。它的主要作用有以下三点：

1.  全局统一异常处理
2.  全局数据绑定
3.  全局模型属性设置

`@RestControllerAdvice`实现全局统一异常处理的方式与`@ControllerAdvice`类似，具体可以参考下面的代码：

@RestControllerAdvice
    public class GlobalExceptionHandler {
        
    
        @ExceptionHandler(Exception.class)
        public ResponseEntity<ErrorResponse> handleException(Exception ex) {
        
            ErrorResponse response = new ErrorResponse("500", ex.getMessage());
            return new ResponseEntity<>(response, HttpStatus.INTERNAL_SERVER_ERROR);
        }
    }

在上述代码中，我们定义了一个`@ExceptionHandler`方法，用于处理发生在控制器中的任何异常。如果发生异常，将返回一个JSON格式的错误信息。

#### @ControllerAdvice的实现原理 ####

`@ControllerAdvice`的实现原理与`@RestControllerAdvice`类似，它也可以指定一个或多个包含`@Controller`注解的类，用于处理控制器中发生的异常和数据绑定。它的主要作用有以下三点：

1.  全局统一异常处理
2.  全局数据绑定
3.  全局模型属性设置

`@ControllerAdvice`实现全局统一异常处理的方式与`@RestControllerAdvice`类似，具体可以参考下面的代码：

@ControllerAdvice
    public class GlobalExceptionHandler {
        
    
        @ExceptionHandler(Exception.class)
        public ModelAndView handleException(Exception ex) {
        
            ModelAndView mav = new ModelAndView("error");
            mav.addObject("message", ex.getMessage());
            return mav;
        }
    }

在上述代码中，我们定义了一个`@ExceptionHandler`方法，用于处理发生在控制器中的任何异常。如果发生异常，将返回一个错误视图，并在视图中展示异常信息。

### 总结 ###

`@ControllerAdvice`是一个非常实用的注解，它可以帮助我们实现全局统一异常处理、全局数据绑定、全局模型属性设置等功能。在本文中，我们深入探究了`@ControllerAdvice`的实现原理，希望对读者有所帮助。