ControllerAdvice注解的使用

ControllerAdvice

对于@ControllerAdvice，我们比较熟知的用法是结合@ExceptionHandler用于全局异常的处理，但其作用不仅限于此。ControllerAdvice拆分开来就是Controller Advice，关于Advice，前面我们讲解Spring Aop时讲到，其是用于封装一个切面所有属性的，包括切入点和需要织入的切面逻辑。这里ContrllerAdvice也可以这么理解，其抽象级别应该是用于对Controller进行“切面”环绕的，而具体的业务织入方式则是通过结合其他的注解来实现的。@ControllerAdvice是在类上声明的注解，其用法主要有三点：

结合方法型注解@ExceptionHandler，用于捕获Controller中抛出的指定类型的异常，从而达到不同类型的异常区别处理的目的；

结合方法型注解@InitBinder，用于request中自定义参数解析方式进行注册，从而达到自定义指定格式参数的目的；

结合方法型注解@ModelAttribute，表示其标注的方法将会在目标Controller方法执行之前执行。

   从上面的讲解可以看出，@ControllerAdvice的用法基本是将其声明在某个bean上，然后在该bean的方法上使用其他的注解来指定不同的织入逻辑。不过这里@ControllerAdvice并不是使用AOP的方式来织入业务逻辑的，而是Spring内置对其各个逻辑的织入方式进行了内置支持。本文将对@ControllerAdvice的这三种使用方式分别进行讲解。

1. @ExceptionHandler

与@ExceptionHandler配合进行使用，用来对全局异常进行处理。@ExceptionHandler的作用主要在于声明一个或多个类型的异常，当符合条件的Controller抛出这些异常之后将会对这些异常进行捕获，然后按照其标注的方法的逻辑进行处理，从而改变返回的视图信息。如下是@ExceptionHandler的属性结构：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ExceptionHandler {
    // 指定需要捕获的异常的Class类型
	Class[] value() default {};
}


   如下是我们使用@ExceptionHandler捕获RuntimeException异常的例子：

@ControllerAdvice(basePackages = "mvc")
public class SpringControllerAdvice {
  @ExceptionHandler(RuntimeException.class)
  public ModelAndView runtimeException(RuntimeException e) {
    e.printStackTrace();
    return new ModelAndView("error");
  }
}


   这里我们模拟一个访问user/detail的接口，在该接口中抛出了RuntimeException，那么，这里的异常捕获器就会捕获该异常，然后返回默认的error试图。如下是UserController的代码：

@Controller
@RequestMapping("/user")
public class UserController {

  @Autowired
  private UserService userService;

  @RequestMapping(value = "/detail", method = RequestMethod.GET)
  public ModelAndView detail(@RequestParam("id") long id) {
    ModelAndView view = new ModelAndView("user");
    User user = userService.detail(id);
    view.addObject("user", user);
    throw new RuntimeException("mock user detail exception.");
  }
}


   启动上述服务，在浏览器中访问http://localhost:8080/user/detail?id=1之后，可以看到页面展示的是我们定义的异常视图。

我们平时开发中，使用@ControllerAdvice这个功能比较常见。全局处理异常让我们可以规范的返回对前端的数据，而不会将异常返回到前端。

2. 搭配@InitBinder进行请求参数预处理

   对于@InitBinder，该注解的主要作用是绑定一些自定义的参数。一般情况下我们使用的参数通过@RequestParam，@RequestBody或者@ModelAttribute等注解就可以进行绑定了，但对于一些特殊类型参数，比如Date，它们的绑定Spring是没有提供直接的支持的，我们只能为其声明一个转换器，将request中字符串类型的参数通过转换器转换为Date类型的参数，从而供给@RequestMapping标注的方法使用。如下是@InitBinder的声明：
   

   @Target({ElementType.METHOD})
   @Retention(RetentionPolicy.RUNTIME)
   @Documented
   public @interface InitBinder {
   // 这里value参数用于指定需要绑定的参数名称，如果不指定，则会对所有的参数进行适配，
   // 只有是其指定的类型的参数才会被转换
   String[] value() default {};
   }

   @InitBinder唯一的一个属性value,作用是限制对哪些 @RequestMapping 方法起作用,具体筛选条件就是通过@RequestMapping方法入参来筛选，默认不写就代表对所有@RequestMapping的方法起作用;
   
    @InitBinder标注的方法, 方法入参和 @RequestMapping方法入参可选范围一样(这里指的是比如HttpServletRequest、ModelMap这些)， 通常一个入参 WebDataBinder 就够我们使用了； @InitBinder标注的方法返回值, 必须为null，这里我理解的是运行期的返回值;如果运行时返回值不为null,抛出异常 “@InitBinder methods should return void:”，编译时IDEA会提示@InitBinder应该返回null,但是不影响编译通过;
   

