【SpringMVC學習07】SpringMVC中的統一異常處理 - shanheyongmu－IT工程師數位筆記本

文章出處

我們知道，系統中異常包括：編譯時異常和運行時異常RuntimeException，前者通過捕獲異常從而獲取異常信息，后者主要通過規范代碼開發、測試通過手段減少運行時異常的發生。在開發中，不管是dao層、service層還是controller層，都有可能拋出異常，在springmvc中，能將所有類型的異常處理從各處理過程解耦出來，既保證了相關處理過程的功能較單一，也實現了異常信息的統一處理和維護。這篇博文主要總結一下SpringMVC中如何統一處理異常。

1. 異常處理思路

　　首先來看一下在springmvc中，異常處理的思路（我已盡力畫好看點了，不要噴我~）：
springmvc異常處理
　　如上圖所示，系統的dao、service、controller出現異常都通過throws Exception向上拋出，最后由springmvc前端控制器交由異常處理器進行異常處理。springmvc提供全局異常處理器（一個系統只有一個異常處理器）進行統一異常處理。明白了springmvc中的異常處理機制，下面就開始分析springmvc中的異常處理。

2. springmvc中自帶的簡單異常處理器

　　springmvc中自帶了一個異常處理器叫SimpleMappingExceptionResolver，該處理器實現了HandlerExceptionResolver 接口，全局異常處理器都需要實現該接口。我們要使用這個自帶的異常處理器，首先得在springmvc.xml文件中配置該處理器：

<!-- springmvc提供的簡單異常處理器 -->
<bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
     <!-- 定義默認的異常處理頁面 -->
    <property name="defaultErrorView" value="/WEB-INF/jsp/error.jsp"/>
    <!-- 定義異常處理頁面用來獲取異常信息的變量名，也可不定義，默認名為exception --> 
    <property name="exceptionAttribute" value="ex"/>
    <!-- 定義需要特殊處理的異常，這是重要點 --> 
    <property name="exceptionMappings">
        <props>
            <prop key="ssm.exception.CustomException">/WEB-INF/jsp/custom_error.jsp</prop>
        </props>
        <!-- 還可以定義其他的自定義異常 -->
    </property>
</bean>

從上面的配置來看，最重要的是要配置特殊處理的異常，這些異常一般都是我們自定義的，根據實際情況來自定義的異常，然后也會跳轉到不同的錯誤顯示頁面顯示不同的錯誤信息。這里就用一個自定義異常CustomException來說明問題，定義如下：

//定義一個簡單的異常類
public class CustomException extends Exception {

    //異常信息
    public String message;

    public CustomException(String message) {
        super(message);
        this.message = message;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

}

接下來就是寫測試程序了，還是使用查詢的例子，如下：

　　然后我們在前臺輸入url來測試：http://localhost:8080/SpringMVC_Study/editItems.action?id=11，故意傳一個id為11，我的數據庫中沒有id為11的項，所以肯定查不到，反正讓它查不到即可。這樣它就會拋出自定義的異常，然后被上面配置的全局異常處理器捕獲并執行，跳轉到我們指定的頁面，然后顯示一下該商品不存在即可。所以這個流程是很清晰的。
　　從上面的過程可知，使用SimpleMappingExceptionResolver進行異常處理，具有集成簡單、有良好的擴展性（可以任意增加自定義的異常和異常顯示頁面）、對已有代碼沒有入侵性等優點，但該方法僅能獲取到異常信息，若在出現異常時，對需要獲取除異常以外的數據的情況不適用。

3. 自定義全局異常處理器

　　全局異常處理器處理思路：

解析出異常類型
如果該異常類型是系統自定義的異常，直接取出異常信息，在錯誤頁面展示
如果該異常類型不是系統自定義的異常，構造一個自定義的異常類型（信息為“未知錯誤”）

springmvc提供一個HandlerExceptionResolver接口，自定義全局異常處理器必須要實現這個接口，如下：

public class CustomExceptionResolver implements HandlerExceptionResolver {

    @Override
    public ModelAndView resolveException(HttpServletRequest request,
            HttpServletResponse response, Object handler, Exception ex) {

        ex.printStackTrace();
        CustomException customException = null;

        //如果拋出的是系統自定義的異常則直接轉換
        if(ex instanceof CustomException) {
            customException = (CustomException) ex;
        } else {
            //如果拋出的不是系統自定義的異常則重新構造一個未知錯誤異常
            //這里我就也有CustomException省事了，實際中應該要再定義一個新的異常
            customException = new CustomException("系統未知錯誤");
        }

        //向前臺返回錯誤信息
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.addObject("message", customException.getMessage());
        modelAndView.setViewName("/WEB-INF/jsp/error.jsp");

        return modelAndView;
    }
}

全局異常處理器中的邏輯很清楚，我就不再多說了，然后就是在springmvc.xml中配置這個自定義的異常處理器：

<!-- 自定義的全局異常處理器 
只要實現HandlerExceptionResolver接口就是全局異常處理器-->
<bean class="ssm.exception.CustomExceptionResolver"></bean>

然后就可以使用上面那個測試用例再次測試了。可以看出在自定義的異常處理器中能獲取導致出現異常的對象，有利于提供更詳細的異常處理信息。一般用這種自定義的全局異常處理器比較多。

4. @ExceptionHandler注解實現異常處理

　　還有一種是使用注解的方法，我大概說一下思路，因為這種方法對代碼的入侵性比較大，我不太喜歡用這種方法。
　　首先寫個BaseController類，并在類中使用@ExceptionHandler注解聲明異常處理的方法，如：

public class BaseController { 
    @ExceptionHandler  
    public String exp(HttpServletRequest request, Exception ex) { 
    //異常處理
    //......
    }
}

然后將所有需要異常處理的Controller都繼承這個BaseController，雖然從執行來看，不需要配置什么東西，但是代碼有侵入性，需要異常處理的Controller都要繼承它才行。
　　關于springmvc的異常處理，就總結這么多吧。

文章列表