快捷導(dǎo)航

SpringMVC之異常處理解讀

更新時間：2023年03月21日 10:20:35 作者：自東向西

這篇文章主要介紹了SpringMVC之異常處理解讀，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

背景

我們的代碼中，總是會拋出各種異常，例如HttpRequestMethodNotSupportedException、HttpMediaTypeNotSupportedException，或者是自己定義的BusinessException。

這些異常，如果我們不將它們try catch進(jìn)行處理，就會導(dǎo)致http的狀態(tài)碼變成非20x，并返回SpringMvc默認(rèn)的異常信息格式。

場景1：業(yè)務(wù)部門對返回值進(jìn)行了統(tǒng)一的規(guī)定，例如：{"code":200, "message": "success", "data": {}}，當(dāng)發(fā)生異常的時候，并不希望http狀態(tài)碼變成非20x，而是保持200，通過code來表達(dá)調(diào)用是否成功，通過message來返回失敗的原因。

場景2：業(yè)務(wù)部門希望發(fā)生異常的時候，返回異常信息使用的不是SpringMvc默認(rèn)的格式，而是自定義自己的格式，返回更多輔助排查問題的信息。

這兩種場景，都需要對未捕獲的異常進(jìn)行處理，這就需要利用上SpringMvc的異常處理拓展點。

接下來基于spring-webmvc-5.3.8來分析一下異常處理~

源碼分析

DispatcherServlet

DispatcherServlet是SpringMvc的入口，所有請求都經(jīng)過DispatcherServlet，再進(jìn)入我們定義的@Controller接口中，進(jìn)行處理。

接口發(fā)生異常時，也由DispatcherServlet的handlerExceptionResolvers屬性所持有的HandlerExceptionResolver來處理。

在DispatcherServlet.initHandlerExceptionResolvers中，對handlerExceptionResolers進(jìn)行初始化：

如果DispatcherServlet.detectAllHandlerExceptionResolvers屬性為true，則會獲取Spring容器中所有類型為HandlerExceptionResolver的bean
如果DispatcherServlet.detectAllHandlerExceptionResolvers屬性為false，則會嘗試獲取beanName為HANDLER_EXCEPTION_RESOLVER_BEAN_NAME的HandlerExceptionResolver的bean
最后，如果從Spring容器中，找不到HandlerExceptionResolver，則會采用默認(rèn)策略，生成默認(rèn)的異常處理

默認(rèn)情況下，detectAllHandlerExceptionResolvers為true，而Spring容器里也會有三個HandlerExceptionResolver：

ExceptionHandlerExceptionResolver，使用用戶加了@EcxceptionHandler注解的方法來處理異常。
ResponseStatusExceptionHandler，如果異常類型是ResponseStatusException，則根據(jù)異常中的status和reason，利用HttpServletResponse.sendError來返回異常信息。
DefaultHandlerExceptionResolver，當(dāng)前兩個解析器沒有成功處理，則該處理器會處理一些指定的異常類型，例如HttpRequestMethodNotSupportedException、HttpMediaTypeNotSupportedException、HttpMediaTypeNotAcceptableException等等；通過HttpServletResponse.sendError來返回異常信息。

ExceptionHandlerExceptionResolver

異常處理器的的處理能力來自于持有的ExceptionHandlerMethodResolver對象，有兩個屬性持有該類型的對象：

Map<Class<?>, ExceptionHandlerMethodResolver> exceptionHandlerCache，緩存來自加了@Controller注解的bean中加了@ExceptionHanlder的方法，所以key是加了@Controller注解的類，value就是對應(yīng)方法的ExceptionHandlerMethodResolver封裝。優(yōu)先于exceptionHandlerAdviceCache
Map<ControllerAdviceBean, ExceptionHandlerMethodResolver> exceptionHandlerAdviceCache，則是緩存了@ControllerAdvice注解的類中的異常處理，key是@ControllerAdvice的對象，value是加了@ExceptionHandler的方法對應(yīng)的ExceptionHandlerMethodResolver封裝。

在處理異常的方法doResolveHandlerMethodException中，會調(diào)用getExceptionHandlerMethod方法，從exceptionHandlerCache和exceptionHandlerAdviceCache獲得ServletInvocableHandlerMethod。如果ServletInvocableHandlerMethod不為空，則用ServletInvocableHandlerMethod.invokeAndHandle處理異常。

所以重點就是在這兩個屬性的內(nèi)容來源?。?！

exceptionHandlerCache的內(nèi)容，是在解析異常的時候才被逐步初始化，類似懶加載：

handlerMethod是拋異常的@Controller注解類的方法，handlerType就是@Controller注解的類。

注意?。?！由于handlerType就是@Controller注解的類，所以new出來的ExceptionHandlerMethodResolver只會處理倒該@Controller注解的類拋出的異常（exceptionHandlerCache的key是handlerType）。

exceptionHandlerAdviceCache屬性的的初始在，是在afterPropertiesSet中調(diào)用initExceptionHandlerAdviceCache，會獲取Spring容器中所有加了@ControllerAdvice注解的bean，如果這些bean中有加了@ExceptionHandler注解的方法，則會被放到exceptionHandlerAdviceCache中。

ExceptionHandlerMethodResolver

再分析一下ExceptionHandlerMethodResolver的能力~

在構(gòu)造函數(shù)中，會根據(jù)handlerType，通過反射的方式，選擇類中加了@ExceptionHandler注解的方法，將@ExceptionHandler中的異常類型作為key，方法本身作為value，設(shè)置到mappedMethods中。

而excptionLookupCache則作為根據(jù)Throwable類型→method處理方法的緩存：

如果能在excptionLookupCache緩存中找到，則直接返回
如果找不到，則嘗試從mappedMethods中查找
如果mappedMethods中也沒有找到，則會返回NO_MATCHING_EXEPTION_HANDLER_METHOD，該值也會被緩存在excptionLookupCache，這樣就能避免緩存擊穿！！

自定義異常處理

自定義異常處理的方式有三種：

1、自定義HandlerExceptionResolver類，注冊到Spring容器上下文中，這樣就會被DispatcherServlet檢測到，放到handlerExceptionResolvers屬性中，只要優(yōu)先級高于SpringMvc默認(rèn)的HandlerExceptionResolver，就可以優(yōu)先處理異常。

2、在@Controller的類中，添加@ExceptionHandler注解的方法。這樣，該方法就會處理其所在controller類拋出的異常。

3、在@ControllerAdvice類中增加@ExceptionHandler注解的方法。@ControllerAdvice類有幾個選擇屬性，basePackages、basePackageClasses、assignableTypes和annotations；如果設(shè)置了這幾個屬性，則只有匹配這些屬性規(guī)則的@Controller類的異常才會被處理。默認(rèn)都為空，所有類的異常都會被處理。