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

時間 2019-11-10

原文原文鏈接

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

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層代碼
html

Java代碼 java

@Repository("testDao") web
public class TestDao { spring
public void exception(Integer id) throws Exception { 數據庫
switch(id) { 服務器
case 1: app
throw new BusinessException("12", "dao12"); jsp
case 2: ide
throw new BusinessException("22", "dao22"); 測試
case 3:
throw new BusinessException("32", "dao32");
case 4:
throw new BusinessException("42", "dao42");
case 5:
throw new BusinessException("52", "dao52");
default:
throw new ParameterException("Dao Parameter Error");
}
}
}

3.2.3 Service層代碼

Java代碼

public interface TestService {
public void exception(Integer id) throws Exception;
public void dao(Integer id) throws Exception;
}
@Service ("testService")
public class TestServiceImpl implements TestService {
@Resource
private TestDao testDao;
public void exception(Integer id) throws Exception {
switch(id) {
case 1:
throw new BusinessException("11", "service11");
case 2:
throw new BusinessException("21", "service21");
case 3:
throw new BusinessException("31", "service31");
case 4:
throw new BusinessException("41", "service41");
case 5:
throw new BusinessException("51", "service51");
default:
throw new ParameterException("Service Parameter Error");
}
}
@Override
public void dao(Integer id) throws Exception {
testDao.exception(id);
}
}

3.2.4 Controller層代碼

Java代碼

@Controller
public class TestController {
@Resource
private TestService testService;
@RequestMapping(value = "/controller.do", method = RequestMethod.GET)
public void controller(HttpServletResponse response, Integer id) throws Exception {
switch(id) {
case 1:
throw new BusinessException("10", "controller10");
case 2:
throw new BusinessException("20", "controller20");
case 3:
throw new BusinessException("30", "controller30");
case 4:
throw new BusinessException("40", "controller40");
case 5:
throw new BusinessException("50", "controller50");
default:
throw new ParameterException("Controller Parameter Error");
}
}
@RequestMapping(value = "/service.do", method = RequestMethod.GET)
public void service(HttpServletResponse response, Integer id) throws Exception {
testService.exception(id);
}
@RequestMapping(value = "/dao.do", method = RequestMethod.GET)
public void dao(HttpServletResponse response, Integer id) throws Exception {
testService.dao(id);
}
}

3.2.5 JSP頁面代碼

Java代碼

<%@ page contentType="text/html; charset=UTF-8"%>
<html>
<head>
<title>Maven Demo</title>
</head>
<body>
<h1>全部的演示例子</h1>
<h3>[url=./dao.do?id=1]Dao正常錯誤[/url]</h3>
<h3>[url=./dao.do?id=10]Dao參數錯誤[/url]</h3>
<h3>[url=./dao.do?id=]Dao未知錯誤[/url]</h3>
<h3>[url=./service.do?id=1]Service正常錯誤[/url]</h3>
<h3>[url=./service.do?id=10]Service參數錯誤[/url]</h3>
<h3>[url=./service.do?id=]Service未知錯誤[/url]</h3>
<h3>[url=./controller.do?id=1]Controller正常錯誤[/url]</h3>
<h3>[url=./controller.do?id=10]Controller參數錯誤[/url]</h3>
<h3>[url=./controller.do?id=]Controller未知錯誤[/url]</h3>
<h3>[url=./404.do?id=1]404錯誤[/url]</h3>
</body>
</html>

3.3 集成異常處理
3.3.1 使用SimpleMappingExceptionResolver實現異常處理
一、在Spring的配置文件applicationContext.xml中增長如下內容：

Xml代碼

<bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
<property name="defaultErrorView" value="error"></property>
<property name="exceptionAttribute" value="ex"></property>
<property name="exceptionMappings">
<props>
<prop key="cn.basttg.core.exception.BusinessException">error-business</prop>
<prop key="cn.basttg.core.exception.ParameterException">error-parameter</prop>
</props>
</property>
</bean>

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

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

3.3.2 實現HandlerExceptionResolver 接口自定義異常處理器
一、增長HandlerExceptionResolver 接口的實現類MyExceptionHandler，代碼以下：

Java代碼

public class MyExceptionHandler implements HandlerExceptionResolver {
public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler,
Exception ex) {
Map<String, Object> model = new HashMap<String, Object>();
model.put("ex", ex);
// 根據不一樣錯誤轉向不一樣頁面
if(ex instanceof BusinessException) {
return new ModelAndView("error-business", model);
}else if(ex instanceof ParameterException) {
return new ModelAndView("error-parameter", model);
} else {
return new ModelAndView("error", model);
}
}
}

二、在Spring的配置文件applicationContext.xml中增長如下內容：

Xml代碼

<bean id="exceptionHandler" class="cn.basttg.core.exception.MyExceptionHandler"/>

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

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

3.3.3 使用@ExceptionHandler註解實現異常處理
一、增長BaseController類，並在類中使用@ExceptionHandler註解聲明異常處理，代碼以下：

Java代碼

public class BaseController {
/** 基於@ExceptionHandler異常處理 */
@ExceptionHandler
public String exp(HttpServletRequest request, Exception ex) {
request.setAttribute("ex", ex);
// 根據不一樣錯誤轉向不一樣頁面
if(ex instanceof BusinessException) {
return "error-business";
}else if(ex instanceof ParameterException) {
return "error-parameter";
} else {
return "error";
}
}
}

二、修改代碼，使全部須要異常處理的Controller都繼承該類，以下所示，修改後的TestController類繼承於BaseController：

Java代碼

public class TestController extends BaseController

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

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

3.4 未捕獲異常的處理
對於Unchecked Exception而言，因爲代碼不強制捕獲，每每被忽略，若是運行期產生了Unchecked Exception，而代碼中又沒有進行相應的捕獲和處理，則咱們可能不得不面對尷尬的40四、500……等服務器內部錯誤提示頁面。
咱們須要一個全面而有效的異常處理機制。目前大多數服務器也都支持在Web.xml中經過<error-page>(Websphere/Weblogic)或者<error-code>(Tomcat)節點配置特定異常狀況的顯示頁面。修改web.xml文件，增長如下內容：

Xml代碼

<error-page>
<exception-type>java.lang.Throwable</exception-type>
<location>/500.jsp</location>
</error-page>
<error-page>
<error-code>500</error-code>
<location>/500.jsp</location>
</error-page>
<error-page>
<error-code>404</error-code>
<location>/404.jsp</location>
</error-page>

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

二、業務錯誤顯示的頁面，以下圖所示：

三、參數錯誤顯示的頁面，以下圖所示：

四、未知錯誤顯示的頁面，以下圖所示：

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

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