使用Spring MVC統一異常處理實戰

原創 ufo2910628 2018-08-27 07:58
1 描述 
在J2EE項目的開發中，不管是對底層的數據庫操作過程，還是業務層的處理過程，還是控制層的處理過程，都不可避免會遇到各種可預知的、不可預知的異常需要處理。每個過程都單獨處理異常，系統的代碼耦合度高，工作量大且不好統一，維護的工作量也很大。 
那麼，能不能將所有類型的異常處理從各處理過程解耦出來，這樣既保證了相關處理過程的功能較單一，也實現了異常信息的統一處理和維護？答案是肯定的。下面將介紹使用Spring MVC統一處理異常的解決和實現過程。 

2 分析 
Spring MVC處理異常有3種方式： 
（1）使用Spring MVC提供的簡單異常處理器SimpleMappingExceptionResolver； 
（2）實現Spring的異常處理接口HandlerExceptionResolver 自定義自己的異常處理器； 
（3）使用@ExceptionHandler註解實現異常處理； 

3 實戰 
3.1 引言 
爲了驗證Spring MVC的3種異常處理方式的實際效果，我們需要開發一個測試項目，從Dao層、Service層、Controller層分別拋出不同的異常，然後分別集成3種方式進行異常處理，從而比較3種方式的優缺點。 

3.2 實戰項目 
3.2.1 項目結構 
 

3.2.2 Dao層代碼 
Java代碼  收藏代碼
  1. @Repository("testDao")  
  2. public class TestDao {  
  3.     public void exception(Integer id) throws Exception {  
  4.         switch(id) {  
  5.         case 1:  
  6.             throw new BusinessException("12", "dao12");  
  7.         case 2:  
  8.             throw new BusinessException("22", "dao22");  
  9.         case 3:  
  10.             throw new BusinessException("32", "dao32");  
  11.         case 4:  
  12.             throw new BusinessException("42", "dao42");  
  13.         case 5:  
  14.             throw new BusinessException("52", "dao52");  
  15.         default:  
  16.             throw new ParameterException("Dao Parameter Error");  
  17.         }  
  18.     }  
  19. }  

3.2.3 Service層代碼 
Java代碼  收藏代碼
  1. public interface TestService {  
  2.     public void exception(Integer id) throws Exception;  
  3.       
  4.     public void dao(Integer id) throws Exception;  
  5. }  
  6.   
  7. @Service("testService")  
  8. public class TestServiceImpl implements TestService {  
  9.     @Resource  
  10.     private TestDao testDao;  
  11.       
  12.     public void exception(Integer id) throws Exception {  
  13.         switch(id) {  
  14.         case 1:  
  15.             throw new BusinessException("11", "service11");  
  16.         case 2:  
  17.             throw new BusinessException("21", "service21");  
  18.         case 3:  
  19.             throw new BusinessException("31", "service31");  
  20.         case 4:  
  21.             throw new BusinessException("41", "service41");  
  22.         case 5:  
  23.             throw new BusinessException("51", "service51");  
  24.         default:  
  25.             throw new ParameterException("Service Parameter Error");  
  26.         }  
  27.     }  
  28.   
  29.     @Override  
  30.     public void dao(Integer id) throws Exception {  
  31.         testDao.exception(id);  
  32.     }  
  33. }  

3.2.4 Controller層代碼 
Java代碼  收藏代碼
  1. @Controller  
  2. public class TestController {  
  3.     @Resource  
  4.     private TestService testService;  
  5.       
  6.     @RequestMapping(value = "/controller.do", method = RequestMethod.GET)  
  7.     public void controller(HttpServletResponse response, Integer id) throws Exception {  
  8.         switch(id) {  
  9.         case 1:  
  10.             throw new BusinessException("10", "controller10");  
  11.         case 2:  
  12.             throw new BusinessException("20", "controller20");  
  13.         case 3:  
  14.             throw new BusinessException("30", "controller30");  
  15.         case 4:  
  16.             throw new BusinessException("40", "controller40");  
  17.         case 5:  
  18.             throw new BusinessException("50", "controller50");  
  19.         default:  
  20.             throw new ParameterException("Controller Parameter Error");  
  21.         }  
  22.     }  
  23.       
  24.     @RequestMapping(value = "/service.do", method = RequestMethod.GET)  
  25.     public void service(HttpServletResponse response, Integer id) throws Exception {  
  26.         testService.exception(id);  
  27.     }  
  28.       
  29.     @RequestMapping(value = "/dao.do", method = RequestMethod.GET)  
  30.     public void dao(HttpServletResponse response, Integer id) throws Exception {  
  31.         testService.dao(id);  
  32.     }  
  33. }  

