spring mvc异常处理的三种方式

在Spring MVC中也可以进行一些异常的处理,常用的方式有三种:

  • 使用spring mvc中的异常处理器 SimpleMappingExceptionResolver
  • 使用自定义异常处理器
  • 使用异常处理注解

SimpleMappingExceptionResolver

当系统出现异常之后,我们可以让spring mvc跳转到指定的页面中,这样子对于用户来说体验比较好,对于开发者来说也比较好定位问题,这里先来看下使用SimpleMappingExceptionResolver的方式来处理异常。
首先我们来自定义一个异常:

package com.monkey1024.exception;

/**
 * 自定义异常
 */
public class MyException extends Exception {

    public MyException() {
        super();
    }

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

定义一个controller,在里面分别抛出自定义MyException和jdk自带的Exception:

/**
 * 异常处理controller
 */
@Controller
public class ExceptionController {

    /**
     * 异常
     * @param name
     * @return
     * @throws Exception
     */
    @RequestMapping("myException")
    public ModelAndView myException(String name)throws Exception{

        ModelAndView mv = new ModelAndView();

        if ("jack".equals(name)) {
            throw new MyException("我的自定义异常");
        }

        if (!"jack".equals(name)) {
            throw new Exception("异常");
        }

        return mv;
    }
}

接下来需要修改一下springmvc.xml配置文件,添加异常处理相关的配置:

<!--异常处理-->
<bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
    <property name="exceptionMappings">
        <props>
            <prop key="com.monkey1024.exception.MyException">error/MyError</prop>
        </props>
    </property>

    <property name="defaultErrorView" value="error/error"/>
    <property name="exceptionAttribute" value="ex"/>
</bean>

配置项说明:

  • exceptionMappings:Properties类型属性,用于指定具体的不同类型的异常所对应的异常响应页面。Key 为异常类的全限定名,value则为响应页面路径,如果配置了视图解析器的话,会使用视图解析器中的配置。
  • defaultErrorView:指定默认的异常响应页面。若发生的异常不是 exceptionMappings 中指定的异常,则使用默认异常响应页面。
  • exceptionAttribute:捕获到的异常对象,一般异常响应页面中使用,在el表达式中可以获取到value中的值。

自定义异常响应的页面,在jsp目录中创建error目录,将相关的异常响应页面都放到这个目录中。

MyError.jsp:

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
自定义<br>
${ex.message}
</body>
</html>

error.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
默认异常<br>
${ex.message}
</body>
</html>

自定义异常处理器

倘若我们要在项目中捕获特定的异常,然后再根据捕获的异常做一些操作的时候,按照以前的写法,我们需要在每次捕获异常之后再抛出之前进行操作,这段代码就会重复的出现在很多类里面,导致代码冗余,此时,我们可以通过自定义异常处理器来解决。
自定义异常处理器,需要实现org.springframework.web.servlet.HandlerExceptionResolver接口,并且该类需要在Springmvc.xml
配置文件中进行注册。

首先来自定义一个异常实现HandlerExceptionResolver接口,只要有异常发生,都会自动执行接口方法resolveException()。

/**
 * 自定义异常解析器
 */
public class MyExceptionResolver implements HandlerExceptionResolver {

    @Override
    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        ModelAndView mv = new ModelAndView();
        mv.addObject("ex", ex);

        //设置默认异常处理页面
        mv.setViewName("error/error");

        //判断ex是否是MyException
        if (ex instanceof MyException) {
            //可以在这里面编写捕获到该异常之后的操作

            //设置跳转页面
            mv.setViewName("error/MyError");
        }

        return mv;
    }
}

在springmvc.xml文件中配置异常处理:

<bean class="com.monkey1024.exception.MyExceptionResolver"/>

以后只要系统发生了异常就会执行resolveException方法。

使用注解处理异常

使用注解@ExceptionHandler 可以将一个方法指定为异常处理方法,该注解只有一个可选属性value,是一个 Class<?>数组,用于指定该注解的方法所要处理的异常类,当controller中抛出的异常在这个Class数组中的时候才会调用该异常处理方法。
而被注解的异常处理方法,其返回值可以是 ModelAndView、String,或 void,方法名随意,方法参数可以是 Exception 及其子类对象、HttpServletRequest、HttpServletResponse 等。系统会自动为这些方法参数赋值。

package com.monkey1024.controller;

import com.monkey1024.exception.MyException;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

/**
 * 使用注解标注异常方法
 */
@Controller
public class AnnotationExceptionController {

    @RequestMapping("regist")
    public ModelAndView regist(String name) throws Exception {

        ModelAndView mv = new ModelAndView();
        if ("jack".equals(name)) {
            throw new MyException("自定义异常");
        }

        return mv;
    }


    /**
     * 处理MyException异常的方法
     * @param ex
     * @return
     */
    @ExceptionHandler(MyException.class)
    public ModelAndView handleMyException(Exception ex) {
        ModelAndView mv = new ModelAndView();
        mv.addObject("ex", ex);
        mv.setViewName("/error/MyError");

        return mv;
    }
}

上面使用ExceptionHandler注解标注了一个处理MyException的异常,不过只有在当前的controller中抛出MyException之后才会被该方法处理,其他controller的方法中抛出MyException异常时候是不会被处理的,解决这个问题的办法就是单独定义一个处理异常方法的Controller,然后让其他Controller来继承它,但是这样做的弊端就是继承这个类之后就不能继承其他类了。

定义一个异常处理基类:

package com.monkey1024.controller;

import com.monkey1024.exception.MyException;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

/**
 * 异常处理基类
 */
@Controller
public class BaseExceptionController {


    /**
     * 处理MyException异常的方法
     * @param ex
     * @return
     */
    @ExceptionHandler(MyException.class)
    public ModelAndView handleMyException(Exception ex) {
        ModelAndView mv = new ModelAndView();
        mv.addObject("ex", ex);
        mv.setViewName("/error/MyError");

        return mv;
    }


    /**
     * 其他异常处理,注解中不用写value属性
     * @param ex
     * @return
     */
    @ExceptionHandler
    public ModelAndView handleException(Exception ex) {
        ModelAndView mv = new ModelAndView();
        mv.addObject("ex", ex);
        mv.setViewName("/error/error");

        return mv;
    }
}

之后只要让会抛出异常的controller继承上面的BaseExceptionController即可:

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

    @RequestMapping("addUser")
    public ModelAndView addUser(Exception ex,String name) throws Exception{

        ModelAndView mv = new ModelAndView();
        if ("jack".equals(name)) {
            throw new MyException("用户名不能是jack");
        }

        return mv;
    }
}

三种异常处理方式的总结

  • 使用spring mvc中的异常处理器 SimpleMappingExceptionResolver
    这种方式会产生大量的冗余代码,不建议使用
  • 使用自定义异常处理器
    这种方式将异常处理统一编写到一个类中,便于管理和维护,建议使用。
  • 使用异常处理注解
    如果将异常处理的方法都放到一个基类中,其他类在继承这个类之后就不能继承其他类了,扩展性较差。