详解使用Spring MVC统一异常处理实战
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 实战项目
3.2.1 项目结构
3.2.2 dao层代码
@repository("testdao")
public class testdao {
public void exception(integer id) throws exception {
switch(id) {
case 1:
throw new businessexception("12", "dao12");
case 2:
throw new businessexception("22", "dao22");
case 3:
throw new businessexception("32", "dao32");
case 4:
throw new businessexception("42", "dao42");
case 5:
throw new businessexception("52", "dao52");
default:
throw new parameterexception("dao parameter error");
}
}
}
3.2.3 service层代码
public interface testservice {
public void exception(integer id) throws exception;
public void dao(integer id) throws exception;
}
@service("testservice")
public class testserviceimpl implements testservice {
@resource
private testdao testdao;
public void exception(integer id) throws exception {
switch(id) {
case 1:
throw new businessexception("11", "service11");
case 2:
throw new businessexception("21", "service21");
case 3:
throw new businessexception("31", "service31");
case 4:
throw new businessexception("41", "service41");
case 5:
throw new businessexception("51", "service51");
default:
throw new parameterexception("service parameter error");
}
}
@override
public void dao(integer id) throws exception {
testdao.exception(id);
}
}
3.2.4 controller层代码
@controller
public class testcontroller {
@resource
private testservice testservice;
@requestmapping(value = "/controller.do", method = requestmethod.get)
public void controller(httpservletresponse response, integer id) throws exception {
switch(id) {
case 1:
throw new businessexception("10", "controller10");
case 2:
throw new businessexception("20", "controller20");
case 3:
throw new businessexception("30", "controller30");
case 4:
throw new businessexception("40", "controller40");
case 5:
throw new businessexception("50", "controller50");
default:
throw new parameterexception("controller parameter error");
}
}
@requestmapping(value = "/service.do", method = requestmethod.get)
public void service(httpservletresponse response, integer id) throws exception {
testservice.exception(id);
}
@requestmapping(value = "/dao.do", method = requestmethod.get)
public void dao(httpservletresponse response, integer id) throws exception {
testservice.dao(id);
}
}
3.2.5 jsp页面代码
<%@ page contenttype="text/html; charset=utf-8"%> <html> <head> <title>maven demo</title> </head> <body> <h1>所有的演示例子</h1> <h3>[url=./dao.do?id=1]dao正常错误[/url]</h3> <h3>[url=./dao.do?id=10]dao参数错误[/url]</h3> <h3>[url=./dao.do?id=]dao未知错误[/url]</h3> <h3>[url=./service.do?id=1]service正常错误[/url]</h3> <h3>[url=./service.do?id=10]service参数错误[/url]</h3> <h3>[url=./service.do?id=]service未知错误[/url]</h3> <h3>[url=./controller.do?id=1]controller正常错误[/url]</h3> <h3>[url=./controller.do?id=10]controller参数错误[/url]</h3> <h3>[url=./controller.do?id=]controller未知错误[/url]</h3> <h3>[url=./404.do?id=1]404错误[/url]</h3> </body> </html>
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="cn.basttg.core.exception.businessexception">error-business</prop>
<prop key="cn.basttg.core.exception.parameterexception">error-parameter</prop>
<!-- 这里还可以继续扩展对不同异常类型的处理 -->
</props>
</property>
</bean>
2、启动测试项目，经验证，dao层、service层、controller层抛出的异常（业务异常businessexception、参数异常parameterexception和其它的异常exception）都能准确显示定义的异常处理页面，达到了统一异常处理的目标。
3、从上面的集成过程可知，使用simplemappingexceptionresolver进行异常处理，具有集成简单、有良好的扩展性、对已有代码没有入侵性等优点，但该方法仅能获取到异常信息，若在出现异常时，对需要获取除异常以外的数据的情况不适用。
3.3.2 实现handlerexceptionresolver 接口自定义异常处理器
1、增加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("error-business", model);
}else if(ex instanceof parameterexception) {
return new modelandview("error-parameter", model);
} else {
return new modelandview("error", model);
}
}
}
2、在spring的配置文件applicationcontext.xml中增加以下内容：
<bean id="exceptionhandler" class="cn.basttg.core.exception.myexceptionhandler"/>
3、启动测试项目，经验证，dao层、service层、controller层抛出的异常（业务异常businessexception、参数异常parameterexception和其它的异常exception）都能准确显示定义的异常处理页面，达到了统一异常处理的目标。
4、从上面的集成过程可知，使用实现handlerexceptionresolver接口的异常处理器进行异常处理，具有集成简单、有良好的扩展性、对已有代码没有入侵性等优点，同时，在异常处理时能获取导致出现异常的对象，有利于提供更详细的异常处理信息。
3.3.3 使用@exceptionhandler注解实现异常处理
1、增加basecontroller类，并在类中使用@exceptionhandler注解声明异常处理，代码如下：
public class basecontroller {
/** 基于@exceptionhandler异常处理 */
@exceptionhandler
public string exp(httpservletrequest request, exception ex) {
request.setattribute("ex", ex);
// 根据不同错误转向不同页面
if(ex instanceof businessexception) {
return "error-business";
}else if(ex instanceof parameterexception) {
return "error-parameter";
} else {
return "error";
}
}
}
2、修改代码，使所有需要异常处理的controller都继承该类，如下所示，修改后的testcontroller类继承于basecontroller：
public class testcontroller extends basecontroller
3、启动测试项目，经验证，dao层、service层、controller层抛出的异常（业务异常businessexception、参数异常parameterexception和其它的异常exception）都能准确显示定义的异常处理页面，达到了统一异常处理的目标。
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> <!-- 这里可继续增加服务器错误号的处理及对应显示的页面 -->
4 解决结果
1、运行测试项目显示的首页，如下图所示：
2、业务错误显示的页面，如下图所示：
3、参数错误显示的页面，如下图所示：
4、未知错误显示的页面，如下图所示：
5、服务器内部错误页面，如下图所示：
5 总结
综合上述可知，spring mvc集成异常处理3种方式都可以达到统一异常处理的目标。从3种方式的优缺点比较，若只需要简单的集成异常处理，推荐使用simplemappingexceptionresolver即可；若需要集成的异常处理能够更具个性化，提供给用户更详细的异常信息，推荐自定义实现handlerexceptionresolver接口的方式；若不喜欢spring配置文件或要实现“零配置”，且能接受对原有代码的适当入侵，则建议使用@exceptionhandler注解方式。
6 源代码
源代码项目如下所示，为maven项目，若需运行，请自行获取相关的依赖包。
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。
上一篇： Java计算文本MD5加密值的方法示例