文档章节

Spring MVC 异常处理

_咫尺_
 _咫尺_
发布于 2015/01/06 17:05
字数 1251
阅读 5743
收藏 307

一、使用@ExceptionHandler进行处理

1.创建异常基类,使用@ExceptionHandler声明异常处理

    BusinessException和SystemException为自定义异常类,代码如下:

package com.twosnail.exception;

import javax.servlet.http.HttpServletRequest;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ExceptionHandler;

@Controller
public class BasicExController {
    /**
     * 基于@ExceptionHandler异常处理基类
     * @return
     */
    @ExceptionHandler
    public String exception( HttpServletRequest request , Exception ex ) {
		
	// 根据不同错误转向不同页面  
        if( ex instanceof BusinessException ) {
            return "business-error";  
        }else if( ex instanceof SystemException ) { 
            return "system-error";
        } else {
            return "error";  
        }
    }
}

2、使所有需要异常处理的Controller都继承该类,如下所示:

public class DemoController extends BasicExController {}

    然而,Dao层、Service层、Controller层抛出的异常(BusinessException、SystemException和其它异常)都能准确显示定义的异常处理页面,达到了统一异常处理的目标。

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

二、SimpleMappingExceptionResolver简单异常处理器

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

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

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

<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.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="WARN" />
	<!-- 默认HTTP状态码 -->
	<property name="defaultStatusCode" value="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仅能获取到异常信息,若在出现异常时,对需要获取除异常以外的数据的情况不适用。

三、HandlerExceptionResolver自定义异常

1.在Spring的配置文件中,增加以下内容:

<bean id="exceptionHandler" class="com.twosnail.exception.MyExceptionHandler"/>

2.添加自定义的MyExceptionHandler类,代码如下:

    在这里,单独打印出了异常路径,便于在日志中查看,在对SystemException异常进行了特殊处理:

package com.twosnail.exception;

import java.util.Map;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.View;
import org.springframework.web.servlet.view.RedirectView;

public class MyExceptionHandler implements HandlerExceptionResolver {

	public ModelAndView resolveException( HttpServletRequest request, HttpServletResponse response, 
			Object handler, Exception exception ) {
		
		System.out.println( "【抛出异常】--异常路径为:" + 
		    request.getServletPath() + "\n【异常信息】--" +  exception.getMessage() ) ;
		//如果不是抛出的action业务异常则不处理
		if( !( exception instanceof SystemException ) ) {
			return null;
		}
		
		final SystemException actionE = (SystemException) exception;		
		ModelAndView model = null;
		if( actionE.getForwardType() == SystemException.FORWARD ) {
		        //进入页面渲染
		        model = new ModelAndView( actionE.getModelPath(), actionE.getAttributes());
		} else if( actionE.getForwardType() == SystemException.REDIRECT ) {
		        model = new ModelAndView( new RedirectView( actionE.getModelPath(), true));
		} else {
			//直接返回页面内容
			model = new ModelAndView( new View() {
				@Override
				public void render(Map<String, ?> arg0, HttpServletRequest arg1,
						HttpServletResponse arg2) throws Exception {
					
					arg2.setContentType( "text/html" );
					arg2.setCharacterEncoding( actionE.getEncode() );
					if( actionE.getResponseBody() != null ) {
						arg2.getWriter().print( actionE.getResponseBody() );
					}
				}
				
				@Override
				public String getContentType() {
					return "text/html; charset=utf-8";
				}
			} );
		}
		
		return model;
	}
}

    总结从上面的集成过程可知,使用实现HandlerExceptionResolver接口的异常处理器进行异常处理,具有集成简单、有良好的扩展性、对已有代码没有入侵性等优点。在异常处理时能获取导致出现异常的对象,有利于提供更详细的异常处理信息。而SimpleMappingExceptionResolver就是HandlerExceptionResolver的默认实现类。

四、项目截图

代码地址twosnail源码地址

参考资料使用Spring MVC统一异常处理实战

原创作者:博客已迁移至github,点击查看

© 著作权归作者所有

_咫尺_
粉丝 24
博文 11
码字总数 5503
作品 0
朝阳
程序员
私信 提问
加载中

评论(35)

sjiaoming
sjiaoming
不错,学习了。总结的很好。
壮实与七龙珠
壮实与七龙珠
看看
_咫尺_
_咫尺_ 博主

引用来自“lgscofield”的评论

