spring-boot實戰【07】【轉】：Spring Boot中Web應用的統一異常處理
我們在做Web應用的時候，請求處理過程中發生錯誤是非常常見的情況。Spring Boot提供了一個默認的映射：/error，當處理中拋出異常之後，會轉到該請求中處理，並且該請求有一個全局的錯誤頁面用來展示異常內容。
選擇一個之前實現過的Web應用（Chapter3-1-2）為基礎，啟動該應用，訪問一個不存在的URL，或是修改處理內容，直接拋出異常，如：
| 1 2 3 4 | public String hello() throws Exception { throw new Exception("發生錯誤"); } |
此時，可以看到類似下面的報錯頁面，該頁面就是Spring Boot提供的默認error映射頁面。
alt=默認的錯誤頁面
統一異常處理
雖然，Spring Boot中實現了默認的error映射，但是在實際應用中，上面你的錯誤頁面對用戶來說並不夠友好，我們通常需要去實現我們自己的異常提示。
下面我們以之前的Web應用例子為基礎（Chapter3-1-2），進行統一異常處理的改造。
- 創建全局異常處理類：通過使用
@ControllerAdvice定義統一的異常處理類，而不是在每個Controller中逐個定義。@ExceptionHandler用來定義函數針對的異常類型，最後將Exception對象和請求URL映射到error.html中
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
class GlobalExceptionHandler {
public static final String DEFAULT_ERROR_VIEW = "error";
public ModelAndView defaultErrorHandler(HttpServletRequest req, Exception e) throws Exception {
ModelAndView mav = new ModelAndView();
mav.addObject("exception", e); |
- 實現
error.html頁面展示：在templates目錄下創建error.html，將請求的URL和Exception對象的message輸出。
| 1 2 3 4 5 6 7 8 9 10 11 12 | <html> <head lang="en"> <meta charset="UTF-8" /> <title>統一異常處理</title> </head> <body> <h1>Error Handler</h1> <div th:text="${url}"></div> <div th:text="${exception.message}"></div> </body> </html> |
啟動該應用，訪問：http://localhost:8080/hello，可以看到如下錯誤提示頁面。
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：請求返回的數據
| 1 2 3 4 5 6 7 8 9 10 11 12 13 | public class ErrorInfo<T> { 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
| 1 2 3 4 5 6 7 | public class MyException extends Exception { public MyException(String message) { super(message); } } |
Controller中增加json映射，拋出MyException異常
| 1 2 3 4 5 6 7 8 9 | public class HelloController { public String json() throws MyException { throw new MyException("發生錯誤2"); } } |
- 為
MyException異常創建對應的處理
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | public class GlobalExceptionHandler { 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，可以得到如下返回內容：
| 1 2 3 4 5 6 | { code: 100， data: "Some Data"， message: "發生錯誤2"， url: "http://localhost:8080/json" } |
至此，已完成在Spring Boot中創建統一的異常處理，實際實現還是依靠Spring MVC的註解，更多更深入的使用可參考Spring MVC的文檔。
本文完整示例：chapter3-1-6
spring-boot實戰【07】【轉】：Spring Boot中Web應用的統一異常處理