在spring 3.2中，新增了@ControllerAdvice 注解，可以用于定義@ExceptionHandler、@InitBinder、@ModelAttribute，并應用到所有@RequestMapping中。參考：@ControllerAdvice 文檔
一、介紹
建立 MyControllerAdvice，并添加 @ControllerAdvice注解。
第一種，傳回map
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
* @since
*/
@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;
}
}
第二種,傳回ModelAndView
import com.cngrain.gateway.util.ErrorResult;
import org.apache.commons.lang.exception.ExceptionUtils;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import java.util.Date;
/**
* @類名 GlobalExceptionHandler
* @描述 全局異常捕獲
* @作者
* @日期
**/
@ControllerAdvice
public class GlobalExceptionHandler {
public static final String DEFAULT_ERROR_VIEW = "error";
/**
* @名稱 defaultErrorHandler
* @描述
* 我們隻需要在Controller中抛出Exception，當然我們可能會有多種不同的Exception。
* 然後在@ControllerAdvice類中，根據抛出的具體Exception類型比對@ExceptionHandler
* 中配置的異常類型來比對錯誤映射和處理。
* @參數 [request, e]
* @傳回值 org.springframework.web.servlet.ModelAndView
* @作者
* @時間
*/
@ExceptionHandler(value = Exception.class)
public ModelAndView defaultErrorHandler(HttpServletRequest request, Exception e) throws Exception {
ModelAndView mav = new ModelAndView();
mav.addObject("exception", e);
mav.addObject("url", request.getRequestURL());
mav.setViewName(DEFAULT_ERROR_VIEW);
return mav;
}
/**
* @名稱 jsonErrorHandler
* @描述
* 通過@ControllerAdvice統一定義不同Exception映射到不同錯誤處理頁面。
* 而當我們要實作RESTful API時，傳回的錯誤是JSON格式的資料，而不是HTML頁面，這時候我們也能輕松支援。
* 本質上，隻需在@ExceptionHandler之後加入@ResponseBody，就能讓處理函數return的内容轉換為JSON格式。
* @參數 [request, e]
* @傳回值 com.cngrain.gateway.exception.ErrorInfo<java.lang.String>
* @作者
* @時間
*/
@ExceptionHandler(value = MyException.class)
@ResponseBody
public ErrorInfo<String> jsonErrorHandler(HttpServletRequest request, MyException e) throws Exception {
ErrorInfo<String> r = new ErrorInfo<>();
r.setMessage(e.getMessage()==null?"空":e.getMessage());
r.setCode(ErrorInfo.ERROR);
r.setData("Some Data");
r.setUrl(request.getRequestURL().toString());
return r;
}
private ErrorResult buildError(Exception exception) {
ErrorResult error = new ErrorResult();
error.setType(exception.getClass().getName());
error.setMessage(ExceptionUtils.getMessage(exception)==null?"空":ExceptionUtils.getMessage(exception));
error.setStackTrace(ExceptionUtils.getStackTrace(exception));
error.setDate(new Date());
return error;
}
}
啟動應用後，被 @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、編寫自定義異常類：
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、編寫全局異常處理類
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;
@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内容，證明自定義異常已經成功被攔截。
*** 如果不需要傳回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。
![Java小案例——随機數猜測随機數猜測[圖]](data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs=)