控制器建议

查看 Reactive 堆栈中的等效项

@ExceptionHandler、@InitBinder 和 @ModelAttribute 方法仅适用于声明它们的 @Controller 类或类层次结构。如果它们是在 @ControllerAdvice 或 @RestControllerAdvice 类中声明的，那么它们将应用于任何控制器。此外，从 5.3 开始，@ControllerAdvice 中的 @ExceptionHandler 方法可用于处理来自任何 @Controller 或任何其他处理程序的异常。

@ControllerAdvice 使用 @Component 进行元注解，因此可以通过 组件扫描 注册为 Spring bean。@RestControllerAdvice 使用 @ControllerAdvice 和 @ResponseBody 进行元注解，这意味着 @ExceptionHandler 方法将通过响应主体消息转换来呈现其返回值，而不是通过 HTML 视图。

在启动时，RequestMappingHandlerMapping 和 ExceptionHandlerExceptionResolver 会检测控制器建议 bean 并将其应用于运行时。来自 @ControllerAdvice 的全局 @ExceptionHandler 方法应用于来自 @Controller 的局部方法之后。相反，全局 @ModelAttribute 和 @InitBinder 方法应用于局部方法之前。

@ControllerAdvice 注解具有属性，可让您缩小其应用于的控制器和处理程序集。例如

  • Java

  • Kotlin

// Target all Controllers annotated with @RestController
@ControllerAdvice(annotations = RestController.class)
public class ExampleAdvice1 {}

// Target all Controllers within specific packages
@ControllerAdvice("org.example.controllers")
public class ExampleAdvice2 {}

// Target all Controllers assignable to specific classes
@ControllerAdvice(assignableTypes = {ControllerInterface.class, AbstractController.class})
public class ExampleAdvice3 {}
// Target all Controllers annotated with @RestController
@ControllerAdvice(annotations = [RestController::class])
class ExampleAdvice1

// Target all Controllers within specific packages
@ControllerAdvice("org.example.controllers")
class ExampleAdvice2

// Target all Controllers assignable to specific classes
@ControllerAdvice(assignableTypes = [ControllerInterface::class, AbstractController::class])
class ExampleAdvice3

上述示例中的选择器在运行时进行评估，如果广泛使用，可能会对性能产生负面影响。有关更多详细信息，请参阅 @ControllerAdvice javadoc。