我們在做Web應用的時候,請求處理過程中發生錯誤是非常常見的情況。Spring Boot提供了一個默認的映射:/error,當處理中拋出異常之後,會轉到該請求中處理,並且該請求有一個全局的錯誤頁面用來展示異常內容。
選擇一個之前實現過的Web應用爲基礎,啓動該應用,訪問一個不存在的URL,或是修改處理內容,直接拋出異常,如:
@RequestMapping("/hello")
public String hello() throws Exception {
throw new Exception("發生錯誤");
}
此時,可以看到類似下面的報錯頁面,該頁面就是Spring Boot提供的默認error映射頁面。
alt=默認的錯誤頁面alt=默認的錯誤頁面
統一異常處理
雖然,Spring Boot中實現了默認的error映射,但是在實際應用中,上面你的錯誤頁面對用戶來說並不夠友好,我們通常需要去實現我們自己的異常提示。
下面我們以之前的Web應用例子爲基礎,進行統一異常處理的改造。
創建全局異常處理類:通過使用@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輸出。
<!DOCTYPE html>
<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=自定義的錯誤頁面alt=自定義的錯誤頁面
通過實現上述內容之後,我們只需要在Controller中拋出Exception,當然我們可能會有多種不同的Exception。然後在@ControllerAdvice類中,根據拋出的具體Exception類型匹配@ExceptionHandler中配置的異常類型來匹配錯誤映射和處理。
完整項目的源碼來源 技術支持1791743380