SpringMVC 統一異常處理

阿新 • • 發佈：2018-04-26

Java

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

ParameterException.java

package com.change.exception;

/**
 * 請求參數異常
 * @author 言曌
 * @date 2017/12/25 下午8:58
 */

public class ParameterException extends RuntimeException {

    /** serialVersionUID */
    private static final long serialVersionUID = 6417641452178955756L;

    public ParameterException() {
        super();
    }

    public ParameterException(String message) {
        super(message);
    }

    public ParameterException(Throwable cause) {
        super(cause);
    }

    public ParameterException(String message, Throwable cause) {
        super(message, cause);
    }
}

BusinessException.java

package com.change.exception;

/**
 * 系統業務異常
 * @author 言曌
 * @date 2017/12/25 下午8:57
 */

public class BusinessException extends RuntimeException {

    /** serialVersionUID */
    private static final long serialVersionUID = 2332608236621015980L;

    private String code;

    public BusinessException() {
        super();
    }

    public BusinessException(String message) {
        super(message);
    }

    public BusinessException(String code, String message) {
        super(message);
        this.code = code;
    }

    public BusinessException(Throwable cause) {
        super(cause);
    }

    public BusinessException(String message, Throwable cause) {
        super(message, cause);
    }

    public BusinessException(String code, String message, Throwable cause) {
        super(message, cause);
        this.code = code;
    }

    public String getCode() {
        return code;
    }

    public void setCode(String code) {
        this.code = code;
    }

}

3.2.2 Controller ，Service 或 Dao 層代碼

適當的場合拋出異常即可，異常信息可以使用枚舉管理

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

3.3 集成異常處理

方法一、

3.3.1 使用SimpleMappingExceptionResolver實現異常處理

1、在Spring的配置文件applicationContext.xml中增加以下內容：

<bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
       <!-- 定義默認的異常處理頁面，當該異常類型的註冊時使用 -->
       <property name="defaultErrorView" value="error"></property>
       <!-- 定義異常處理頁面用來獲取異常信息的變量名，默認名為exception -->
       <property name="exceptionAttribute" value="ex"></property>
       <!-- 定義需要特殊處理的異常，用類名或完全路徑名作為key，異常也頁名作為值 -->
       <property name="exceptionMappings">
           <props>
               <prop key="com.change.exception.BusinessException">/error/error-business</prop>
               <prop key="com.change.exception.ParameterException">/error/error-parameter</prop>
               <!-- 這裏還可以繼續擴展對不同異常類型的處理 -->
           </props>
       </property>
   </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，代碼如下：

package com.change.exception;

import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.HashMap;
import java.util.Map;

/**
 * @author 言曌
 * @date 2017/12/26 下午12:57
 */

public class MyExceptionHandler implements HandlerExceptionResolver {

    @Override
    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/error-business", model);
        }else if(ex instanceof ParameterException) {
            return new ModelAndView("/error/error-parameter", model);
        } else {
            return new ModelAndView("/error/error", model);
        }
    }
}

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

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

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

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

方法三、

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

1、增加BaseController類，並在類中使用@ExceptionHandler註解聲明異常處理，代碼如下：

package com.change.controller;

import com.change.exception.BusinessException;
import com.change.exception.ParameterException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;

/**
 * @author 言曌
 * @date 2017/12/19 下午3:35
 */

public class BaseController {


    /** 基於@ExceptionHandler異常處理 */
    @ExceptionHandler
    public ModelAndView exp(HttpServletRequest request, Exception ex) {
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.addObject("message",ex.getMessage());
        // 根據不同錯誤轉向不同頁面
        if(ex instanceof BusinessException) {
            modelAndView.setViewName("/error/error-business");
        }else if(ex instanceof ParameterException) {
            modelAndView.setViewName("/error/error-parameter");
        } else {
            modelAndView.setViewName("/error/error");
        }
        return modelAndView;
    }
}

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

@RequestMapping("/user")
@Controller
public class UserController extends BaseController {

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文件，增加以下內容：

<!-- 出錯頁面定義 -->
<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>

<!-- 這裏可繼續增加服務器錯誤號的處理及對應顯示的頁面 -->

在這裏呢小編給大家推薦一個免費提升Java技術學習好地方，課程涵蓋了Java、Redis、MongoDB、MySQL、Zookeeper、Spring Cloud、Dubbo/Kafka、Hadoop、Hbase、Flink等高並發分布式、大數據、機器學習等技術。

轉送門：https://ke.qq.com/course/293193?flowToken=1002121

SpringMVC 統一異常處理

Java1 描述在J2EE項目的開發中，不管是對底層的數據庫操作過程，還是業務層的處理過程，還是控制層的處理過程，都不可避免會遇到各種可預知的、不可預知的異常需要處理。每個過程都單獨處理異常，系統的代碼耦合度高，工作量大且不好統一，維護的工作量也很大。那麽，能不能將所有類型的異常處理從各處理過程解耦出來，這樣

SpringMVC 統一異常處理

2 分析

3 實戰

SpringMVC 統一異常處理

Java框架-SpringMVC統一異常處理、ssm框架整合

springMVC統一異常處理

springMVC 統一異常處理的一種方式

SpringMVC統一異常處理（返回異常資料而不是跳轉到某個頁面的方法）

SpringMVC的學習（六）——SpringMVC中的統一異常處理

SpringMVC框架08—統一異常處理

springboot 統一異常處理

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

【Spring】SpringMVC之異常處理

Spring Boot學習——統一異常處理

spring-boot實戰【07】【轉】：Spring Boot中Web應用的統一異常處理

SpringMvc的異常處理

Spring Boot? 統一異常處理

spring boot 1.5.4 統一異常處理（九）

MVC 統一異常處理

企業分布式微服務雲SpringCloud SpringBoot mybatis （五）Spring Boot中Web應用的統一異常處理

springboot統一異常處理

Spring Boot中Web應用的統一異常處理

Web API統一異常處理【轉載】

SpringMVC 統一異常處理

2 分析

3 實戰

相關推薦