您好,登錄后才能下訂單哦!
本篇文章給大家分享的是有關常見的SpringMVC故障排查及解決方案是什么,小編覺得挺實用的,因此分享給大家學習,希望大家閱讀完這篇文章后可以有所收獲,話不多說,跟著小編一起來看看吧。
相信我們每個人在SpringMVC開發中,都遇到這樣的問題:當我們的代碼正常運行時,返回的數據是我們預期格式,比如json或xml形式,但是一旦出現了異常(比如:NPE或者數組越界等等),返回的內容確實服務端的異常堆棧信息,從而導致返回的數據不能使客戶端正常解析; 很顯然,這些并不是我們希望的結果。
我們知道,一個較為常見的系統,會涉及控制層,服務(業務)層、緩存層、存儲層以及接口調用等,其中每一個環節都不可避免的會遇到各種不可預知的異常需要處理。如果每個步驟都單獨try..catch會使系統顯的很雜亂,可讀性差,維護成本高;常見的方式就是,實現統一的異常處理,從而將各類異常從各個模塊中解耦出來;
在Spring中常見的全局異常處理,主要有三種:
(1)注解ExceptionHandler
(2)繼承HandlerExceptionResolver接口
(3)注解ControllerAdvice
在后面的講解中,主要以HTTP錯誤碼:400(請求無效)和500(內部服務器錯誤)為例,先看一下測試代碼以及沒有任何處理的返回結果,如下:
(圖1:測試代碼)
(圖2:沒有異常的錯誤返回)
注解ExceptionHandler作用對象為方法,最簡單的使用方法就是放在controller文件中,詳細的注解定義不再介紹。如果項目中有多個controller文件,通常可以在baseController中實現ExceptionHandler的異常處理,而各個contoller繼承basecontroller從而達到統一異常處理的目的。因為比較常見,簡單代碼如下:
(圖3:Controller中的ExceptionHandler使用)
在返回異常時,添加了所屬的類名,便于大家記憶理解。運行看一下結果:
(圖4:添加ExceptionHandler之后的結果)
優點:ExceptionHandler簡單易懂,并且對于異常處理沒有限定方法格式;
缺點:由于ExceptionHandler僅作用于方法,對于多個controller的情況,僅為了一個方法,所有需要異常處理的controller都繼承這個類,明明不相關的東西,強行關聯,不太好。
這里雖說是ControllerAdvice注解,其實是其與ExceptionHandler的組合使用。在上文中可以看到,單獨使用@ExceptionHandler時,其必須在一個Controller中,然而當其與ControllerAdvice組合使用時就完全沒有了這個限制。換句話說,二者的組合達到的全局的異常捕獲處理。
(圖5:注解ControllerAdvice異常處理代碼)
在運行之前,需將之前Controller中的ExceptionHandler注釋掉,測試結果如下:
(圖6:注解ControllerAdvice異常處理結果)
通過上面結果可以看到,異常處理確實已經變更為ExceptionHandlerAdvice類。這種方法將所有的異常處理整合到一處,去除了Controller中的繼承關系,并且達到了全局捕獲的效果,推薦使用此類方式;
HandlerExceptionResolver本身SpringMVC內部的接口,其內部只有resolveException一個方法,通過實現該接口我們可以達到全局異常處理的目的。
(圖7:實現HandlerExceptionResolver接口)
同樣在執行之前,將上述兩個方法的異常處理都注釋掉,運行結果如下:
(圖8:實現HandlerExceptionResolver接口運行結果)
可以看到500的異常處理已經生效了,但是400的異常處理卻沒有生效,并且根沒有異常前的返回結果一樣。這是怎么回事呢?不是說可以做到全局異常處理的么?沒辦法要想知道問題的原因,我們只能刨根問底,往Spring的祖墳上刨,下面我們結合Spring的源碼調試,去需要原因。
大家都知道,在Spring中第一個收到請求的類就是DispatcherServlet,而該類中核心的方法就是doDispatch,我們可以在該類中打斷點,進而一步步跟進異常處理。
參照如下的跟進步驟,在processHandlerException中斷點,跟蹤的結果如下圖:
(圖9:processHandlerException斷點)
可以看到在圖中箭頭【1】處,在遍歷 handlerExceptionResolvers 進而來處理異常,而在箭頭【2】處,看到handlerExceptionResolvers 中一共有4個元素,其中最后一個就是2.3方法定義的異常處理類
當前的請求query請求,根據上述現象可以推測出,該異常處理應該是在前3個異常處理中被處理了,從而跳過我們自定義的異常;帶著這樣的猜測,我們F8繼續跟進,可以跟蹤到該異常是被第三個,即DefaultHandlerExceptionResolver所處理。
DefaultHandlerExceptionResolver :SpringMVC默認裝配了DefaultHandlerExceptionResolver,該類的doResolveException方法中主要對一些特殊的異常進行處理,并將這類異常轉換為相應的響應狀態碼。而query請求觸發的異常為MissingServletRequestParameterException,其恰好也是被DefaultHandlerExceptionResolver所針對的異常,故會在該類中被異常捕獲。
到此真相大白了,可以看到我們的自定義類MyHandlerExceptionResolver確實可以做到全局處理異常,只不過對于query請求的異常,中間被DefaultHandlerExceptionResolver插了一腳,所以就跳過了MyHandlerExceptionResolver類的處理,從而出現400的返回結果。而對于calc請求,中間沒有阻攔,所以就達到了預期效果。
到此我們一共介紹了3類全局異常處理,按照上面的分析可以看出,實現HandlerExceptionResolver接口的方式是排在最后處理,那么@ExceptionHandler和@ControllerAdvice這兩個的順序誰先誰后呢? 將三類異常處理全部打開(之前注釋掉了),運行一下看看效果:
(圖10:異常處理全放開運行結果)
通過現象可以看到,Controller中單獨@ExceptionHandle異常處理排在了首位,@ControllerAdvice排在了第二位。嚴謹的童鞋可以寫個Controller02,將query和calc復制過去,異常處理就不要了,這樣請求c02的方法時,異常捕獲的所屬類名就都是@ControllerAdvice所在類了。
以上都是我們根據現象得到的結論,下面去Spring源碼去找“證據”。在圖9中,handlerExceptionResolvers中有4類處理器,而@ExceptionHandler和@ControllerAdvice的處理就在第一個ExceptionHandlerExceptionResolver中(之前斷點跟進即可獲知)。繼續跟進直到進入ExceptionHandlerExceptionResolver類的doResolveHandlerMethodException方法,這里的HandlerMethod就是Spring將HTTP請求映射到指定Controller中的方法,而Exception就是需要被捕獲的異常;繼續跟進,看看使用這兩個參數到底干了什么事兒。
(圖11:doResolveHandlerMethodException斷點)
繼續跟進getExceptionHandlerMethod方法,發現有兩個變量可能就是問題的關鍵:exceptionHandlerCache和exceptionHandlerAdviceCache。首先,兩者的變量名很值得懷疑;其次,前者在代碼中看,明顯是通過類作為key,從而得到一個處理器(resolver),這恰好Controller中@ExceptionHandler處理規則相吻合;最后,這兩個Cache的處理順序,也符合之前的得到的結論。正如之前猜測的那樣,Spring中確實是優先根據Controller類名去查找對應的ExceptionHandler,沒有找到的話,再進行@ControllerAdvice異常處理。
(圖12:兩個異常處理Cache )
如有興趣可繼續深入挖掘Spring的源碼,這里針對 ExceptionHandlerExceptionResolver 簡單做個總結:
exceptionHandlerCache中包含Controller中的ExceptionHandler異常處理,處理時通過HandlerMethod得到Controller,進而再找到異常處理方法,需要注意的是,其是在異常處理過程中put值的;
exceptionHandlerAdviceCache則是在項目啟動時初始化的,大概思路是找到帶有@ControllerAdvice注解的bean,從而緩存bean中的ExceptionHandler,在異常處理時需要對齊遍歷查找處理,進而達到全局處理的目的。
介紹了這么多,簡單畫張圖總結一下。藍色的部分是Spring默認添加的3類異常處理器,黃色部分是我們添加的異常處理以及其所被調用的位置和順序。看看哪里還有不太清楚的,往回翻翻看(ResponseStatusExceptionResolver是針對@ResponseStatus注解,這里不再詳述)。
(圖13:異常總結)
如果有需要將MyHandlerExceptionResolver提前處理,甚至排在ExceptionHandlerExceptionResolver之前,能做到么?答案是肯定的,在Spring中如果想將MyHandlerExceptionResolver異常處理提前,需要再實現一個Ordered接口,實現里面的getOrder方法即可,這里返回-1,將其放在最上面,這次咸魚終于可以翻身了。
(圖14:實現Ordered接口)
運行看一下結果是不是符合預期,提醒一下,我們三個異常處理都是生效的,如下圖:
(圖15:實現Ordered接口運行結果)
以上就是常見的SpringMVC故障排查及解決方案是什么,小編相信有部分知識點可能是我們日常工作會見到或用到的。希望你能通過這篇文章學到更多知識。更多詳情敬請關注億速云行業資訊頻道。
免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。