效果演示

我們先來(lái)看一下Springboot的默認(rèn)效果

瀏覽器訪問(wèn)

客戶端訪問(wèn)

劃重點(diǎn)?。?！

但是絕大部分公司的代碼，都是沒(méi)做自適應(yīng)處理的，很大一部分原因在于，你在網(wǎng)上搜索Springboot全局異常處理，都是搜索到這么一段代碼！

@ControllerAdvice
public?class?MyControllerAdvice?{
?
?
????@ResponseBody
????@ExceptionHandler(value?=?Exception.class)
????public?ResponseEntity?errorHandler(Exception?ex)?{
???????//?處理異常
????}

?
}

強(qiáng)烈建議先用自己常用的搜索引擎搜索一遍，然后再看一下自己公司代碼，看看是不是類似這么一段代碼再往下看。

當(dāng)然很多同學(xué)可能會(huì)說(shuō)，我們就已經(jīng)和客戶端約定很好了，只會(huì)有json,不會(huì)有返回html的場(chǎng)景。所以，不做這個(gè)適應(yīng)，其實(shí)也是沒(méi)問(wèn)題的。但是如果你是做基礎(chǔ)架構(gòu)的同學(xué)，這個(gè)功能你是必須要做的，因?yàn)槟銓?duì)接的是整個(gè)公司的業(yè)務(wù)部門，Springboot能做，你做類似的基礎(chǔ)組件，如果功能比Springboot還差，你讓業(yè)務(wù)方的同學(xué)怎么想？

當(dāng)然，對(duì)于絕大部分同學(xué)來(lái)說(shuō)，不做問(wèn)題也不大。

但是這樣你會(huì)錯(cuò)過(guò)一個(gè)很好的學(xué)習(xí)機(jī)會(huì)。什么學(xué)習(xí)機(jī)會(huì)？因?yàn)楹芏嗤瑢W(xué)平時(shí)總說(shuō)，面試造火箭，工作中遇到不懂的問(wèn)題百度或者谷歌一下就好了。然而，這個(gè)問(wèn)題，你就沒(méi)這么好搜索到。也就是說(shuō)，絕大部分人都是面向搜索引擎編程，當(dāng)遇到搜索引擎無(wú)法解決的問(wèn)題的時(shí)候，就是體現(xiàn)你價(jià)值的時(shí)候，好好珍惜。

做不做這個(gè)功能我覺(jué)得不重要，這個(gè)寶貴的鍛煉解決問(wèn)題能力的機(jī)會(huì)是真的很難得，畢竟，確實(shí)大部分功能是真的簡(jiǎn)單搜索，或者肥朝交流群?jiǎn)枂?wèn)就能解決。

自適應(yīng)原理

很多同學(xué)說(shuō)，既然搜索不到，那果斷一波源碼走起。但是，Springboot源碼這么多，請(qǐng)問(wèn)哪里入手？這個(gè)才是重點(diǎn)！這個(gè)時(shí)候，我們可以官方文檔走一波。

27.1.9 Error Handling

Spring Boot provides an /error mapping by default that handles all errors in a sensible way, and it is registered as a ‘global’ error page in the servlet container. For machine clients it will produce a JSON response with details of the error, the HTTP status and the exception message. For browser clients there is a ‘whitelabel’ error view that renders the same data in HTML format (to customize it just add a View that resolves to ‘error’). To replace the default behaviour completely you can implement ErrorController and register a bean definition of that type, or simply add a bean of type ErrorAttributes to use the existing mechanism but replace the contents.

一些同學(xué)說(shuō)，英文看不懂？我挑5個(gè)重點(diǎn)單詞給你，都是小學(xué)單詞，只要小學(xué)能畢業(yè)，我認(rèn)為都能看懂。

clients JSON browser HTML ErrorController

肥朝小聲逼逼：這里特別強(qiáng)調(diào)，并不是說(shuō)看官方文檔是最優(yōu)解決問(wèn)題方案。還是那句話，老司機(jī)都是看菜吃飯的，解決問(wèn)題的套路有很多，時(shí)間有限，我就不把所有套路一個(gè)一個(gè)列出來(lái)（其實(shí)是怕套路全部告訴你們了，你們就取關(guān)了！），直入主題就行。

從文檔和小學(xué)的英文單詞我們把目標(biāo)鎖定在了ErrorController，給大家看一下關(guān)鍵代碼

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

?@RequestMapping(produces?=?"text/html")
?public?ModelAndView?errorHtml(HttpServletRequest?request,
???HttpServletResponse?response)?{
??HttpStatus?status?=?getStatus(request);
??Map?model?=?Collections.unmodifiableMap(getErrorAttributes(
????request,?isIncludeStackTrace(request,?MediaType.TEXT_HTML)));
??response.setStatus(status.value());
??ModelAndView?modelAndView?=?resolveErrorView(request,?response,?status,?model);
??return?(modelAndView?!=?null)???modelAndView?:?new?ModelAndView("error",?model);
?}

?@RequestMapping
?@ResponseBody
?public?ResponseEntity>?error(HttpServletRequest?request)?{
??Map?body?=?getErrorAttributes(request,
????isIncludeStackTrace(request,?MediaType.ALL));
??HttpStatus?status?=?getStatus(request);
??return?new?ResponseEntity>(body,?status);
?}

}

從這里我們大致可以猜測(cè)出，要做一個(gè)自適應(yīng)的全局異常處理，理論上是要這么寫的。

@ControllerAdvice
public?class?MyExceptionHandler??{

????@ExceptionHandler(Exception.class)
????public?String?handleExceptionHtml(Exception?e,?HttpServletRequest?httpServletRequest)?{
????????//?這里做一些你自己的處理，比如
????????httpServletRequest.setAttribute("歡迎關(guān)注微信公眾號(hào)","肥朝");
????????return?"forward:/error";
????}

}

