SpringMVC 統一異常處理

言曌發表於2018-04-02
SpringMVC

1 描述

在J2EE專案的開發中，不管是對底層的資料庫操作過程，還是業務層的處理過程，還是控制層的處理過程，都不可避免會遇到各種可預知的、不可預知的異常需要處理。每個過程都單獨處理異常，系統的程式碼耦合度高，工作量大且不好統一，維護的工作量也很大。

那麼，能不能將所有型別的異常處理從各處理過程解耦出來，這樣既保證了相關處理過程的功能較單一，也實現了異常資訊的統一處理和維護？答案是肯定的。下面將介紹使用Spring MVC統一處理異常的解決和實現過程。

 

補充：

如圖這是一個預設的異常顯示頁面 （新增使用者，使用者名稱已存在）

SpringMVC 統一異常處理

 

這是經過自定義處理過的異常顯示介面（很醜，忽略）

SpringMVC 統一異常處理

很明顯，下面一種更符合設計。

 

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.2 異常類定義

ParameterException.java

  1. package com.change.exception;
  3. /**
  4.  * 請求引數異常
  5.  * @author 言曌
  6.  * @date 2017/12/25 下午8:58
  7.  */
  9. public class ParameterException extends RuntimeException {
  11.     /** serialVersionUID */
  12.     private static final long serialVersionUID = 6417641452178955756L;
  14.     public ParameterException() {
  15.         super();
  16.     }
  18.     public ParameterException(String message) {
  19.         super(message);
  20.     }
  22.     public ParameterException(Throwable cause) {
  23.         super(cause);
  24.     }
  26.     public ParameterException(String message, Throwable cause) {
  27.         super(message, cause);
  28.     }
  29. }

 

BusinessException.java

  1. package com.change.exception;
  3. /**
  4.  * 系統業務異常
  5.  * @author 言曌
  6.  * @date 2017/12/25 下午8:57
  7.  */
  9. public class BusinessException extends RuntimeException {
  11.     /** serialVersionUID */
  12.     private static final long serialVersionUID = 2332608236621015980L;
  14.     private String code;
  16.     public BusinessException() {
  17.         super();
  18.     }
  20.     public BusinessException(String message) {
  21.         super(message);
  22.     }
  24.     public BusinessException(String code, String message) {
  25.         super(message);
  26.         this.code = code;
  27.     }
  29.     public BusinessException(Throwable cause) {
  30.         super(cause);
  31.     }
  33.     public BusinessException(String message, Throwable cause) {
  34.         super(message, cause);
  35.     }
  37.     public BusinessException(String code, String message, Throwable cause) {
  38.         super(message, cause);
  39.         this.code = code;
  40.     }
  42.     public String getCode() {
  43.         return code;
  44.     }
  46.     public void setCode(String code) {
  47.         this.code = code;
  48.     }
  50. }

 

3.2.2 Controller ，Service 或 Dao 層程式碼

適當的場合丟擲異常即可，異常資訊可以使用列舉管理

  1. throw new ParameterException(ResultEnum.USERNAME_IS_EXIST.getMsg());

 

3.3 整合異常處理

方法一、

3.3.1 使用SimpleMappingExceptionResolver實現異常處理

1、在Spring的配置檔案applicationContext.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="com.change.exception.BusinessException">/error/error-business</prop>
  10.                <prop key="com.change.exception.ParameterException">/error/error-parameter</prop>
  11.                <!-- 這裡還可以繼續擴充套件對不同異常型別的處理 -->
  12.            </props>
  13.        </property>
  14.    </bean>

/error/error-business 指的是 webapp/WEB-INF/views/error/error-business.jsp

/error/error-parameter 指的是 webapp/WEB-INF/views/error/error-parameter.jsp

 

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

3、從上面的整合過程可知，使用SimpleMappingExceptionResolver進行異常處理，具有整合簡單、有良好的擴充套件性、對已有程式碼沒有入侵性等優點，但該方法僅能獲取到異常資訊，若在出現異常時，對需要獲取除異常以外的資料的情況不適用。

 

方法二、

3.3.2 實現HandlerExceptionResolver 介面自定義異常處理器

1、增加HandlerExceptionResolver 介面的實現類MyExceptionHandler，程式碼如下：

  1. package com.change.exception;
  3. import org.springframework.web.servlet.HandlerExceptionResolver;
  4. import org.springframework.web.servlet.ModelAndView;
  6. import javax.servlet.http.HttpServletRequest;
  7. import javax.servlet.http.HttpServletResponse;
  8. import java.util.HashMap;
  9. import java.util.Map;
  11. /**
  12.  * @author 言曌
  13.  * @date 2017/12/26 下午12:57
  14.  */
  16. public class MyExceptionHandler implements HandlerExceptionResolver {
  18.     @Override
  19.     public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler,
  20.                                          Exception ex) {
  21.         Map<String, Object> model = new HashMap<String, Object>();
  22.         model.put("ex", ex);
  24.         // 根據不同錯誤轉向不同頁面
  25.         if(ex instanceof BusinessException) {
  26.             return new ModelAndView("/error/error-business", model);
  27.         }else if(ex instanceof ParameterException) {
  28.             return new ModelAndView("/error/error-parameter", model);
  29.         } else {
  30.             return new ModelAndView("/error/error", model);
  31.         }
  32.     }
  33. }

 

2、在Spring的配置檔案applicationContext.xml中增加以下內容：

  1. <bean id="exceptionHandler" class="com.change.exception.MyExceptionHandler"/>

 

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

4、從上面的整合過程可知，使用實現HandlerExceptionResolver介面的異常處理器進行異常處理，具有整合簡單、有良好的擴充套件性、對已有程式碼沒有入侵性等優點，同時，在異常處理時能獲取導致出現異常的物件，有利於提供更詳細的異常處理資訊。

 

方法三、

3.3.3 使用@ExceptionHandler註解實現異常處理

1、增加BaseController類，並在類中使用@ExceptionHandler註解宣告異常處理，程式碼如下：

  1. package com.change.controller;
  3. import com.change.exception.BusinessException;
  4. import com.change.exception.ParameterException;
  5. import org.springframework.web.bind.annotation.ExceptionHandler;
  6. import org.springframework.web.servlet.ModelAndView;
  8. import javax.servlet.http.HttpServletRequest;
  10. /**
  11.  * @author 言曌
  12.  * @date 2017/12/19 下午3:35
  13.  */
  15. public class BaseController {
  18.     /** 基於@ExceptionHandler異常處理 */
  19.     @ExceptionHandler
  20.     public ModelAndView exp(HttpServletRequest request, Exception ex) {
  21.         ModelAndView modelAndView = new ModelAndView();
  22.         modelAndView.addObject("message",ex.getMessage());
  23.         // 根據不同錯誤轉向不同頁面
  24.         if(ex instanceof BusinessException) {
  25.             modelAndView.setViewName("/error/error-business");
  26.         }else if(ex instanceof ParameterException) {
  27.             modelAndView.setViewName("/error/error-parameter");
  28.         } else {
  29.             modelAndView.setViewName("/error/error");
  30.         }
  31.         return modelAndView;
  32.     }
  33. }

 

2、修改程式碼，使所有需要異常處理的Controller都繼承該類，如下所示，修改後的UserController類繼承於BaseController：

  1. @RequestMapping("/user")
  2. @Controller
  3. public class UserController 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檔案，增加以下內容：

  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>
  15. <!-- 這裡可繼續增加伺服器錯誤號的處理及對應顯示的頁面 -->

 

 

原文參考：

http://cgs1999.iteye.com/blog/1547197

SpringBoot 統一異常管理



相關文章