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;

}