java spring - MVC异常统一处理实战

　　在J2EE项目的开发中，不管是对底层的数据库操作过程，还是业务层的处理过程，还是控制层的处理过程，都不可避免会遇到各种可预知的、不可预知的异常需要处理。每个过程都单独处理异常，系统的代码耦合度高，工作量大且不好统一，维护的工作量也很大。那么，能不能将所有类型的异常处理从各处理过程解耦出来，这样既保证了相关处理过程的功能较单一，也实现了异常信息的统一处理和维护？答案是肯定的。下面将介绍使用Spring MVC统一处理异常的解决和实现过程。

Spring MVC处理异常有3种方式：

（1）使用Spring MVC提供的简单异常处理器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.ib.exception.BusinessException">error-business</prop>
                <prop key="com.ib.exception.ParameterException">error-parameter</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="WARN" />
        <!- - 默认HTTP状态码 - ->
        <property name="defaultStatusCode" value="500" />
    </bean>

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

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

1,增加HandlerExceptionResolver 接口的实现类ExceptionHandler

public class ExceptionHandler implements HandlerExceptionResolver{
	@Override
	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="com.ib.exception.ExceptionHandler"/>

使用实现HandlerExceptionResolver接口的异常处理器进行异常处理，具有集成简单、有良好的扩展性、对已有代码没有入侵性等优点，同时，在异常处理时能获取导致出现异常的对象，有利于提供更详细的异常处理信息

（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

使用@ExceptionHandler注解实现异常处理，具有集成简单、有扩展性好（只需要将要异常处理的Controller类继承于BaseController即可）、不需要附加Spring配置等优点，但该方法对已有代码存在入侵性（需要修改已有代码，使相关类继承于BaseController），在异常处理时不能获取除异常以外的数据。

(4)未捕获的异常处理(Unchecked Exception)

对于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>
    <error-page>
        <error-code>403</error-code>
        <location>/500.jsp</location>
    </error-page>

首先我们要新建一个项目，从Dao层、Service层、Controller层分别抛出不同的异常，然后分别继承三种方式进行异常处理，从而比较三种方式的优缺点。

1，定义Dao层代码

@Repository
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");
        }
    }
}

2，定义Service层代码，Service层采用接口&接口实现类

　　@1，定义接口

public interface TestService {
    public void exception(Integer id) throws Exception;
    public void dao(Integer id) throws Exception;
}

　　@2，定义接口实现类

@Service
public class TestServiceImpl implements TestService{
    @Autowired
    private TestDao testDao;
    
    @Override
    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，定义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{
        if(id==null){
            throw new ParameterException("未检测到任何参数");
        }
        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);
    }
}

4，定义三个错误页面，分别是:

　　1, 业务类操作错误提示页面(business.jsp),

<%@ page contentType="text/html; charset=UTF-8"%>
<html>
　　<head><title>Exception!</title></head>
<body>
　　<% Exception e = (Exception)request.getAttribute("ex"); %>
　　<H2>业务错误: <%= e.getClass().getSimpleName()%></H2>
　　<hr />
　　<P>错误描述：</P>
　　<%= e.getMessage()%>
　　<P>错误信息：</P>
　　<% e.printStackTrace(new java.io.PrintWriter(out)); %>
</body>
</html>

　　2, 参数类操作错误提示页面(parameter.jsp)

<%@ page contentType="text/html; charset=UTF-8"%>
<html>
　　<head><title>Exception!</title></head>
<body>
　　<% Exception e = (Exception)request.getAttribute("ex"); %>
　　<H2>参数错误: <%= e.getClass().getSimpleName()%></H2>
　　<hr />
　　<P>错误描述：</P>
　　<%= e.getMessage()%>
　　<P>错误信息：</P>
　　<% e.printStackTrace(new java.io.PrintWriter(out)); %>
</body>
</html>

　　3, 默认类型的错误提示页面(error.jsp) 404,500...等错误

<%@ page contentType="text/html; charset=UTF-8"%>
<html>
　　<head><title>Exception!</title></head>
<body>
　　<% Exception e = (Exception)request.getAttribute("ex"); %>
　　<H2>未知错误: <%= e.getClass().getSimpleName()%></H2>
　　<hr />
　　<P>错误描述：</P>
　　<%= e.getMessage()%>
　　<P>错误信息：</P>
　　<% e.printStackTrace(new java.io.PrintWriter(out)); %>
</body>
</html>

5，异常处理类

/**
 * 系统业务异常处理
 * */
public class BusinessException extends RuntimeException{
    /**
     * serialVersionUID
     */
    private static final long serialVersionUID = 1L;
    
    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{
    
    private static final long serialVersionUID = 1L;
    
    public ParameterException() {
        super();
    }

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

    public ParameterException(Throwable cause) {
        super(cause);
    }

    public ParameterException(String message, Throwable cause) {
        super(message, cause);
    }
}

总结
　　Spring MVC集成异常处理3种方式都可以达到统一异常处理的目标。从3种方式的优缺点比较，

若只需要简单的集成异常处理，推荐使用SimpleMappingExceptionResolver即可；

若需要集成的异常处理能够更具个性化，提供给用户更详细的异常信息，推荐自定义实现HandlerExceptionResolver接口的方式；

若不喜欢Spring配置文件或要实现“零配置”，且能接受对原有代码的适当入侵，则建议使用@ExceptionHandler注解方式。

posted @ 2015-11-20 12:59 偷着乐阅读(404) 评论(0) 编辑收藏举报

刷新页面返回顶部

偷着乐

java spring - MVC异常统一处理实战

公告