SpringBoot之統一異常處理

阿新 • • 發佈：2019-01-17

我們在做Web應用的時候，請求處理過程中發生錯誤是非常常見的情況。

Spring Boot提供了一個預設的對映：/error，當處理中丟擲異常之後，會轉到該請求中處理，並且該請求有一個全域性的錯誤頁面用來展示異常內容。

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=自定義的錯誤頁面

通過實現上述內容之後，我們只需要在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<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

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;
    }

}

{
    code: 100，
    data: "Some Data"，
    message: "發生錯誤2"，
    url: "http://localhost:8080/json"
}

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

轉載於http://blog.didispace.com/springbootexception/

SpringBoot之統一異常處理

返回JSON格式

SpringBoot之統一異常處理

SpringBoot初始教程之統一異常處理(三)

SpringBoot進階之統一異常處理（含原始碼）

springboot(九)--統一異常處理(500)、錯誤頁處理(404)

Springboot（統一異常處理）

《SpringBoot從入門到放棄》之第（五）篇——統一異常處理

SpringBoot進階之web進階3~統一異常處理

springboot 統一異常處理

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

springboot統一異常處理

spring 或 springboot統一異常處理

SpringBoot統一異常處理及統一回復介面

SpringMVC之全域性異常處理 ——統一返回格式（自定義異常）

第六篇：SpringBoot統一異常處理

SpringBoot表單驗證、AOP處理請求和統一異常處理

springboot-表單驗證|AOP|統一異常處理

Springboot統一異常處理並儲存到資料庫

Springboot(10)輕鬆搞定統一異常處理

springboot統一異常處理方法

服務閘道器zuul之三：zuul統一異常處理

SpringBoot之統一異常處理

返回JSON格式

相關推薦