3.2.5 JSP頁面代碼 
Java代碼  收藏代碼
  1. <%@ page contentType="text/html; charset=UTF-8"%>  
  2. <html>  
  3. <head>  
  4. <title>Maven Demo</title>  
  5. </head>  
  6. <body>  
  7. <h1>所有的演示例子</h1>  
  8. <h3>[url=./dao.do?id=1]Dao正常錯誤[/url]</h3>  
  9. <h3>[url=./dao.do?id=10]Dao參數錯誤[/url]</h3>  
  10. <h3>[url=./dao.do?id=]Dao未知錯誤[/url]</h3>  
  11.   
  12.   
  13. <h3>[url=./service.do?id=1]Service正常錯誤[/url]</h3>  
  14. <h3>[url=./service.do?id=10]Service參數錯誤[/url]</h3>  
  15. <h3>[url=./service.do?id=]Service未知錯誤[/url]</h3>  
  16.   
  17.   
  18. <h3>[url=./controller.do?id=1]Controller正常錯誤[/url]</h3>  
  19. <h3>[url=./controller.do?id=10]Controller參數錯誤[/url]</h3>  
  20. <h3>[url=./controller.do?id=]Controller未知錯誤[/url]</h3>  
  21.   
  22.   
  23. <h3>[url=./404.do?id=1]404錯誤[/url]</h3>  
  24. </body>  
  25. </html>  

3.3 集成異常處理 
3.3.1 使用SimpleMappingExceptionResolver實現異常處理 
1、在Spring的配置文件applicationContext.xml中增加以下內容： 
Xml代碼  收藏代碼
  1. <bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">  
  2.     <!-- 定義默認的異常處理頁面，當該異常類型的註冊時使用 -->  
  3.     <property name="defaultErrorView" value="error"></property>  
  4.     <!-- 定義異常處理頁面用來獲取異常信息的變量名，默認名爲exception -->  
  5.     <property name="exceptionAttribute" value="ex"></property>  
  6.     <!-- 定義需要特殊處理的異常，用類名或完全路徑名作爲key，異常也頁名作爲值 -->  
  7.     <property name="exceptionMappings">  
  8.         <props>  
  9.             <prop key="cn.basttg.core.exception.BusinessException">error-business</prop>  
  10.             <prop key="cn.basttg.core.exception.ParameterException">error-parameter</prop>  
  11.   
  12.             <!-- 這裏還可以繼續擴展對不同異常類型的處理 -->  
  13.         </props>  
  14.     </property>  
  15. </bean>  

2、啓動測試項目，經驗證，Dao層、Service層、Controller層拋出的異常（業務異常BusinessException、參數異常ParameterException和其它的異常Exception）都能準確顯示定義的異常處理頁面，達到了統一異常處理的目標。 

3、從上面的集成過程可知，使用SimpleMappingExceptionResolver進行異常處理，具有集成簡單、有良好的擴展性、對已有代碼沒有入侵性等優點，但該方法僅能獲取到異常信息，若在出現異常時，對需要獲取除異常以外的數據的情況不適用。 

3.3.2 實現HandlerExceptionResolver 接口自定義異常處理器 
1、增加HandlerExceptionResolver 接口的實現類MyExceptionHandler，代碼如下： 
Java代碼  收藏代碼
  1. public class MyExceptionHandler implements HandlerExceptionResolver {  
  2.   
  3.     public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler,  
  4.             Exception ex) {  
  5.         Map<String, Object> model = new HashMap<String, Object>();  
  6.         model.put("ex", ex);  
  7.           
  8.         // 根據不同錯誤轉向不同頁面  
  9.         if(ex instanceof BusinessException) {  
  10.             return new ModelAndView("error-business", model);  
  11.         }else if(ex instanceof ParameterException) {  
  12.             return new ModelAndView("error-parameter", model);  
  13.         } else {  
  14.             return new ModelAndView("error", model);  
  15.         }  
  16.     }  
  17. }  

2、在Spring的配置文件applicationContext.xml中增加以下內容： 
Xml代碼  收藏代碼
  1. <bean id="exceptionHandler" class="cn.basttg.core.exception.MyExceptionHandler"/>  

3、啓動測試項目，經驗證，Dao層、Service層、Controller層拋出的異常（業務異常BusinessException、參數異常ParameterException和其它的異常Exception）都能準確顯示定義的異常處理頁面，達到了統一異常處理的目標。 

4、從上面的集成過程可知，使用實現HandlerExceptionResolver接口的異常處理器進行異常處理，具有集成簡單、有良好的擴展性、對已有代碼沒有入侵性等優點，同時，在異常處理時能獲取導致出現異常的對象，有利於提供更詳細的異常處理信息。 

