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

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