1、默認錯誤處理機制

1.1 現(xiàn)象描述

當我們使用瀏覽器訪問一個路徑出現(xiàn)錯誤時，SpringBoot會彈出一個ErrorPage：

當我們使用的是非瀏覽器的客戶端來訪問一個路徑出現(xiàn)錯誤，會返回一個JSON字符串：

springboot根據(jù)訪問者的request中的Accept屬性來判斷要返回什么樣的數(shù)據(jù)，如果是瀏覽器，該屬性如下：

如果不是瀏覽器，該屬性如下：

也就是說，SpringBoot存在一個錯誤處理機制，會根據(jù)不同請求返回不同的結(jié)果。

1.2 原理解析

SpringBoot中存在一個專門處理錯誤情況的配置類ErrorMvcAutoConfiguration，這跟我們前面分析自動配置類沒什么太大的區(qū)別。 進入這個配置類，配置類中配置了一個BasicErrorController對象：

@Bean
@ConditionalOnMissingBean(value = ErrorController.class, search = SearchStrategy.CURRENT)
public BasicErrorController basicErrorController(ErrorAttributes errorAttributes, ObjectProvider<ErrorViewResolver> errorViewResolvers) {
	return new BasicErrorController(errorAttributes, this.serverProperties.getError(), errorViewResolvers.orderedStream().collect(Collectors.toList()));
}

這個BasicErrorController部分截圖如下：

BasicErrorController是SpringBoot專門處理錯誤請求的控制器，當出現(xiàn)錯誤情況時，會訪問/error路徑，就進入到這個控制器了。 BasicErrorController有兩個核心方法：

一個帶produces屬性，一個不帶。帶produces屬性的表示產(chǎn)生html類型的數(shù)據(jù)；瀏覽器發(fā)送的請求來到這個方法處理。不帶這個屬性的產(chǎn)生json數(shù)據(jù)，其他客戶端來到這個方法處理； errorHtml方法和error方法邏輯相似，都是根據(jù)request來生成返回數(shù)據(jù)，前者生成一個視圖，后者生成一個response。 既然errorHtml方法是返回ModelAndView，那么就存在一個生成錯誤頁面的視圖解析器。我們回到自動配置類ErrorMvcAutoConfiguration，里面找到DefaultErrorViewResolver：

我們繼續(xù)看它是怎么默認生成錯誤頁面視圖的，里面有個視圖解析方法。

1.3 原理小結(jié)

SpringBoot有一個處理錯誤情況的機制，當訪問的頁面出現(xiàn)錯誤時：

1、BasicErrorController控制器判斷訪問來源是瀏覽器還是其他客戶端來決定進入errorHtml方法還是error方法；

2、如果是瀏覽器，則生成視圖，然后交給默認視圖解析器DefaultErrorAttributes處理；處理過程就是：如果模板引擎可用，就訪問模板路徑下的/error相關(guān)頁面；如果模板引擎不可用，就訪問靜態(tài)資源路徑下的/error相關(guān)頁面。

3、如果是非瀏覽器客戶端，就生成json數(shù)據(jù)封裝到response返回。

2、定制錯誤響應

2.1 定制錯誤頁面

上面分析出SpringBoot會找模板引擎下的/error路徑，但是我們初始項目并沒有這個路徑，其實是框架內(nèi)置了一個空白頁面，就是一開始我們看到的默認頁面。當我們創(chuàng)建了/error目錄，并在里面放了以錯誤碼命名的html頁面，那么SpringBoot就會去找我們定制的錯誤頁面。 上面說到，SpringBoot有一個專門處理錯誤頁面的控制器BasicErrorController，處理瀏覽器的是errorHtml方法，該方法在生成視圖時，調(diào)用了getErrorAttributes方法：

這個方法返回一個ErrorAttributes對象：

ErrorAttributes是一個接口，SpringBoot有一個默認實現(xiàn)類DefaultErrorAttributes實現(xiàn)了該接口，里面對getErrorAttributes也有默認實現(xiàn)方法：

也就是說，有模板引擎情況下，我們定制了錯誤頁面后，以狀態(tài)碼為命名，例如：404.html，然后我們自定義的錯誤頁面可以獲得時間戳、狀態(tài)碼、錯誤信息等數(shù)據(jù)。 當沒有模板引擎時，會在靜態(tài)資源文件夾下找。如果靜態(tài)資源文件夾也沒有/error文件夾，那么就會來到一開始我們看到的那個空白頁面：

2.2 定制錯誤json數(shù)據(jù)

當是客戶端訪問出現(xiàn)錯誤時，是由控制器BasicErrorController的error方法來處理：

我們進入這個ResponseEntity對象不斷往下挖，直到看到：

其實就是給header復制而已。 我們自定義一個異常處理類：

@ControllerAdvice
public class MyExceptionHandler {
    @ResponseBody
    @ExceptionHandler(UserNotExistException.class)
    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;
    }
}

注解@ControllerAdvice表示增強控制器，當出現(xiàn)異常時，如果是UserNotExistException異常，那么SpringBoot用MyExceptionHandler的handleException方法來處理，而不是找默認的錯誤處理控制器BasicErrorController。 上面這個方法只能返回json，如果要有自適應的效果，還能寫成如下：

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

我們用到的錯誤信息是默認的，如果要自定義，還可以完全寫一個錯誤處理控制類，放在容器中。錯誤頁面上的數(shù)據(jù)或者json的數(shù)據(jù)都是通過errorAttributes.getErrorAttributes得到的。如果我們沒有定制，SpringBoot是默認從容器中找DefaultErrorAttributes.getErrorAttributes()進行處理的。 自定義ErrorAttributes：

@Component
public class MyErrorAttributes extends DefaultErrorAttributes {
    @Override
    public Map<String, Object> getErrorAttributes(RequestAttributes requestAttributes, boolean includeStackTrace) {
        Map<String, Object> map = super.getErrorAttributes(requestAttributes, includeStackTrace);
        map.put("author","klb");
        return map;
    }
}

到此這篇關(guān)于SpringBoot中的錯誤處理機制源碼解析的文章就介紹到這了,更多相關(guān)SpringBoot錯誤處理機制內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論