spring @ControllerAdvice注解的作用及代码示例

阳光穿透心脏的1/2处 2024-02-18 13:04 19阅读 0赞

`@ControllerAdvice`是一个用于全局异常处理和全局数据绑定的注解，它可以被用于标记一个类，该类被视为全局控制器的增强器。它允许开发者在多个控制器中集中处理异常，并在多个控制器中共享相同的模型数据。

`@ControllerAdvice`的主要作用包括：

1.  全局异常处理：通过在`@ExceptionHandler`注解标记的方法中捕获异常，并对异常进行处理，可以统一处理应用中的异常情况，返回统一的错误响应或者执行其他操作，例如记录日志等。
2.  全局数据绑定：通过在`@ModelAttribute`注解标记的方法中定义全局的模型属性，可以在多个控制器中共享相同的模型数据。

以下是一个使用`@ControllerAdvice`的示例：

@ControllerAdvice
    public class GlobalExceptionHandler {
        
    
        @ExceptionHandler(Exception.class)
        public ResponseEntity<ErrorResponse> handleException(Exception ex) {
        
            // 处理异常并返回自定义的错误响应
            ErrorResponse errorResponse = new ErrorResponse("500", "Internal Server Error");
            return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
        }
    
        @ModelAttribute
        public void addGlobalAttributes(Model model) {
        
            // 添加全局的模型属性
            model.addAttribute("appName", "My Application");
        }
    }

在上述示例中，`GlobalExceptionHandler`类使用`@ControllerAdvice`注解进行标记。它包含了两个方法：

*  `handleException()`方法使用`@ExceptionHandler`注解进行标记，用于捕获`Exception`类型的异常，并返回自定义的错误响应。在这个例子中，我们返回了一个包含错误代码和错误消息的`ErrorResponse`对象，并使用`ResponseEntity`将其封装成HTTP响应。
 *  `addGlobalAttributes()`方法使用`@ModelAttribute`注解进行标记，用于定义全局的模型属性。在这个例子中，我们将一个名为`appName`的属性添加到`Model`对象中，使得它可以在多个控制器中共享。

通过使用`@ControllerAdvice`注解，`GlobalExceptionHandler`类中的异常处理方法和全局模型属性方法会应用于整个应用程序中的所有控制器。

请注意，`@ControllerAdvice`注解还可以通过`basePackages`、`basePackageClasses`和`annotations`属性来指定作用的包或控制器。

希望这个示例能够帮助你理解`@ControllerAdvice`注解的作用和用法。如有更多疑问，请随时提问。