我們?cè)谧鯳eb應(yīng)用的時(shí)候，請(qǐng)求處理過程中發(fā)生錯(cuò)誤是非常常見的情況。Spring Boot提供了一個(gè)默認(rèn)的映射：/error，當(dāng)處理中拋出異常之后，會(huì)轉(zhuǎn)到該請(qǐng)求中處理，并且該請(qǐng)求有一個(gè)全局的錯(cuò)誤頁面用來展示異常內(nèi)容。
選擇一個(gè)之前實(shí)現(xiàn)過的Web應(yīng)用（Chapter3-1-2）為基礎(chǔ)，啟動(dòng)該應(yīng)用，訪問一個(gè)不存在的URL，或是修改處理內(nèi)容，直接拋出異常，如：
@RequestMapping("/hello")
public String hello() throws Exception {
throw new Exception("發(fā)生錯(cuò)誤");
}
此時(shí)，可以看到類似下面的報(bào)錯(cuò)頁面，該頁面就是Spring Boot提供的默認(rèn)error映射頁面。
統(tǒng)一異常處理
雖然，Spring Boot中實(shí)現(xiàn)了默認(rèn)的error映射，但是在實(shí)際應(yīng)用中，上面你的錯(cuò)誤頁面對(duì)用戶來說并不夠友好，我們通常需要去實(shí)現(xiàn)我們自己的異常提示。
下面我們以之前的Web應(yīng)用例子為基礎(chǔ)（Chapter3-1-2），進(jìn)行統(tǒng)一異常處理的改造。
- 創(chuàng)建全局異常處理類：通過使用
@ControllerAdvice定義統(tǒng)一的異常處理類，而不是在每個(gè)Controller中逐個(gè)定義。@ExceptionHandler用來定義函數(shù)針對(duì)的異常類型，最后將Exception對(duì)象和請(qǐng)求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;
}
}
- 實(shí)現(xiàn)
error.html頁面展示：在templates目錄下創(chuàng)建error.html，將請(qǐng)求的URL和Exception對(duì)象的message輸出。
<!DOCTYPE html>
<html>
<head lang="en">
<meta charset="UTF-8" />
<title>統(tǒng)一異常處理</title>
</head>
<body>
<h1>Error Handler</h1>
<div th:text="${url}"></div>
<div th:text="${exception.message}"></div>
</body>
</html>
啟動(dòng)該應(yīng)用，訪問：http://localhost:8080/hello，可以看到如下錯(cuò)誤提示頁面。
通過實(shí)現(xiàn)上述內(nèi)容之后，我們只需要在Controller中拋出Exception，當(dāng)然我們可能會(huì)有多種不同的Exception。然后在@ControllerAdvice類中，根據(jù)拋出的具體Exception類型匹配@ExceptionHandler中配置的異常類型來匹配錯(cuò)誤映射和處理。
返回JSON格式
在上述例子中，通過@ControllerAdvice統(tǒng)一定義不同Exception映射到不同錯(cuò)誤處理頁面。而當(dāng)我們要實(shí)現(xiàn)RESTful API時(shí)，返回的錯(cuò)誤是JSON格式的數(shù)據(jù)，而不是HTML頁面，這時(shí)候我們也能輕松支持。
本質(zhì)上，只需在@ExceptionHandler之后加入@ResponseBody，就能讓處理函數(shù)return的內(nèi)容轉(zhuǎn)換為JSON格式。
下面以一個(gè)具體示例來實(shí)現(xiàn)返回JSON格式的異常處理。
- 創(chuàng)建統(tǒng)一的JSON返回對(duì)象，code：消息類型，message：消息內(nèi)容，url：請(qǐng)求的url，data：請(qǐng)求返回的數(shù)據(jù)
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
}
- 創(chuàng)建一個(gè)自定義異常，用來實(shí)驗(yàn)捕獲該異常，并返回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("發(fā)生錯(cuò)誤2");
}
}
- 為
MyException異常創(chuàng)建對(duì)應(yīng)的處理
@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;
}
}
- 啟動(dòng)應(yīng)用，訪問：http://localhost:8080/json，可以得到如下返回內(nèi)容：
{
code: 100，
data: "Some Data"，
message: "發(fā)生錯(cuò)誤2"，
url: "http://localhost:8080/json"
}
至此，已完成在Spring Boot中創(chuàng)建統(tǒng)一的異常處理，實(shí)際實(shí)現(xiàn)還是依靠Spring MVC的注解，更多更深入的使用可參考Spring MVC的文檔。
本文完整示例：chapter3-1-6
