@ControllerAdvice 攔截異常並統一處理
在spring 3.2中，新增了@ControllerAdvice 註解，可以用於定義@ExceptionHandler、@InitBinder、@ModelAttribute，並應用到所有@RequestMapping中。參考：@ControllerAdvice 文檔
一、介紹
創建 MyControllerAdvice，並添加 @ControllerAdvice註解。
package com.sam.demo.controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.*;
import java.util.HashMap;
import java.util.Map;
/**
* controller 增強器
* @author sam
* @since 2017/7/17
*/
@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 獲取，如下：
@RequestMapping("/home")
public String home(ModelMap modelMap) {
System.out.println(modelMap.get("author"));
}
//或者 通過@ModelAttribute獲取
@RequestMapping("/home")
public String home(@ModelAttribute("author") String author) {
System.out.println(author);
}
@ExceptionHandler 攔截了異常，我們可以通過該註解實現自定義異常處理。其中，@ExceptionHandler 配置的 value 指定需要攔截的異常類型，上面攔截了 Exception.class 這種異常。
二、自定義異常處理（全局異常處理）
spring boot 默認情況下會映射到 /error 進行異常處理，但是提示並不十分友好，下面自定義異常處理，提供友好展示。
1、編寫自定義異常類：
package com.sam.demo.custom;
/**
* @author sam
* @since 2017/7/17
*/
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 異常纔會進行事務回滾。
2、編寫全局異常處理類
創建 MyControllerAdvice.java，如下：
package com.sam.demo.controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.*;
import java.util.HashMap;
import java.util.Map;
/**
* controller 增強器
*
* @author sam
* @since 2017/7/17
*/
@ControllerAdvice
public class MyControllerAdvice {
/**
* 全局異常捕捉處理
* @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;
}
/**
* 攔截捕捉自定義異常 MyException.class
* @param ex
* @return
*/
@ResponseBody
@ExceptionHandler(value = MyException.class)
public Map myErrorHandler(MyException ex) {
Map map = new HashMap();
map.put("code", ex.getCode());
map.put("msg", ex.getMsg());
return map;
}
}
3、controller中拋出異常進行測試。
@RequestMapping("/home")
public String home() throws Exception {
// throw new Exception("Sam 錯誤");
throw new MyException("101", "Sam 錯誤");
}
啓動應用，訪問：http://localhost:8080/home ，正常顯示以下json內容，證明自定義異常已經成功被攔截。
{"msg":"Sam 錯誤","code":"101"}
* 如果不需要返回json數據，而要渲染某個頁面模板返回給瀏覽器，那麼MyControllerAdvice中可以這麼實現：
@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;
}
在 templates 目錄下，添加 error.ftl（這裏使用freemarker） 進行渲染：
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>錯誤頁面</title>
</head>
<body>
<h1>${code}</h1>
<h1>${msg}</h1>
</body>
</html>
重啓應用，http://localhost:8080/home 顯示自定的錯誤頁面內容。
補充：如果全部異常處理返回json，那麼可以使用 @RestControllerAdvice 代替 @ControllerAdvice ，這樣在方法上就可以不需要添加 @ResponseBody。