企業分佈式微服務雲SpringCloud SpringBoot mybatis （五）Spring Boot中Web應用的統一異常處理

咱們在作Web應用的時候，請求處理過程當中發生錯誤是很是常見的狀況。Spring Boot提供了一個默認的映射：/error，當處理中拋出異常以後，會轉到該請求中處理，而且該請求有一個全局的錯誤頁面用來展現異常內容。

選擇一個以前實現過的Web應用（Chapter3-1-2）爲基礎，啓動該應用，訪問一個不存在的URL，或是修改處理內容，直接拋出異常，如：

@RequestMapping("/hello") public String hello() throws Exception { throw new Exception("發生錯誤"); } 此時，能夠看到相似下面的報錯頁面，該頁面就是Spring Boot提供的默認error映射頁面。

alt=默認的錯誤頁面alt=默認的錯誤頁面

統一異常處理

雖然，Spring Boot中實現了默認的error映射，可是在實際應用中，上面你的錯誤頁面對用戶來講並不夠友好，咱們一般須要去實現咱們本身的異常提示。

下面咱們以以前的Web應用例子爲基礎（Chapter3-1-2），進行統一異常處理的改造。

建立全局異常處理類：經過使用@ControllerAdvice定義統一的異常處理類，而不是在每一個Controller中逐個定義。@ExceptionHandler用來定義函數針對的異常類型，最後將Exception對象和請求URL映射到error.html中 @ControllerAdvice class GlobalExceptionHandler {

public static final String DEFAULT_ERROR_VIEW = "error";

@ExceptionHandler(value = Exception.class)
public ModelAndView defaultErrorHandler(HttpServletRequest req, Exception e) throws Exception {
    ModelAndView mav = new ModelAndView();
    mav.addObject("exception", e);
    mav.addObject("url", req.getRequestURL());
    mav.setViewName(DEFAULT_ERROR_VIEW);
    return mav;
}
複製代碼

}

實現error.html頁面展現：在templates目錄下建立error.html，將請求的URL和Exception對象的message輸出。

Error Handler

啓動該應用，訪問：http://localhost:8080/hello，能夠看到以下錯誤提示頁面。

alt=自定義的錯誤頁面alt=自定義的錯誤頁面

經過實現上述內容以後，咱們只須要在Controller中拋出Exception，固然咱們可能會有多種不一樣的Exception。而後在@ControllerAdvice類中，根據拋出的具體Exception類型匹配@ExceptionHandler中配置的異常類型來匹配錯誤映射和處理。

返回JSON格式

在上述例子中，經過@ControllerAdvice統必定義不一樣Exception映射到不一樣錯誤處理頁面。而當咱們要實現RESTful API時，返回的錯誤是JSON格式的數據，而不是HTML頁面，這時候咱們也能輕鬆支持。

本質上，只需在@ExceptionHandler以後加入@ResponseBody，就能讓處理函數return的內容轉換爲JSON格式。

下面以一個具體示例來實現返回JSON格式的異常處理。

建立統一的JSON返回對象，code：消息類型，message：消息內容，url：請求的url，data：請求返回的數據 public class ErrorInfo {

public static final Integer OK = 0;
public static final Integer ERROR = 100;

private Integer code;
private String message;
private String url;
private T data;

// 省略getter和setter
複製代碼

}

建立一個自定義異常，用來實驗捕獲該異常，並返回json public class MyException extends Exception {

public MyException(String message) {
    super(message);
}
複製代碼

}

Controller中增長json映射，拋出MyException異常 @Controller public class HelloController {

@RequestMapping("/json")
public String json() throws MyException {
    throw new MyException("發生錯誤2");
}
複製代碼

}

爲MyException異常建立對應的處理 @ControllerAdvice public class GlobalExceptionHandler {

@ExceptionHandler(value = MyException.class)
@ResponseBody
public ErrorInfo<String> jsonErrorHandler(HttpServletRequest req, MyException e) throws Exception {
    ErrorInfo<String> r = new ErrorInfo<>();
    r.setMessage(e.getMessage());
    r.setCode(ErrorInfo.ERROR);
    r.setData("Some Data");
    r.setUrl(req.getRequestURL().toString());
    return r;
}
複製代碼

}

啓動應用，訪問：http://localhost:8080/json，能夠獲得以下返回內容： { code: 100， data: "Some Data"， message: "發生錯誤2"， url: "http://localhost:8080/json" }

至此，已完成在Spring Boot中建立統一的異常處理，實際實現仍是依靠Spring MVC的註解，更多更深刻的使用可參考Spring MVC的文檔。

源碼來源：http://minglisoft.cn/honghu/technology.html