如下是使用@InitBinder注册Date类型参数转换器的实现：

@ControllerAdvice(basePackages = "mvc")
public class SpringControllerAdvice {
  @InitBinder
  public void globalInitBinder(WebDataBinder binder) {
    binder.addCustomFormatter(new DateFormatter("yyyy-MM-dd"));
  }
}


   这里@InitBinder标注的方法注册的Formatter在每次request请求进行参数转换时都会调用，用于判断指定的参数是否为其可以转换的参数。如下是我们声明的包含Date类型参数的接口：

@Controller
@RequestMapping("/user")
public class UserController {

  @Autowired
  private UserService userService;

  @RequestMapping(value = "/detail", method = RequestMethod.GET)
  public ModelAndView detail(@RequestParam("id") long id, Date date) {
    System.out.println(date);
    ModelAndView view = new ModelAndView("user");
    User user = userService.detail(id);
    view.addObject("user", user);
    return view;
  }
}


   在浏览器输入http://localhost:8080/user/detail?id=1&date=2018-10-2，可以看到控制台进行了如下打印：

Tue Oct 02 00:00:00 CST 2018

   可以看到，这里我们对request参数进行了转换，并且在接口中成功接收了该参数。

3. @ModelAttribute

绑定请求参数到实体对象（表单的命令对象）

@RequestMapping("/register")
public String register(@ModelAttribute("user") UserForm user) {
    if ("zhangsan".equals(uname) && "123456".equals(upass)) {
        logger.info("成功");
        return "login";
    } else {
        logger.info("失败");
        return "register";
}

在上述代码中“@ModelAttribute（“user”）UserForm user”语句的功能有两个：

• 将请求参数的输入封装到 user 对象中。
• 创建 UserForm 实例。

以“user”为键值存储在 Model 对象中，和“model.addAttribute（“user”，user）”语句的功能一样。如果没有指定键值，即“@ModelAttribute UserForm user”，那么在创建 UserForm 实例时以“userForm”为键值存储在 Model 对象中，和“model.addAtttribute（“userForm”, user）”语句的功能一样。

注解一个非请求处理方法

关于@ModelAttribute的用法，处理用于接口参数可以用于转换对象类型的属性之外，其还可以用来进行方法的声明。如果声明在方法上，并且结合@ControllerAdvice，该方法将会在@ControllerAdvice所指定的范围内的所有接口方法执行之前执行，并且@ModelAttribute标注的方法的返回值还可以供给后续会调用的接口方法使用。如下是@ModelAttribute注解的声明：

@Target({ElementType.PARAMETER, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ModelAttribute {

    // 该属性与name属性的作用一致，用于指定目标参数的名称
	@AliasFor("name")
	String value() default "";

	@AliasFor("value")
	String name() default "";

    // 与name属性一起使用，如果指定了binding为false，那么name属性指定名称的属性将不会被处理
	boolean binding() default true;
}


   这里@ModelAttribute的各个属性值主要是用于其在接口参数上进行标注时使用的，如果是作为方法注解，被 @ModelAttribute 注解的方法将在每次调用该控制器类的请求处理方法前被调用。这种特性可以用来控制登录权限，当然控制登录权限的方法有很多，例如拦截器、过滤器等。

使用该特性控制登录权限，创建 BaseController，代码如下所示：

@ControllerAdvice(basePackages = "mvc")
public class SpringControllerAdvice {

  @ModelAttribute(value = "message")
  public String globalModelAttribute() {
    System.out.println("global model attribute.");
    return "this is from model attribute";
  }
}

4. 小结

   本文首先讲解了@ControllerAdvice注解的作用，然后结合@ControllerAdvice讲解了能够与其结合的三个注解的使用方式。关于这三种使用方式，需要说明的是，这三种注解如果应用于@ControllerAdvice注解所标注的类中，那么它们表示会对@ControllerAdvice所指定的范围内的接口都有效；如果单纯的将这三种注解应用于某个Controller中，那么它们将只会对该Controller中所有的接口有效，并且此时是不需要在该Controller上标注@ControllerAdvice的。