3.3.3 使用@ExceptionHandler註解實現異常處理 
1、增加BaseController類，並在類中使用@ExceptionHandler註解聲明異常處理，代碼如下： 
Java代碼  收藏代碼
  1. public class BaseController {  
  2.     /** 基於@ExceptionHandler異常處理 */  
  3.     @ExceptionHandler  
  4.     public String exp(HttpServletRequest request, Exception ex) {  
  5.           
  6.         request.setAttribute("ex", ex);  
  7.           
  8.         // 根據不同錯誤轉向不同頁面  
  9.         if(ex instanceof BusinessException) {  
  10.             return "error-business";  
  11.         }else if(ex instanceof ParameterException) {  
  12.             return "error-parameter";  
  13.         } else {  
  14.             return "error";  
  15.         }  
  16.     }  
  17. }  

2、修改代碼，使所有需要異常處理的Controller都繼承該類，如下所示，修改後的TestController類繼承於BaseController： 
Java代碼  收藏代碼
  1. public class TestController extends BaseController  

3、啓動測試項目，經驗證，Dao層、Service層、Controller層拋出的異常（業務異常BusinessException、參數異常ParameterException和其它的異常Exception）都能準確顯示定義的異常處理頁面，達到了統一異常處理的目標。 

4、從上面的集成過程可知，使用@ExceptionHandler註解實現異常處理，具有集成簡單、有擴展性好（只需要將要異常處理的Controller類繼承於BaseController即可）、不需要附加Spring配置等優點，但該方法對已有代碼存在入侵性（需要修改已有代碼，使相關類繼承於BaseController），在異常處理時不能獲取除異常以外的數據。 

3.4 未捕獲異常的處理 
對於Unchecked Exception而言，由於代碼不強制捕獲，往往被忽略，如果運行期產生了Unchecked Exception，而代碼中又沒有進行相應的捕獲和處理，則我們可能不得不面對尷尬的404、500……等服務器內部錯誤提示頁面。 
我們需要一個全面而有效的異常處理機制。目前大多數服務器也都支持在Web.xml中通過<error-page>(Websphere/Weblogic)或者<error-code>(Tomcat)節點配置特定異常情況的顯示頁面。修改web.xml文件，增加以下內容： 
Xml代碼  收藏代碼
  1. <!-- 出錯頁面定義 -->  
  2. <error-page>  
  3.     <exception-type>java.lang.Throwable</exception-type>  
  4.     <location>/500.jsp</location>  
  5. </error-page>  
  6. <error-page>  
  7.     <error-code>500</error-code>  
  8.     <location>/500.jsp</location>  
  9. </error-page>  
  10. <error-page>  
  11.     <error-code>404</error-code>  
  12.     <location>/404.jsp</location>  
  13. </error-page>  
  14.   
  15. <!-- 這裏可繼續增加服務器錯誤號的處理及對應顯示的頁面 -->  

4 解決結果 
1、運行測試項目顯示的首頁，如下圖所示： 


2、業務錯誤顯示的頁面，如下圖所示： 


3、參數錯誤顯示的頁面，如下圖所示： 


4、未知錯誤顯示的頁面，如下圖所示： 


5、服務器內部錯誤頁面，如下圖所示： 


5 總結 
綜合上述可知，Spring MVC集成異常處理3種方式都可以達到統一異常處理的目標。從3種方式的優缺點比較，若只需要簡單的集成異常處理，推薦使用SimpleMappingExceptionResolver即可；若需要集成的異常處理能夠更具個性化，提供給用戶更詳細的異常信息，推薦自定義實現HandlerExceptionResolver接口的方式；若不喜歡Spring配置文件或要實現“零配置”，且能接受對原有代碼的適當入侵，則建議使用@ExceptionHandler註解方式。 

6 源代碼 
源代碼項目如下所示，爲Maven項目，若需運行，請自行獲取相關的依賴包。 
點擊這裏獲取源代碼 

7 參考資料 
[1] Spring MVC統一處理異常的方法 
http://hi.baidu.com/99999999hao/blog/item/25da70174bfbf642f919b8c3.html 
[2] SpringMVC 異常處理初探 
http://exceptioneye.iteye.com/blog/1306150 
[3] Spring3 MVC 深入研究 
http://elf8848.iteye.com/blog/875830 
[4] Spring MVC異常處理 
http://blog.csdn.net/rj042/article/details/7380442
發表評論
所有評論
還沒有人評論，想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章

java線程併發庫

  ThreadLocal的使用，，，實際上相當於維護了一個Map，其中以鍵值對的形式，存儲了某一個數據被多個線程訪問所對應的值。當然這個數據只能有

xinyetonghua 2020-07-08 12:36:33

分佈式系統各個節點狀態如何同步？淺談一下

寫在前面：2020年面試必備的Java後端進階面試題總結了一份複習指南在Github上，內容詳細，圖文並茂，有需要學習的朋友可以Star一下！ GitHub地址：https://github.com/abel-max/Java-S

