控制器建议

通常,@ExceptionHandler@InitBinder@ModelAttribute 方法应用于声明它们的 @Controller 类(或类层次结构)中。如果希望这些方法更全局地应用(跨控制器),可以在使用 @ControllerAdvice@RestControllerAdvice 注解的类中声明它们。

@ControllerAdvice 使用 @Component 注解,这意味着这些类可以通过 组件扫描 注册为 Spring bean。@RestControllerAdvice 是一个组合注解,它同时使用 @ControllerAdvice@ResponseBody 注解,这意味着 @ExceptionHandler 方法通过消息转换(而不是视图解析或模板渲染)呈现到响应主体中。

在启动时,用于@RequestMapping@ExceptionHandler方法的基础设施类会检测到用@ControllerAdvice注解的Spring Bean,然后在运行时应用它们的方法。全局@ExceptionHandler方法(来自@ControllerAdvice)在本地方法(来自@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])
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 {}

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