一、SpringBoot預設的錯誤處理機制

預設效果：

1）、瀏覽器，返回一個預設的錯誤頁面

瀏覽器傳送請求的請求頭：

2）、如果是其他客戶端，預設響應一個json資料

原理：

可以參照ErrorMvcAutoConfiguration：錯誤處理的自動配置

給容器中添加了以下元件

1、DefaultErrorAttributes：

// 幫我們在頁面共享資訊；
@Override
public Map<String, Object> getErrorAttributes(RequestAttributes requestAttributes,
        boolean includeStackTrace) {
    Map<String
 
, Object> errorAttributes = new LinkedHashMap<String, Object>();
    errorAttributes.put("timestamp", new Date());
    addStatus(errorAttributes, requestAttributes);
    addErrorDetails(errorAttributes, requestAttributes, includeStackTrace);
    addPath(errorAttributes, requestAttributes);
    return
 
 errorAttributes;
}

2、BasicErrorController：處理預設/error請求

@Controller
@RequestMapping("${server.error.path:${error.path:/error}}")
public class BasicErrorController extends AbstractErrorController {

    @RequestMapping(produces = "text/html")//產生html型別的資料；瀏覽器傳送的請求來到這個方法處理
    public ModelAndView errorHtml
 
(HttpServletRequest request,
            HttpServletResponse response) {
        HttpStatus status = getStatus(request);
        Map<String, Object> model = Collections.unmodifiableMap(getErrorAttributes(
                request, isIncludeStackTrace(request, MediaType.TEXT_HTML)));
        response.setStatus(status.value());

        //去哪個頁面作為錯誤頁面；包含頁面地址和頁面內容
        ModelAndView modelAndView = resolveErrorView(request, response, status, model);
        return (modelAndView == null ? new ModelAndView("error", model) : modelAndView);
    }

    @RequestMapping
    @ResponseBody    //產生json資料，其他客戶端來到這個方法處理；
    public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
        Map<String, Object> body = getErrorAttributes(request,
                isIncludeStackTrace(request, MediaType.ALL));
        HttpStatus status = getStatus(request);
        return new ResponseEntity<Map<String, Object>>(body, status);
    }

3、ErrorPageCustomizer：

@Value("${error.path:/error}")
private String path = "/error";//系統出現錯誤以後來到error請求進行處理；（web.xml註冊的錯誤頁面規則）

4、DefaultErrorViewResolver：

@Override
public ModelAndView resolveErrorView(HttpServletRequest request, HttpStatus status,
        Map<String, Object> model) {
    ModelAndView modelAndView = resolve(String.valueOf(status), model);
    if (modelAndView == null && SERIES_VIEWS.containsKey(status.series())) {
        modelAndView = resolve(SERIES_VIEWS.get(status.series()), model);
    }
    return modelAndView;
}

private ModelAndView resolve(String viewName, Map<String, Object> model) {
    //預設SpringBoot可以去找到一個頁面？  error/404
    String errorViewName = "error/" + viewName;

    //模板引擎可以解析這個頁面地址就用模板引擎解析
    TemplateAvailabilityProvider provider = this.templateAvailabilityProviders
            .getProvider(errorViewName, this.applicationContext);
    if (provider != null) {
        //模板引擎可用的情況下返回到errorViewName指定的檢視地址
        return new ModelAndView(errorViewName, model);
    }
    //模板引擎不可用，就在靜態資原始檔夾下找errorViewName對應的頁面：error/404.html
    return resolveResource(errorViewName, model);
}

步驟：

一旦系統出現4xx或者5xx之類的錯誤；ErrorPageCustomizer就會生效（定製錯誤的響應規則），就會來到/error請求；被BasicErrorController處理。

1）響應頁面，去哪個頁面是由DefaultErrorViewResolver解析得到的

protected ModelAndView resolveErrorView(HttpServletRequest request,
    HttpServletResponse response, HttpStatus status, Map<String, Object> model) {
    //所有的ErrorViewResolver得到ModelAndView
    for (ErrorViewResolver resolver : this.errorViewResolvers) {
        ModelAndView modelAndView = resolver.resolveErrorView(request, status, model);
        if (modelAndView != null) {
           return modelAndView;
        }
     }
     return null;
}

二、定製錯誤響應（分為頁面和json資料兩種形式）

如何定製錯誤資訊的頁面

a、有模板引擎的情況下；error/狀態碼；【將錯誤頁面命名為 錯誤狀態碼.html 放在模板引擎資料夾裡面的error資料夾下】，發生此狀態碼的錯誤就會來到 對應的頁面；

我們可以使用4xx和5xx作為錯誤頁面的檔名來匹配這種型別的所有錯誤，精確優先（優先尋找精確的狀態碼.html）；

頁面能獲取的資訊：

    timestamp：時間戳

    status：狀態碼

    error：錯誤提示

    exception：異常物件

    message：異常訊息

    errors：JSR303資料校驗的錯誤都在這裡

b、沒有模板引擎（模板引擎找不到這個錯誤頁面），靜態資原始檔夾下找；

c、以上都沒有錯誤頁面，就是預設來到SpringBoot預設的錯誤提示頁面

如何定製錯誤的json資料

a、自定義異常處理&返回定製json資料（如果只是需要返回自定義錯誤的json格式資料，這種方式即可滿足）

@ControllerAdvice   //這個註解是指這個類是處理其他controller丟擲的異常
public class MyExceptionHandler {
    //這個註解是指當controller中丟擲這個指定的異常類的時候，都會轉到這個方法中來處理異常
    @ExceptionHandler(UserNotExistException.class)
    @ResponseBody  //將返回的物件轉成json資料
    public Map<String,Object> handleException(Exception e){
        Map<String,Object> map = new HashMap<>();
        map.put("code","user.notexist");
        map.put("message",e.getMessage());
        return map;
    }
}
//沒有自適應效果...

b、轉發到/error進行自適應響應效果處理

@ExceptionHandler(UserNotExistException.class)
public String handleException(Exception e, HttpServletRequest request){
    Map<String, Object> map = new HashMap<>();
    //傳入我們自己的錯誤狀態碼  4xx 5xx，否則就不會進入定製錯誤頁面的解析流程
    /**
     * Integer statusCode = (Integer) request
         .getAttribute("javax.servlet.error.status_code");
     */
    request.setAttribute("javax.servlet.error.status_code",500);
    map.put("code", "user.notexist");
    map.put("message", e.getMessage());
    request.setAttribute("extMap", map);
    //轉發到/error
    return "forward:/error";
}

c、將我們的定製資料攜帶出去；

出現錯誤以後，會來到/error請求，會被BasicErrorController處理，響應出去可以獲取的資料是由getErrorAttributes得到的（是AbstractErrorController（ErrorController）規定的方法）；

1. 完全來編寫一個ErrorController的實現類【或者是編寫AbstractErrorController的子類】，放在容器中；
2. 頁面上能用的資料，或者是json返回能用的資料都是通過errorAttributes.getErrorAttributes得到；

容器中DefaultErrorAttributes.getErrorAttributes()，預設進行資料處理的。

自定義ErrorAttributes

//給容器中加入我們自己定義的ErrorAttributes
@Component
public class MyErrorAttributes extends DefaultErrorAttributes {

    @Override
    public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {

        // 獲取SpringBoot處理異常後的異常資訊
        Map<String, Object> map = super.getErrorAttributes(webRequest, includeStackTrace);
        // 可以加入自定義資訊
        map.put("author", "章魚");
        // 還可以從request域中獲取資訊，0代表request，1代表session
        Map<String, Object> extMap = (Map<String, Object>) webRequest.getAttribute("extMap", 0);
        map.put("extMap", extMap);

        return map;
    }
}

最終的效果：響應是自適應的，可以通過定製ErrorAttributes改變需要返回的內容

瀏覽器訪問，返回錯誤頁面：

<h1>status:[[${status}]]</h1>
<h1>timestamp:[[${timestamp}]]</h1>
<h1>message:[[${message}]]</h1>
<h1>MyErrorAttributes中加入的author:[[${author}]]</h1>
<h1>UserNotExistException中加入的extMap.exceptionType:[[${extMap.exceptionType}]]</h1>

其他客戶端訪問，則返回json資料：