果然調(diào)試一波，發(fā)現(xiàn)果真如此。當(dāng)然具體怎么自定義這個(gè)錯(cuò)誤界面之類的，網(wǎng)上一搜就有，所以這些不是肥朝的重點(diǎn)。那么這個(gè)自適應(yīng)全局異常似乎美滋滋了？

遇到問(wèn)題

我們知道了這個(gè)自適應(yīng)的全局異常處理的原理，也很容易想到怎么弄出bug。比如，你在攔截器出現(xiàn)了異常的話。

@Configuration
public?class?MyMvcConfig?extends?WebMvcConfigurerAdapter?{

????@Override
????public?void?addInterceptors(InterceptorRegistry?registry)?{
????????registry.addInterceptor(new?HandlerInterceptor()?{
????????????@Override
????????????public?boolean?preHandle(HttpServletRequest?httpServletRequest,?HttpServletResponse?httpServletResponse,?Object?o)?throws?Exception?{
????????????????throw?new?RuntimeException("這里假裝拋出一個(gè)肥朝異常");
????????????????//return?true;
????????????}

????????????@Override
????????????public?void?postHandle(HttpServletRequest?httpServletRequest,?HttpServletResponse?httpServletResponse,?Object?o,?ModelAndView?modelAndView)?throws?Exception?{

????????????}

????????????@Override
????????????public?void?afterCompletion(HttpServletRequest?httpServletRequest,?HttpServletResponse?httpServletResponse,?Object?o,?Exception?e)?throws?Exception?{

????????????}
????????});
????}

}

那么就會(huì)出現(xiàn)，StackOverflowError。

因?yàn)閿r截器出現(xiàn)異常，會(huì)掉進(jìn)你的全局異常處理，然后你的全局異常處理，又進(jìn)行forward，又進(jìn)入了攔截器，然后一直循環(huán)。

那么怎么解決這個(gè)問(wèn)題呢？我們見招拆招，這個(gè)時(shí)候，我要演示常見的幾種不優(yōu)雅，但是平時(shí)大家都容易做的寫法。

將配置寫死

registry.addInterceptor(new?HandlerInterceptor()?{
????@Override
????public?boolean?preHandle(HttpServletRequest?httpServletRequest,?HttpServletResponse?httpServletResponse,?Object?o)?throws?Exception?{
????????throw?new?RuntimeException("這里假裝拋出一個(gè)肥朝異常");
????????//return?true;
????}

????@Override
????public?void?postHandle(HttpServletRequest?httpServletRequest,?HttpServletResponse?httpServletResponse,?Object?o,?ModelAndView?modelAndView)?throws?Exception?{

????}

????@Override
????public?void?afterCompletion(HttpServletRequest?httpServletRequest,?HttpServletResponse?httpServletResponse,?Object?o,?Exception?e)?throws?Exception?{

????}
}).excludePathPatterns("/error");

我們從

@RequestMapping("${server.error.path:${error.path:/error}}")

這里得知，這個(gè)error.path是可以配置的，很多同學(xué)圖快，excludePathPatterns處寫死了/error，這樣一直用默認(rèn)的自然沒(méi)問(wèn)題，一旦人家配置了error.path，就出問(wèn)題了。

潛規(guī)則

這個(gè)潛規(guī)則的問(wèn)題，是絕大部分同學(xué)寫代碼中最常見的問(wèn)題。你想一下，你的自適應(yīng)全局異常是解決了，但是，帶來(lái)的影響卻是，每一個(gè)攔截器都要加上excludePathPatterns這么一個(gè)配置。對(duì)于使用者來(lái)說(shuō)，這個(gè)必須加上某個(gè)配置，就是一種潛規(guī)則，而且，對(duì)于新來(lái)的同事而言，他根本不知道這種潛規(guī)則，一旦潛規(guī)則的代碼多了，后續(xù)很難維護(hù)。

拓展思考

那么不潛規(guī)則的代碼應(yīng)該是怎么樣的？

當(dāng)然很多時(shí)候，我們必須要潛規(guī)則！比如，大數(shù)據(jù)的同學(xué)要求，送過(guò)來(lái)的日志一定要有應(yīng)用名。那么，對(duì)于業(yè)務(wù)方而言，他就必須要配置應(yīng)用名。那么，如何讓業(yè)務(wù)方的同事知道這個(gè)潛規(guī)則。當(dāng)然很多同學(xué)說(shuō)，那就直接告訴同事要加某些參數(shù)啊。你連肥朝每天的推文都不記得看，你能保證每個(gè)同事都記得？

所以總結(jié)下來(lái)，我們遇到這么一類問(wèn)題如下：

1.我們需要對(duì)攔截器進(jìn)行一些潛規(guī)則參數(shù)，比如本文這種，如何優(yōu)雅潛規(guī)則？

2.比如攔截器有順序要求，比如我們基礎(chǔ)框架定義了一個(gè)traceInterceptor的攔截器，這個(gè)攔截器就必須放在最前。那么問(wèn)題來(lái)了，你怎么保證這個(gè)是最前的。有同學(xué)就說(shuō)了，那我用@Order控制啊。那我也寫一個(gè)和你一樣的攔截器，叫feichaoInterceptor,代碼和你一模一樣，既然一模一樣，你怎么保證你的就比我的前了？

3.對(duì)于必須要潛規(guī)則的場(chǎng)景，如何在反抗的情況下，也能潛到？

對(duì)于這幾個(gè)問(wèn)題，我們下期再解答。