我們在做Web應用的時候，請求處理過程中發生錯誤是非常常見的情況。Spring Boot提供了一個預設的映射： /error
，當進行中抛出異常之後，會轉到該請求中處理，并且該請求有一個全局的錯誤頁面用來展示異常内容。
選擇一個之前實作過的Web應用（
Chapter3-1-2 ）為基礎，啟動該應用，通路一個不存在的URL，或是修改處理内容，直接抛出異常，如：@RequestMapping("/hello")
public String hello() throws Exception {
throw new Exception("發生錯誤");
} 此時，可以看到類似下面的報錯頁面，該頁面就是Spring Boot提供的預設error映射頁面。
統一異常處理
雖然，Spring Boot中實作了預設的error映射，但是在實際應用中，上面你的錯誤頁面對使用者來說并不夠友好，我們通常需要去實作我們自己的異常提示。
下面我們以之前的Web應用例子為基礎（
），進行統一異常處理的改造。
- 建立全局異常處理類：通過使用
@ControllerAdvice
@ExceptionHandler
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
<!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
，可以看到如下錯誤提示頁面。
通過實作上述内容之後，我們隻需要在
Controller
中抛出
Exception
，當然我們可能會有多種不同的
Exception
。然後在
@ControllerAdvice
類中，根據抛出的具體
Exception
類型比對
@ExceptionHandler
中配置的異常類型來比對錯誤映射和處理。
https://blog.didispace.com/springbootexception/#%E8%BF%94%E5%9B%9EJSON%E6%A0%BC%E5%BC%8F 傳回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
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的文檔。
https://blog.didispace.com/springbootexception/#%E4%BB%A3%E7%A0%81%E7%A4%BA%E4%BE%8B 代碼示例
本文的相關例子可以檢視下面倉庫中的
chapter3-1-6
目錄：