原文：Spring Boot 系列（八）@ControllerAdvice 攔截異常並統一處理
在spring 3.2中，新增了@ControllerAdvice 註解，能夠用於定義@ExceptionHandler、@InitBinder、@ModelAttribute，並應用到全部@RequestMapping中。參考：@ControllerAdvice 文檔
1、介紹
建立 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 這種異常。
2、自定義異常處理（全局異常處理）
spring boot 默認狀況下會映射到 /error 進行異常處理，可是提示並不十分友好，下面自定義異常處理，提供友好展現。html
一、編寫自定義異常類：
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 異常纔會進行事務回滾。
二、編寫全局異常處理類
建立 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; } }
三、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>