每个控制器都继承该类,耦合度太高,contolleradvice处理挺好
嗯,对的
lgscofield
lgscofield
每个控制器都继承该类,耦合度太高,contolleradvice处理挺好
_咫尺_
_咫尺_ 博主

引用来自“落落的月”的评论

这篇文章的内容十月份就看过了,确定是原创吗?
写了,参考资料的
落落的月
落落的月
这篇文章的内容十月份就看过了,确定是原创吗?
码马
码马

引用来自“youpengfei”的评论

看见sysout我也是醉了,大哥你能换个log吗0
我们都喜欢写这个,习惯,改不了。syso要写一百年,动摇不得。。。
_咫尺_
_咫尺_ 博主

引用来自“youpengfei”的评论

看见sysout我也是醉了,大哥你能换个log吗0
测试项目,就没怎么在意,以后会注意这个事情,
youpengfei
youpengfei
看见sysout我也是醉了,大哥你能换个log吗0
杯面柒
杯面柒

引用来自“sgq0085”的评论

我也想说 现在都用 @ControllerAdvice 这篇文章看看就可以了 别用这种方法了
@sgq0085 最好在这里来个相应 @ControllerAdvice 例子链接,
spring mvc 统一异常处理,spring security 对 AuthenticationException 异常处理失效

因配置了 spring mvc 统一异常处理,导致了 spring security 对 AuthenticationException 异常处理失效,原本用 spring security 来实现的 登入检查,权限检查 均被 spring mvc 处理掉了。 ...

LucEsape
2016/02/23
1K
1
Spring MVC 系统异常处理方式及性能对比

大部分公司所用的Spring框架版本是3.1版本以下,所以今天暂时总结3.1版本的Spring-MVC异常处理方式。 一、Spring MVC处理异常有3种方式: (1)使用Spring-MVC提供的SimpleMappingExceptionR...

Candy_Desire
2014/10/17
14.7K
5
Spring MVC 实践 - Component

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/hanqing280441589/article/details/51831979 标签 : Java与Web Converter Spring MVC的数据绑定并非没有任何...

菜鸟-翡青
2016/07/05
0
0
【spring系列】spring框架结构

Spring 框架的 7 个模块 Spring 框架是一个分层架构,由 7 个定义良好的模块组成。Spring 模块构建在核心容器之上,核心容器定义了创建、配置和管理 bean 的方式,如图所示。 图 1. Spring ...

磊神Ray
2011/10/11
504
0
Spring Cloud Spring Boot mybatis分布式微服务云架构 返回JSON格式

在上述例子中,通过统一定义不同Exception映射到不同错误处理页面。而当我们要实现RESTful API时,返回的错误是JSON格式的数据,而不是HTML页面,这时候我们也能轻松支持。 本质上,只需在之...

itcloud
2018/06/21
24
0

没有更多内容

加载失败,请刷新页面

加载更多

作为一个(IT)程序员!聊天没有话题?试试这十二种技巧

首先呢?我是一名程序员,经常性和同事没话题。 因为每天都会有自己的任务要做,程序员对于其他行业来说;是相对来说比较忙的。你会经常看到程序员在发呆、调试密密麻麻代码、红色报错发呆;...

小英子wep
今天
12
0
【SpringBoot】产生背景及简介

一、SpringBoot介绍 Spring Boot 是由 Pivotal 团队提供的全新框架,其设计目的是用来简化新 Spring 应用的初始搭建以及开发过程,该框架使用了特定的方式来进行配置,从而使开发人员不再需要...

zw965
今天
4
0
简述并发编程分为三个核心问题:分工、同步、互斥。

总的来说,并发编程可以总结为三个核心问题:分工、同步、互斥。 所谓分工指的是如何高效地拆解任务并分配给线程,而同步指的是线程之间如何协作,互斥则是保证同一时刻只允许一个线程访问共...

dust8080
今天
6
0
OSChina 周四乱弹 —— 当你简历注水但还是找到了工作

Osc乱弹歌单(2019)请戳(这里) 【今日歌曲】 @花间小酌 :#今日歌曲推荐# 分享成龙的单曲《男儿当自强》。 《男儿当自强》- 成龙 手机党少年们想听歌,请使劲儿戳(这里) @hxg2016 :刚在...

小小编辑
今天
3.3K
22
靠写代码赚钱的一些门路

作者 @mezod 译者 @josephchang10 如今,通过自己的代码去赚钱变得越来越简单,不过对很多人来说依然还是很难,因为他们不知道有哪些门路。 今天给大家分享一个精彩的 GitHub 库,这个库整理...

高级农民工
昨天
9
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部