快捷導(dǎo)航

SpringBoot中的錯(cuò)誤處理機(jī)制源碼解析

更新時(shí)間：2023年12月27日 09:59:09 作者：學(xué)哥斌

這篇文章主要介紹了SpringBoot中的錯(cuò)誤處理機(jī)制源碼解析,springboot根據(jù)訪問者的request中的Accept屬性來判斷要返回什么樣的數(shù)據(jù),SpringBoot存在一個(gè)錯(cuò)誤處理機(jī)制,會(huì)根據(jù)不同請求返回不同的結(jié)果,需要的朋友可以參考下

1、默認(rèn)錯(cuò)誤處理機(jī)制

1.1 現(xiàn)象描述

當(dāng)我們使用瀏覽器訪問一個(gè)路徑出現(xiàn)錯(cuò)誤時(shí)，SpringBoot會(huì)彈出一個(gè)ErrorPage：

在這里插入圖片描述

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

在這里插入圖片描述

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

在這里插入圖片描述

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

在這里插入圖片描述

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

1.2 原理解析

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

@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()));
}

這個(gè)BasicErrorController部分截圖如下：

在這里插入圖片描述

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

在這里插入圖片描述

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

在這里插入圖片描述

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

在這里插入圖片描述

1.3 原理小結(jié)

SpringBoot有一個(gè)處理錯(cuò)誤情況的機(jī)制，當(dāng)訪問的頁面出現(xiàn)錯(cuò)誤時(shí)：

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

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

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

2、定制錯(cuò)誤響應(yīng)

2.1 定制錯(cuò)誤頁面

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

在這里插入圖片描述

這個(gè)方法返回一個(gè)ErrorAttributes對(duì)象：

在這里插入圖片描述

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

在這里插入圖片描述

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

在這里插入圖片描述

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

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

在這里插入圖片描述

我們進(jìn)入這個(gè)ResponseEntity對(duì)象不斷往下挖，直到看到：

在這里插入圖片描述

其實(shí)就是給header復(fù)制而已。我們自定義一個(gè)異常處理類：

@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表示增強(qiáng)控制器，當(dāng)出現(xiàn)異常時(shí)，如果是UserNotExistException異常，那么SpringBoot用MyExceptionHandler的handleException方法來處理，而不是找默認(rèn)的錯(cuò)誤處理控制器BasicErrorController。上面這個(gè)方法只能返回json，如果要有自適應(yīng)的效果，還能寫成如下：

@ExceptionHandler(UserNotExistException.class)
public String handleException(Exception e, HttpServletRequest request){
	Map<String,Object> map = new HashMap<>();
    //傳入我們自己的錯(cuò)誤狀態(tài)碼  4xx 5xx，否則就不會(huì)進(jìn)入定制錯(cuò)誤頁面的解析流程
    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";
}

我們用到的錯(cuò)誤信息是默認(rèn)的，如果要自定義，還可以完全寫一個(gè)錯(cuò)誤處理控制類，放在容器中。錯(cuò)誤頁面上的數(shù)據(jù)或者json的數(shù)據(jù)都是通過errorAttributes.getErrorAttributes得到的。如果我們沒有定制，SpringBoot是默認(rèn)從容器中找DefaultErrorAttributes.getErrorAttributes()進(jìn)行處理的。自定義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中的錯(cuò)誤處理機(jī)制源碼解析的文章就介紹到這了,更多相關(guān)SpringBoot錯(cuò)誤處理機(jī)制內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: