Spring Boot教程(11) – 理解注解@ControllerAdvice

之前,我们介绍过@ModelAttribute@ExceptionHandler,前者可以往请求的Model里加数据,后者可以接受请求处理方法抛出的异常。但是他们放在控制器(Controller)里的时候,作用范围是有限的,只管当前控制器里的方法。如果你有几百个控制器,在每个控制器里都加上类似的代码,不免有点冗余和费劲儿。Spring框架提供了@ControllerAdvice注解,帮助你将其应用到所有的控制器上。

Controller Advice字面上意思是“控制器通知”,Advice除了“劝告”、“意见”之外,还有“通知”的意思。你可以将@ModelAttribute@ExceptionHandler标记的方法提取出来,放到一个类里,并将加上@ControllerAdvice,这样,所有的控制器都可以用了:

因为@ControllerAdvice被元注解@Component标记,所以它也是可以被组件扫描扫到并放入Spring容器的。

如果你只想对一部分控制器添加通知,比如某个包下的控制器,可以这样写:

如果你不想把包名写死,不如把包里的某个类传进去,这样包名重构了也不怕:

如果你只想对某几个控制器添加通知,可以这样写:

挺简单的是不是?

通知里的@ModelAttribute方法会先于控制器里执行。通知里的@ExceptionHandler方法优先级会低于控制器里的。仔细想想就能明白,局部的要优先于全局的。

控制器通知还有一个兄弟,@RestControllerAdvice,如果用了它,错误处理方法的返回值不会表示用的哪个视图,而是会作为HTTP body处理,即相当于错误处理方法加了@ResponseBody注解。

发表评论

电子邮件地址不会被公开。