首页 > 代码库 > Spring MVC统一异常处理

Spring MVC统一异常处理

2024-09-19 01:20:34   222人阅读

 

 实际上Spring MVC处理异常有3种方式： （1）一种是在Controller类内部使用@ExceptionHandler使用注解实现异常处理；

可以在Controller内部实现更个性化点异常处理方式，灵活性更高

（2）使用Spring MVC提供的简单异常处理器SimpleMappingExceptionResolver （3）实现Spring的异常处理接口HandlerExceptionResolver 自定义自己的异常处理器；

Spring已经提供了一个默认的实现类SimpleMappingExceptionResolver

基于HandlerExceptionResolver接口的异常处理：

使用这种方式只需要实现resolveException方法，该方法返回一个ModelAndView对象，在方法内部对异常的类型进行判断，然后常见合适的ModelAndView对象，如果该方法返回了null，则Spring会继续寻找其他的实现了HandlerExceptionResolver 接口的Bean。换句话说，Spring会搜索所有注册在其环境中的实现了HandlerExceptionResolver接口的Bean，逐个执行，直到返回了一个ModelAndView对象。

示例代码：

Java代码  技术分享
  1.   
  2. public class CustomExceptionHandler implements HandlerExceptionResolver {  
  3.   
  4.     @Override  
  5.     public ModelAndView resolveException(HttpServletRequest request,  
  6.             HttpServletResponse response, Object object, Exception exception) {  
  7.         if(exception instanceof IOException){  
  8.             return new ModelAndView("ioexp");  
  9.         }else if(exception instanceof SQLException){  
  10.             return new ModelAndView("sqlexp");  
  11.         }  
  12.         return null;  
  13.     }  
  14.   
  15. }  

这个类必须声明到Spring中去，让Spring管理它，你可以使用@Component标签，也可以使用<bean/>节点。为了简单的进行异常处理，Spring提供了SimpleMappingExceptionResolver类，该类实现了HandlerExceptionResolver接口，需要使用时只需要使用<bean/>节点进行声明即可，示例如下：

Xml代码  技术分享
  1. <bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">  
  2.     <!-- 定义默认的异常处理页面，当该异常类型的注册时使用 -->  
  3.     <property name="defaultErrorView" value="http://www.mamicode.com/error"></property>  
  4.     <!-- 定义异常处理页面用来获取异常信息的变量名，默认名为exception -->  
  5.     <property name="exceptionAttribute" value="http://www.mamicode.com/ex"></property>  
  6.     <!-- 定义需要特殊处理的异常，用类名或完全路径名作为key，异常也页名作为值 -->  
  7.     <property name="exceptionMappings">  
  8.         <props>  
  9.             <prop key="IOException">error/ioexp</prop>  
  10.             <prop key="java.sql.SQLException">error/sqlexp</prop>  
  11.         </props>  
  12.     </property>  
  13. </bean>  
通过SimpleMappingExceptionResolver我们可以将不同的异常映射到不同的jsp页面（通过exceptionMappings属性的配置），同时我们也可以为所有的异常指定一个默认的异
常提示页面（通过defaultErrorView属性的配置），如果所抛出的异常在exceptionMappings中没有对应的映射，则Spring将用此默认配置显示异常信息（注意这里配置的异常显示界面均仅包括主文件名，至于文件路径和后缀已经在viewResolver中指定）。

一个典型的异常显示页面如下： 
<html> 
<head><title>Exception!</title></head> 
<body> 
<% Exception ex = (Exception)request.getAttribute("exception"); %> 
<H2>Exception: <%= ex.getMessage();%></H2> 
<P/> 
<% ex.printStackTrace(new java.io.PrintWriter(out)); %> 
</body> 
</html> 
exception 实在SimpleMappingExceptionResolver 被存放到request中的，具体可以查看源代码。 
如果SimpleMappingExceptionResolver无法满足异常处理的需要，我们可以针对 
HandlerExceptionResolver接口实现自己异常处理类，这同样非常简单（只需要实现一个 
resolveException方法）。 

如果有ViewResolver，则制定的jsp页面必须在那个页面下，到时候如果找不到页面，可以根据错误提示再调整页面路径

 

二    SimpleMappingExceptionResolver简单异常处理器

    SimpleMappingExceptionResolver有两种配置方式，可以按自己需求而定，配置代码如下：

1、第一种，在Spring的配置文件中，增加以下内容：

    在这里，可以设置跳转相应页面。

<bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
	<!-- 定义默认的异常处理页面，当该异常类型的注册时使用 -->
	<property name="defaultErrorView" value="http://www.mamicode.com/error"></property>
	<!-- 定义异常处理页面用来获取异常信息的变量名，默认名为exception -->
	<property name="exceptionAttribute" value="http://www.mamicode.com/ex"></property>
	<!-- 定义需要特殊处理的异常，用类名或完全路径名作为key，异常也页名作为值 -->
	<property name="exceptionMappings">
		<props>
			<prop key="com.twosnail.exception.BusinessException">business-error</prop>
			<prop key="com.twosnail.exception.SystemException">system-error</prop>
		</props>
	</property>

	<!-- 相关状态码对应的错误页面 -->
	<property name="statusCodes">
		<props>
			<prop key="errors/500">500</prop>
			<prop key="errors/404">404</prop>
		</props>
	</property>
	<!-- 设置日志输出级别，不定义则默认不输出警告等错误日志信息 -->
	<property name="warnLogCategory" value="http://www.mamicode.com/WARN" />
	<!-- 默认HTTP状态码 -->
	<property name="defaultStatusCode" value="http://www.mamicode.com/500" />
</bean>

 

2、通过自定义java类，继承SimpleMappingExceptionResolver

    然后在Spring的配置。代码如下：

<bean id="exceptionResolver" class="com.twosnail.exception.MyselfSimpleMappingExceptionResolver">
	<property name="exceptionMappings">
	    <props>
	        <prop key="com.twosnail.exception.SystemException">error/500</prop>
	        <prop key="com.twosnail.exception.BusinessException">error/errorpage</prop>
	        <prop key="java.lang.exception">error/500</prop>
	    </props>
	</property>
</bean>

 

    java类代码如下，在这里可以处理相应逻辑，如下，分别处理了jsp页面和json数据：

package com.twosnail.exception;

import java.io.IOException;
import java.io.PrintWriter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.handler.SimpleMappingExceptionResolver;

public class MyselfSimpleMappingExceptionResolver extends SimpleMappingExceptionResolver {

	@Override
	protected ModelAndView doResolveException(HttpServletRequest request,
			HttpServletResponse response, Object handler, Exception ex) {
		// Expose ModelAndView for chosen error view.
		String viewName = determineViewName(ex, request);
		if (viewName != null) {// JSP格式返回
			if (!(request.getHeader("accept").indexOf("application/json") > -1 || (request
					.getHeader("X-Requested-With") != null && request
					.getHeader("X-Requested-With").indexOf("XMLHttpRequest") > -1))) {
				// 如果不是异步请求
				// Apply HTTP status code for error views, if specified.
				// Only apply it if we‘re processing a top-level request.
				Integer statusCode = determineStatusCode(request, viewName);
				if (statusCode != null) {
					applyStatusCodeIfPossible(request, response, statusCode);
				}
				return getModelAndView(viewName, ex, request);
			} else {// JSON格式返回
				try {
					PrintWriter writer = response.getWriter();
					writer.write(ex.getMessage());
					writer.flush();
				} catch (IOException e) {
					e.printStackTrace();
				}
				return null;

			}
		} else {
			return null;
		}
	}
}

 

    总结：使用SimpleMappingExceptionResolver进行异常处理，具有集成简单、有良好的扩展性、对已有代码没有入侵性等优点，但方法1仅能获取到异常信息，若在出现异常时，对需要获取除异常以外的数据的情况不适用。

三  基于@ExceptionHandler的异常处理：

该方法需要定义在Controller内部，然后创建一个方法并用@ExceptionHandler注解来修饰用来处理异常，这个方法基本和 @RequestMapping修饰的方法差不多，只是可以多一个类型为Exception的参数，@ExceptionHandler中可以添加一个或多个异常的类型，如果为空的话则认为可以触发所有的异常类型错误。

示例代码：

Java代码  技术分享
  1.   
  2. @Controller  
  3. public class ExceptionHandlerController {  
  4.       
  5.     @ExceptionHandler(value=http://www.mamicode.com/{IOException.class,SQLException.class})
  6.     public String exp(Exception ex,HttpServletRequest request) {  
  7.         request.setAttribute("ex", ex);  
  8.         return "/error.jsp";  
  9.     }  
  10.   
  11. }  
 重要的是  在需要进行统一处理的类中extends 这个class
 
public class CustomerController extends ExceptionHandlerController
 
这样CustomController里的方法被访问的时候， 如有异常， 就会被exceptionProces()处理

 

绕过web.xml中如下配置

web.xml

 

[java] view plain copy
 
 技术分享技术分享
  1. <!-- 错误跳转页面 -->  
  2.     <error-page>  
  3.         <!-- 路径不正确 -->  
  4.         <error-code>404</error-code>  
  5.         <location>/WEB-INF/errorpage/404.jsp</location>  
  6.     </error-page>  
  7.     <error-page>  
  8.         <!-- 没有访问权限，访问被禁止 -->  
  9.         <error-code>405</error-code>  
  10.         <location>/WEB-INF/errorpage/405.jsp</location>  
  11.     </error-page>  
  12.     <error-page>  
  13.         <!-- 内部错误 -->  
  14.         <error-code>500</error-code>  
  15.         <location>/WEB-INF/errorpage/500.jsp</location>  
  16.     </error-page> 

 

Spring MVC统一异常处理


联系
我们