SpringCloud SpringBoot mybatis分散式Web應用的統一異常處理

happywawa發表於2019-03-19
GCCloudSpring BootMyBatis分散式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應用例子為基礎，進行統一異常處理的改造。

  • 建立全域性異常處理類：通過使用@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


相關文章