真實(shí)項(xiàng)目實(shí)踐:快速定位 Spring MVC異常實(shí)戰(zhàn)(附源碼下載)
一、使用@ExceptionHandler進(jìn)行處理
1.創(chuàng)建異常基類(lèi),使用@ExceptionHandler聲明異常處理
BusinessException和SystemException為自定義異常類(lèi),代碼如下:
- package com.twosnail.exception;
- import javax.servlet.http.HttpServletRequest;
- import org.springframework.stereotype.Controller;
- import org.springframework.web.bind.annotation.ExceptionHandler;
- @Controller
- public class BasicExController {
- /**
- * 基于@ExceptionHandler異常處理基類(lèi)
- * @return
- */
- @ExceptionHandler
- public String exception( HttpServletRequest request , Exception ex ) {
- // 根據(jù)不同錯(cuò)誤轉(zhuǎn)向不同頁(yè)面
- if( ex instanceof BusinessException ) {
- return "business-error";
- }else if( ex instanceof SystemException ) {
- return "system-error";
- } else {
- return "error";
- }
- }
- }
2、使所有需要異常處理的Controller都繼承該類(lèi),如下所示:
- public class DemoController extends BasicExController {}
然而,Dao層、Service層、Controller層拋出的異常(BusinessException、SystemException和其它異常)都能準(zhǔn)確顯示定義的異常處理頁(yè)面,達(dá)到了統(tǒng)一異常處理的目標(biāo)。
總結(jié):使用@ExceptionHandler注解實(shí)現(xiàn)異常處理,具有集成簡(jiǎn)單、有擴(kuò)展性好(只需要將要異常處理的Controller類(lèi)繼承于BasicExController即可)、不需要附加Spring配置等優(yōu)點(diǎn),但該方法對(duì)已有代碼存在入侵性(需要修改已有代碼,使繼承于BasicExController),在異常處理時(shí)不能獲取除異常以外的數(shù)據(jù)。
二、SimpleMappingExceptionResolver簡(jiǎn)單異常處理器
SimpleMappingExceptionResolver有兩種配置方式,可以按自己需求而定,配置代碼如下:
1、第一種,在Spring的配置文件中,增加以下內(nèi)容:
在這里,可以設(shè)置跳轉(zhuǎn)相應(yīng)頁(yè)面。
- <bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
- <!-- 定義默認(rèn)的異常處理頁(yè)面,當(dāng)該異常類(lèi)型的注冊(cè)時(shí)使用 -->
- <property name="defaultErrorView" value="error"></property>
- <!-- 定義異常處理頁(yè)面用來(lái)獲取異常信息的變量名,默認(rèn)名為exception -->
- <property name="exceptionAttribute" value="ex"></property>
- <!-- 定義需要特殊處理的異常,用類(lèi)名或完全路徑名作為key,異常也頁(yè)名作為值 -->
- <property name="exceptionMappings">
- <props>
- <prop key="com.twosnail.exception.BusinessException">business-error</prop>
- <prop key="com.twosnail.exception.SystemException">system-error</prop>
- </props>
- </property>
- <!-- 相關(guān)狀態(tài)碼對(duì)應(yīng)的錯(cuò)誤頁(yè)面 -->
- <property name="statusCodes">
- <props>
- <prop key="errors/500">500</prop>
- <prop key="errors/404">404</prop>
- </props>
- </property>
- <!-- 設(shè)置日志輸出級(jí)別,不定義則默認(rèn)不輸出警告等錯(cuò)誤日志信息 -->
- <property name="warnLogCategory" value="WARN" />
- <!-- 默認(rèn)HTTP狀態(tài)碼 -->
- <property name="defaultStatusCode" value="500" />
- </bean>
2、第二種,通過(guò)自定義java類(lèi),繼承SimpleMappingExceptionResolver
然后在Spring的配置。代碼如下:
- <bean id="exceptionResolver" class="com.twosnail.exception.MyselfSimpleMappingExceptionResolver">
- <property name="exceptionMappings">
- <props>
- <prop key="com.twosnail.exception.SystemException">error/500</prop>
- <prop key="com.twosnail.exception.BusinessException">error/errorpage</prop>
- <prop key="java.lang.exception">error/500</prop>
- </props>
- </property>
- </bean>
java類(lèi)代碼如下,在這里可以處理相應(yīng)邏輯,如下,分別處理了jsp頁(yè)面和json數(shù)據(jù):
- package com.twosnail.exception;
- import java.io.IOException;
- import java.io.PrintWriter;
- import javax.servlet.http.HttpServletRequest;
- import javax.servlet.http.HttpServletResponse;
- import org.springframework.web.servlet.ModelAndView;
- import org.springframework.web.servlet.handler.SimpleMappingExceptionResolver;
- public class MyselfSimpleMappingExceptionResolver extends SimpleMappingExceptionResolver {
- @Override
- protected ModelAndView doResolveException(HttpServletRequest request,
- HttpServletResponse response, Object handler, Exception ex) {
- // Expose ModelAndView for chosen error view.
- String viewName = determineViewName(ex, request);
- if (viewName != null) {// JSP格式返回
- if (!(request.getHeader("accept").indexOf("application/json") > -1 || (request
- .getHeader("X-Requested-With") != null && request
- .getHeader("X-Requested-With").indexOf("XMLHttpRequest") > -1))) {
- // 如果不是異步請(qǐng)求
- // Apply HTTP status code for error views, if specified.
- // Only apply it if we're processing a top-level request.
- Integer statusCode = determineStatusCode(request, viewName);
- if (statusCode != null) {
- applyStatusCodeIfPossible(request, response, statusCode);
- }
- return getModelAndView(viewName, ex, request);
- } else {// JSON格式返回
- try {
- PrintWriter writer = response.getWriter();
- writer.write(ex.getMessage());
- writer.flush();
- } catch (IOException e) {
- e.printStackTrace();
- }
- return null;
- }
- } else {
- return null;
- }
- }
- }
總結(jié):使用SimpleMappingExceptionResolver進(jìn)行異常處理,具有集成簡(jiǎn)單、有良好的擴(kuò)展性、對(duì)已有代碼沒(méi)有入侵性等優(yōu)點(diǎn),但方法1僅能獲取到異常信息,若在出現(xiàn)異常時(shí),對(duì)需要獲取除異常以外的數(shù)據(jù)的情況不適用。
三、HandlerExceptionResolver自定義異常
1.在Spring的配置文件中,增加以下內(nèi)容:
- <bean id="exceptionHandler" class="com.twosnail.exception.MyExceptionHandler"/>
2.添加自定義的MyExceptionHandler類(lèi),代碼如下:
在這里,單獨(dú)打印出了異常路徑,便于在日志中查看,在對(duì)SystemException異常進(jìn)行了特殊處理:
- package com.twosnail.exception;
- import java.util.Map;
- import javax.servlet.http.HttpServletRequest;
- import javax.servlet.http.HttpServletResponse;
- import org.springframework.web.servlet.HandlerExceptionResolver;
- import org.springframework.web.servlet.ModelAndView;
- import org.springframework.web.servlet.View;
- import org.springframework.web.servlet.view.RedirectView;
- public class MyExceptionHandler implements HandlerExceptionResolver {
- public ModelAndView resolveException( HttpServletRequest request, HttpServletResponse response,
- Object handler, Exception exception ) {
- System.out.println( "【拋出異?!?-異常路徑為:" +
- request.getServletPath() + "\n【異常信息】--" + exception.getMessage() ) ;
- //如果不是拋出的action業(yè)務(wù)異常則不處理
- if( !( exception instanceof SystemException ) ) {
- return null;
- }
- final SystemException actionE = (SystemException) exception;
- ModelAndView model = null;
- if( actionE.getForwardType() == SystemException.FORWARD ) {
- //進(jìn)入頁(yè)面渲染
- model = new ModelAndView( actionE.getModelPath(), actionE.getAttributes());
- } else if( actionE.getForwardType() == SystemException.REDIRECT ) {
- model = new ModelAndView( new RedirectView( actionE.getModelPath(), true));
- } else {
- //直接返回頁(yè)面內(nèi)容
- model = new ModelAndView( new View() {
- @Override
- public void render(Map<String, ?> arg0, HttpServletRequest arg1,
- HttpServletResponse arg2) throws Exception {
- arg2.setContentType( "text/html" );
- arg2.setCharacterEncoding( actionE.getEncode() );
- if( actionE.getResponseBody() != null ) {
- arg2.getWriter().print( actionE.getResponseBody() );
- }
- }
- @Override
- public String getContentType() {
- return "text/html; charset=utf-8";
- }
- } );
- }
- return model;
- }
- }
總結(jié):從上面的集成過(guò)程可知,使用實(shí)現(xiàn)HandlerExceptionResolver接口的異常處理器進(jìn)行異常處理,具有集成簡(jiǎn)單、有良好的擴(kuò)展性、對(duì)已有代碼沒(méi)有入侵性等優(yōu)點(diǎn)。在異常處理時(shí)能獲取導(dǎo)致出現(xiàn)異常的對(duì)象,有利于提供更詳細(xì)的異常處理信息。而SimpleMappingExceptionResolver就是HandlerExceptionResolver的默認(rèn)實(shí)現(xiàn)類(lèi)。
四、項(xiàng)目截圖
代碼地址:twosnail源碼地址
參考資料:使用Spring MVC統(tǒng)一異常處理實(shí)戰(zhàn)
原創(chuàng)作者:兩只蝸牛