注解@ControllerAdvice,从名字看它就是一个增强的 Controller。使用这个 Controller,可以实现两个常用的功能:
- 全局异常处理
- 全局数据绑定
灵活使用这两个功能,可以简化我们很多工作,这是 SpringMVC 提供的功能,也可以使用在 Spring Boot 中。
一.全局异常处理
使用 @ControllerAdvice 实现全局异常处理,只需要定义类,添加该注解即可:
@ControllerAdvice
public class GlobalExceptionHandler {
/*全局异常处理
*@ExceptionHandler:注解用来指明异常的处理类型,如果这里指定为 NullpointerException,则数组越界异常就不会进到这个方法中;
*/
@ExceptionHandler(value=Exception.class)
public ModelAndView defaultErrorHandler(HttpServletRequest req,Exception e) {
ModelAndView mav= new ModelAndView();
mav.addObject("url", req.getRequestURI());
mav.addObject("exception", e);
mav.setViewName("errorPage");
return mav;
}
}
在该类中,可以定义多个方法,不同的方法处理不同的异常,比如处理空指针的方法、处理数组越界的方法等等,也可以在一个方法中处理所有的异常信息。定义完成后,在任意一个controller接口中出现异常都会被处理:
@Controller
public class Hello3Controller {
@RequestMapping("/hello3")
public String hello3(Model m) {
//获取当前时间
m.addAttribute("now", DateFormat.getDateTimeInstance().format(new Date()));
//添加除零异常
System.out.println(1/0);
return "hello3";
}
}
二.全局数据绑定
全局数据绑定功能可以用来做一些初始化的数据操作,我们可以将一些公共的数据定义在添加了 @ControllerAdvice 注解的类中,在每一个 Controller 的接口中,就都能够访问导致这些数据。
@ControllerAdvice
public class GlobalExceptionHandler {
/*全局数据绑定
* @ModelAttribute 注解标记该方法的返回数据是一个全局数据, name 属性去重新指定 key
* */
@ModelAttribute(name="test")
public Map<String,String> commonData() {
Map<String,String> map=new HashMap<String, String>();
map.put("name", "张三");
map.put("age", "20");
return map;
}
}
使用 @ModelAttribute 注解标记该方法的返回数据是一个全局数据,默认情况下,这个全局数据的 key 就是返回的变量名,value 就是方法返回值,当然开发者可以通过 @ModelAttribute 注解的 name 属性自定义 key。定义完成后,在任何一个Controller 的接口中,都可以获取到这里定义的数据:
@Controller
public class Hello3Controller {
@RequestMapping("/hello3")
public String hello3(Model m) {
//获取当前时间
m.addAttribute("now", DateFormat.getDateTimeInstance().format(new Date()));
//添加除零异常
//System.out.println(1/0);
//全局数据绑定
Map<String, Object> map = m.asMap();
System.out.println(map);
//结果:{test={name=张三, age=20}, now=2020-2-7 15:23:00}
return "hello3";
}
}