使用Spring MVC统一异常处理实战

cgs1999

浏览: 536198 次
性别:
来自: 上海

最近访客更多访客>>

Spring_g

无象心

mrkou

liunancun

博主相关

博客

微博

相册

留言

关于我

文章分类

社区版块

存档分类

博客分类：

Spring
Spring MVC
J2EE
案例文档

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 异常类定义

/** 
 * 系统业务异常 
 */  
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;  
    }  
  
}  
  
  
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);  
    }  
}

3.2.3 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.4 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.5 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.6 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项目，若需运行，请自行获取相关的依赖包。
点击这里获取源代码

7 参考资料
[1] Spring MVC统一处理异常的方法
http://hi.baidu.com/99999999hao/blog/item/25da70174bfbf642f919b8c3.html
[2] SpringMVC 异常处理初探
http://exceptioneye.iteye.com/blog/1306150
[3] Spring3 MVC 深入研究
http://elf8848.iteye.com/blog/875830
[4] Spring MVC异常处理
http://blog.csdn.net/rj042/article/details/7380442

demo-exception.rar (12 KB)
下载次数: 5507

查看图片附件

分享到：

使用Java操作LDAP案例 | 字符串处理strLeft、strRight、strLeftBac ...

2012-06-02 13:54
浏览 105524
评论(53)
分类:编程语言
查看更多

53 楼杀头者 2017-06-06

52 楼 samkakk 2017-04-01

不知怎么发了这些东西，楼主勿怪啊

51 楼 cloudKey 2017-02-25

楼主真厉害。学习了

50 楼 cgs1999 2016-11-07

yfjtd 写道

楼主谢谢你的分享，你写的文章很受用，我有两个问题不明白：
1、 3.3.1和 3.3.2这两种方式，BusinessException和ParameterException这两个类都必须自己定义是么？至于什么情况下会走这两种异常，必须在controller、Service和Dao层手动throw BusinessException和ParameterException才可以捕获到吧？也就是说这三层的代码要手动去改？
2. 除了这BusinessException、ParameterException这两种异常类，对于项目里常出现的异常是否还需要定义其它的异常类呢？项目经理要求和前台对接时根据不同的异常类型给出友好的提示，直接抛异常代码给前台没有意义，请问该如何实现呢？谢谢！

1、针对所述的问题逐个回复
（1）BusinessException和ParameterException这两个类只是Demo中自定义的两个异常类，你也可以根据需要自定义其它的异常类，或使用自带的RuntimeException和Exception两个类；（2）首先，先明确一点，Spring的异常是逐层向上抛出的，至于什么情况抛出哪种异常，这都可以在代码中控制或转换，如：Dao层执行过程中抛出一个DaoAccessException，那么可以直接往上抛，或捕获处理掉不往上抛，或捕获后转换为其它的异常往上抛出，示例代码如下

@Repository("testDao")  
public class TestDao {
    @Resource
    JdbcTemplate jdbcTemplate;

    // 调用后，若出现异常则直接将出现的异常抛给上一层
    public void exception(Integer id) {
        .....
        jdbcTemplate.execute("select * from test");
        .....
    }

    // 方法上直接throws DaoAccessException往上抛DaoAccessException异常
    public void exception1(Integer id) throws DaoAccessException {
        .....
        jdbcTemplate.execute("select * from test");
        .....
    }

    // 捕获处理掉不往上抛
    public void exception2(Integer id) {
        try {
            ....
            jdbcTemplate.execute("select * from test");
            .....
        }catch(DaoAccessException dae) {
            .....
        }catch(Exception e) {
            .....
        }
    }

    // 捕获后转换为其它的异常往上抛
    public void exception3(Integer id) {
        try {
            ....
            jdbcTemplate.execute("select * from test");
            .....
        }catch(DaoAccessException dae) {
            throw new BusinessException("12", "数据库访问异常"); 
        }catch(RuntimeException re) {
            .....
        }catch(Exception e) {
            throw new Exception("未知错误");
        }
    }  
}

如上代码，同理Service和Controller层也可以类似的处理，即可以在代码上将可能出现的各种类型的异常，进行划分归类转化到几个自定义的异常上即可。

注：因为引入了多个第三方的库，抛出的异常都不尽相同，故统一捕获转化为自定义的异常上进行统一处理也是很有必要的

若不对系统出现的各种异常，在代码层进行捕获转换处理，就会发现升级第三方库后会抛出
之前没有的异常，或有些异常类型没有捕获到，那么最上层的controller或Spring的异常配置，就要不停的维护，增加相关的异常处理；但若统一到几种自定义的异常类型上就不会有问题，只需在Dao、Service、Controller等做处理和转换即可。