毛发旺盛的程序员 2020-07-08 12:27:30

ZooKeeper 一致性協議 ZAB 原理，瞭解一下

一致性協議有很多種，比如 Paxos，Raft，2PC，3PC等等，在這講一種協議，ZAB 協議，該協議應該是所有一致性協議中生產環境中應用最多的了。爲什麼？因爲它是爲 Zookeeper 設計的分佈式一致性協議！ 1. 什麼是

毛发旺盛的程序员 2020-07-08 12:27:20

Spring中Transactional 失效的解決方案，讓我們一起探討一下

寫在前面：2020年面試必備的Java後端進階面試題總結了一份複習指南在Github上，內容詳細，圖文並茂，有需要學習的朋友可以Star一下！ GitHub地址：https://github.com/abel-max/Java-S

毛发旺盛的程序员 2020-07-08 12:27:20

太狠了,Spring全家桶筆記,一站式通關全攻略,已入職某廠漲薪18K

Spring 早已成爲 Java 後端開發事實上的行業標準，無數的公司選擇 Spring 作爲基礎的開發框架，大部分Java 後端程序員在日常工作中也會接觸到 Spring ，因此，如何用好 Spring ，也就成爲 Java

毛发旺盛的程序员 2020-07-08 12:27:20

java中的NAN和INFINITY java中的NAN和INFINITY

    java中的NAN和INFINITY   java浮點數運算中有兩個特殊的情況：NAN、INFINITY。 1、INFINITY： 在浮點數運算時，有時我們會遇到除數爲0的情況，那java是如何解決的呢？ 我們知道，在整型運算中

a318013800 2021-11-28 13:09:28

【Java 小白菜入門筆記 2.2】常用的類和方法

Array Array 含有sort、fill、equals、BinarySearch等方法 import java.util.Arrays; import java.util.Random; public class Arra

江户川柯壮 2020-07-08 12:39:29

springboot增量打包更新--靜態資源分離打包

springboot部署打包爲jar，一般都是全量打包，jar包的大小通常都是超過100M的，並且在進行一般的頁面html微調、js修改、img替換、css樣式修改時也需要重新打包進行部署；每次微小的調整都需要重新打包就太煩了，一

CNOYG 2020-07-08 12:39:29

增加FastDfs多文件存儲路徑

項目需要增加聊天會話功能，涉及到上傳語音圖片等信息。考慮新增一個目錄，所有相關文件存在一個相同的目錄中。因此需要對原項目增加一個存儲的路徑。以前的項目因爲只有一個路徑，且已經運行中。走了些彎路，僅此記錄操作過程。nginx version

pengdayong77 2020-07-08 12:37:23

JSONArray指定日期的反序列化

 JSONArray序列化日期最初用到， 這個是全局設置，會有風險。     String[] dateFormats = new String[] {"yyyyMMdd"};                 JSONUtils.getM

pengdayong77 2020-07-08 12:37:23

java緩存對象，使之不需要每次都從數據庫中獲取,以提高程序性能

直接上源碼，定義一個抽象類，必須實現get方法。該方法是用來獲取需要緩存的對象的。  import java.util.HashMap; import java.util.Map; /** * 用於從數據庫中獲取相應值的緩存類 *

pengdayong77 2020-07-08 12:37:23

類加載和類實例化

Java程序中對類的使用方式分爲兩類 ：主動使用和被動使用 主動使用： 創建類的實例 訪問某個類或接口的靜態變量，或者對該靜態變量賦值 調用類的靜態方法 反射 初始化一個類的子類 java虛擬機啓動時被標明爲啓動類的類 從JDK

吃酒忘情殇 2020-07-08 12:36:21

大數據入門（七）win10上eclipse使用Hadoop的配置

目錄工具eclipse的Hadoop環境配置參考 系列： 大數據入門（一）環境搭建，VMware15+CentOS8.1 配置 https://blog.csdn.net/qq_34391511/article/details/1

33 Audrey 2020-07-08 12:35:23

Java動態綁定機制經典案列理解

如題，直接帶入案例進行理解Java的動態綁定機制，不多說直接上代碼了。 package one; public class JavaTest { public static void main(String[] args

柘月十七 2020-07-08 12:33:16

阿里年薪破百架構師推薦：鳥哥的Linux私房菜，搭配面試題，真香

在Linux實操的過程中，你是否有過這些疑問： 如何提取日誌中含有關鍵字的指定行，上一行或上幾行？ ln 做了符號鏈接，對符號鏈接進行權限修改，原文件是否會受到影響？ Shell 腳本里有很多特殊符號，到底該怎麼用？網上流傳的

毛发旺盛的程序员 2020-07-08 12:27:30