spring mvc 全局处理异常

spring框架支持很多种全局处理异常的方式

一、Spring MVC处理异常有4种方式： 
（1）使用Spring-MVC提供的SimpleMappingExceptionResolver； 
（2）实现Spring的异常处理接口HandlerExceptionResolver 自定义自己的异常处理器； 
（3）使用@ExceptionHandler注解实现异常处理； 

（4）使用@ControllerAdvice方式

二、分别介绍这三种异常处理的实现方式：

（1）使用SimpleMappingExceptionResolver实现异常处理

          只需要在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.core.exception.BusinessException">business_error</prop>  
            <prop key="com.core.exception.ParameterException">parameter_error</prop>  
            <!-- 还可以继续扩展对不同异常类型的处理 -->  
        </props>  
    </property>  
</bean>

　　

（2） 实现HandlerExceptionResolver 接口自定义异常处理器

  首先增加HandlerExceptionResolver 接口的实现类MyExceptionHandler，代码如下： 

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("business_error", model);  
        }else if(ex instanceof ParameterException) {  
            return new ModelAndView("parameter_error", model);  
        } else {  
            return new ModelAndView("error", model);  
        }  
    }  
}

　　

    然后在Spring的配置文件applicationContext.xml中增加以下内容：

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

　　

   （3）使用@ExceptionHandler注解实现异常处理 

     首先要增加BaseController类，并在类中使用@ExceptionHandler注解声明异常处理，代码如下：

public class BaseController {  
    /** 基于@ExceptionHandler异常处理 */  
    @ExceptionHandler  
    public String exp(HttpServletRequest request, Exception ex) {  
        request.setAttribute("ex", ex);  
        // 根据不同错误转向不同页面  
        if(ex instanceof BusinessException) {  
            return "business_error";  
        }else if(ex instanceof ParameterException) {  
            return "parameter_error";  
        } else {  
            return "error";  
        }  
    }  
}

　　

    然后需要修改现有代码，使所有需要异常处理的Controller都继承该类，如下所示：

public class TestController extends BaseController


(4) 使用@ControllerAdvice

@ControllerAdvice(annotations = Controller.class)
public class GlobalExceptionHandler {

    @ExceptionHandler(SQLException.class)
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ResponseBody
    public RespBody handleSQLException(HttpServletRequest request, Exception ex) {
        String message = ex.getMessage();
        return  RespBody.error(HttpStatus.INTERNAL_SERVER_ERROR.value(), message);
    }
　　
 @ExceptionHandler(Exception.class)
 @ResponseBody
 public WapRespBody handleActivityException(HttpServletRequest request, Exception ex) {
     writeLog(ex,request);
     return  WapRespBody.error();
 }

}

　　

自定义返回类RespBody、异常类、异常枚举等

首先自定义返回类：

//作用于类或属性上，被用来在序列化/反序列化时为该对象或字段添加一个对象识别码，通常是用来解决循环嵌套的问题
@JsonIdentityInfo(generator = ObjectIdGenerators.IntSequenceGenerator.class,property = "@code")
public class WapRespBody {


    private String state;

    private String message;

    //正常数据
    private Object data;


    private WapRespBody() {

    }

    private WapRespBody(String code, String message) {
        this.state = code;
        this.message = message;
    }

    private WapRespBody(String statusCode, Object data) {
        this.state = statusCode;
        this.data = data;
    }

    private WapRespBody(String statusCode, String message, Object data) {
        this.state = statusCode;
        this.message = message;
        this.data = data;
    }

    public static WapRespBody ok() {
        return new WapRespBody("200", "");
    }

    public static WapRespBody ok(Object data) {
        return new WapRespBody("200", data);
    }

    public static WapRespBody ok(String code, String message) {
        return new WapRespBody(code, message);
    }


    public static WapRespBody error() {
        return new WapRespBody("-1", "");
    }

    public static WapRespBody error(Object data) {
        return new WapRespBody("-1", data);
    }

    public static WapRespBody error(String code, String msg) {
        return new WapRespBody(code, msg);
    }

    public String getState() {
        return state;
    }

    public void setState(String state) {
        this.state = state;
    }

    public String getMessage() {
        return message;
    }

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

    public Object getData() {
        return data;
    }

    public void setData(Object data) {
        this.data = data;
    }
}

自定义异常信息

package com.yunqiandai.common.exception;

import com.yunqiandai.common.constant.ActivityEnum;

/**
 * Created with IntelliJ IDEA.
 *
 * @author: zhaojc
 * @date: 16/12/13
 * @Time: 上午11:41
 * @description:
 */
public class ActivityException extends Exception {

    private String errorCode;

    private String errorMessage;


    public ActivityException() {

    }

    public ActivityException(String code, String message) {
        this.errorCode = code;
        this.errorMessage = message;
    }

    public ActivityException(ActivityEnum activityEnum) {
        this.errorCode = activityEnum.getStatus();
        this.errorMessage = activityEnum.getMessage();
    }

    public String getErrorCode() {
        return errorCode;
    }

    public void setErrorCode(String errorCode) {
        this.errorCode = errorCode;
    }

    public String getErrorMessage() {
        return errorMessage;
    }

    public void setErrorMessage(String errorMessage) {
        this.errorMessage = errorMessage;
    }
}

　　

自定义枚举

package com.yunqiandai.common.constant;

/**
 * Created with IntelliJ IDEA.
 * @author: zhaojc
 * @date: 16/12/1
 * @Time: 上午10:19
 * @description: 活动常量
 */
public enum ActivityEnum {

    //用户未登录
    USER_NO_LOGIN("201","用户未登录"),

    //活动已开始
    ACTIVITY_IS_START("202","活动已开始"),

    //活动未开始
    ACTIVITY_NO_START("203","活动未开始"),

    //参数错误
    ACTIVITY_PARAM_ERROR("204","参数错误"),

    //页面返回正常
    RESULT_CODE_OK("00",""),
    //页面返回失败
    RESULT_CODE_ERROR("01",""),
    //系统繁忙、发送失败
    RESULT_STATE_ERROR("0","系统繁忙、发送失败!"),
    //请先绑定手机号、请重新登录
    RESULT_STATE_ERR("-1","请先绑定手机号、请重新登录!"),
    //state正常
    RESULT_STATE_OK("1","");

    private String status;

    private String message;

    ActivityEnum(String status,String message) {
        this.status = status;
        this.message=message;
    }

    public String getStatus() {
        return status;
    }

    public void setStatus(String status) {
        this.status = status;
    }


    public String getMessage() {
        return message;
    }

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

　　

三、未捕获异常的处理 ：
        对于Unchecked Exception而言，由于代码不强制捕获，往往被忽略，如果运行期产生了UncheckedException，而代码中又没有进行相应的捕获和处理，则我们可能不得不面对尴尬的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>  
<!-- 可继续增加服务器错误号的处理及对应显示页面 -->

　　

四、比较异常处理方式的优缺点：

        Spring MVC集成异常处理3种方式都可以达到统一异常处理的目标。从4种方式的优缺点比较，若只需要简单的集成异常处理，推荐使用SimpleMappingExceptionResolver即可；若需要集成的异常处理能够更具个性化，提供给用户更详细的异常信息，推荐自定义实现HandlerExceptionResolver接口的方式；若不喜欢Spring配置文件或要实现“零配置”，且能接受对原有代码的适当入侵，则建议使用@ExceptionHandler注解方式。 

如果异常处理配置在项目后期的话,需要看下项目是否用到过以上方式统一管理异常,否则会出现配置后失效的问题。