2、（1）正如上面1中所述，根据需求自定义几个不同的异常类即可，然后将系统所有可能出现的异常全部转换为这些异常即可，如Demo中，将相关的异常都统一为BusinessException和ParameterException，完全没有问题；
（2）针对不同异常给出不同的友好提示，这从demo中就可以看到，正对不同的Exception可以定义不同的界面以及风格，至于错误码对前台是否有意义，个人觉得采用错误码挺好的，可以更灵活的定义不同的界面提示以及提示的内容，如：

Dao或Service或Controller层抛出业务异常BusinessException，错误码为："11"，对应的错误描述为："日期格式错误"，那么前端就可以针对这个错误码，可以定义不同于其它BusinessException的界面，另外，提示的内容也可以更友好，可以在前端针对这个错误进行更友好的提示“日期格式错误，格式为yyyy-dd-mm，例如：2016-11-07”

而不采用错误码，则针对这种情况就不能很好的区分出来，也许你会说根据错误描述“日期格式错误”来进行相关处理，但一旦错误描述变更那就悲剧了....

49 楼 yfjtd 2016-11-03

48 楼 yfjtd 2016-11-03

47 楼 h515963529 2016-09-20

太棒了，实力分享。特意登录帐号提交评论，感谢感谢

46 楼 lutghj1990 2016-07-25

非常棒，超级棒

45 楼 ok7584625 2016-06-08

不都说，先赞一个，刚好解决我最近考虑的一个问题，嘿嘿！

44 楼指尖残血 2016-05-27

学习了，感谢

43 楼 binbinjp 2016-02-23

关于AJAX返回要改CustomSimpleMappingExceptionResolver

return null===>
ModelAndView mv = new ModelAndView();
return mv;

42 楼 jiyilee 2016-01-27

三者好像是个互斥关系。。。

41 楼 cgs1999 2015-10-15

z724130632 写道

你好，楼主。有个问题请教下：当用第一种方式通过简单配置捕捉到的异常写入的日志文件是什么名称？可以通过配置来定义这个日志文件的路径以及名称吗？不知该如何操作？（因为项目中有log4j作为日志输出，所以现在所有的日志都输出在了log4j定义的文件中。那么我怎么将spring mvc 处理的日志单独出一个文件来呢？）谢谢！

z724130632你好，需要搞清楚一点，简单配置能捕获到异常是由于底层的Dao、Service、Controller等没有对该异常进行处理，然后逐层往上抛出，最后才转入配置的异常进行处理（即通过相关的页面显示错误信息）。

那么，捕捉到的异常有没有写入日志文件呢？翻看了3.1.2版本中SimpleMappingExceptionResolver及其父类AbstractHandlerExceptionResolver的源代码，并没有将捕捉到的异常写入日志的处理，故若要实现记录该异常的功能，可以自行扩展SimpleMappingExceptionResolver的实现，并修改配置文件中的异常处理类。

需要说明的是，SimpleMappingExceptionResolver使用的是common-logging，使用了动态查找原理，具体的配置可参见http://blog.csdn.net/yycdaizi/article/details/8276265

40 楼 z724130632 2015-10-15

39 楼 lykm02 2015-06-30

很详细~~

38 楼地毯毒蛇 2015-06-23

异常只进了(2)定义的处理方法,没有进(3)定义的处理方法,是为什么呢?已经有继承了

37 楼 2047699523 2015-05-05

spring mvc demo教程源代码下载:http://www.zuidaima.com/share/kspringmvc-p1-s1.htm

36 楼 deng0810 2015-04-22

老大这几天要我研究springmvc的异常统一处理感谢楼主的好文章！

35 楼 cgs1999 2015-04-08

在世界的中心呼喚愛写道

cgs1999 写道

jwei1228 写道

现在项目经理叫我统一处理异常，那我在项目中怎么运用楼主的程序呢？谢谢

1、实现统一异常处理，请参考“3.3 集成异常处理”和“3.4 未捕获异常的处理”两部分

其中“3.3 集成异常处理”列出了3种集成方式，根据实际的需要项目要求选择其中一种方式即可，个人推荐使用前面两种集成方式，后面的方式对原有代码存在入侵，不推荐使用。

而“3.4 未捕获异常的处理”主要是对框架或代码中无法捕获的异常，如404、500……等服务器内部错误的处理，是统一异常处理必须的

2、前面两种集成方式中，第一种方式只需通过简单的配置即可实现，而第二种方式则需要通过编码实现，两者都可以对不同的异常及异常信息进行不同的显示处理，但第二种方式还可以获取更详细的信息，如出现异常的HttpRequest、出现异常的数据或对象等信息。

若对于异常的处理仅限于提示异常的信息，那么两种方式都可以使用；
若需要记录异常信息，以及造成异常的请求、数据或对象等信息那么就需要采用第二种方式；

第一种也可以，用线程Map来保存异常信息。线程结束销毁这个Map就可以！！

自己实现相关的机制，需要考虑很多的东西，这就没了使用Spring框架的好处了

34 楼在世界的中心呼喚愛 2015-04-06