SpringBoot 之@ControllerAdvice 拦截异常并统一处理

SpringBoot 之@ControllerAdvice 拦截异常并统一处理
在spring 3.2中，新增了@ControllerAdvice 注解，能够用于定义@ExceptionHandler、@InitBinder、@ModelAttribute，并应用到全部@RequestMapping中。参考：@ControllerAdvice 文档

1、介绍

建立MyControllerAdvice

[Java] 纯文本查看 复制代码
?
01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
/**

• cloudyChen

*/
@ControllerAdvice
public class MyControllerAdvice {

/**
 * 应用到全部@RequestMapping注解方法，在其执行以前初始化数据绑定器
 * @param binder
 */
@InitBinder
public void initBinder(WebDataBinder binder) {}

/**
 * 把值绑定到Model中，使全局@RequestMapping能够获取到该值
 * @param model
 */
@ModelAttribute
public void addAttributes(Model model) {
    model.addAttribute("author", "Magical Sam");
}

/**
 * 全局异常捕捉处理
 * @param ex
 * @return
 */
@ResponseBody
@ExceptionHandler(value = Exception.class)
public Map errorHandler(Exception ex) {
    Map map = new HashMap();
    map.put("code", 100);
    map.put("msg", ex.getMessage());
    return map;
}

}

启动应用后，被 @ExceptionHandler、@InitBinder、@ModelAttribute 注解的方法，都会做用在 被 @RequestMapping 注解的方法上。
@ModelAttribute：在Model上设置的值，对于全部被 @RequestMapping 注解的方法中，均可以经过 ModelMap 获取，以下：

@ExceptionHandler 拦截了异常，咱们能够经过该注解实现自定义异常处理。其中，@ExceptionHandler 配置的 value 指定须要拦截的异常类型，上面拦截了 Exception.class 这种异常。

2、自定义异常处理（全局异常处理）

spring boot 默认状况下会映射到 /error 进行异常处理，可是提示并不十分友好，下面自定义异常处理，提供友好展现。

编写自定义异常类：

[Java] 纯文本查看 复制代码
?
01
02
03
04
05
06
07
08
09
10
11
public class MyException extends RuntimeException {

public MyException(String code, String msg) {
    this.code = code;
    this.msg = msg;
}

private String code;
private String msg;

// getter & setter

}
注：spring 对于 RuntimeException 异常才会进行事务回滚。

启动应用，访问：http://localhost:8080/home ，正常显示如下json内容，证实自定义异常已经成功被拦截。
{"msg":"Sam 错误","code":"101"}
若是不须要返回json数据，而要渲染某个页面模板返回给浏览器，那么MyControllerAdvice中能够这么实现：
[Java] 纯文本查看 复制代码
?
1
2
3
4
5
6
7
8
@ExceptionHandler(value = MyException.class)
public ModelAndView myErrorHandler(MyException ex) {

ModelAndView modelAndView = new ModelAndView();
modelAndView.setViewName("error");
modelAndView.addObject("code", ex.getCode());
modelAndView.addObject("msg", ex.getMsg());
return modelAndView;

}