Spring MVC 统一异常处理的两种方式

版权声明：本文为博主原创文章，未经博主允许不得转载。 https://blog.csdn.net/sinat_33625560/article/details/78678212

没有废话，直接来。

方式一
通过@ControllerAdvice 和 @ExceptionHandler 方法。

@ControllerAdvice 这个注解，可以将对于控制器的全局配置放到注解了@ControllerAdvice的类上，它结合了 @Component 所以可以自动注册为bean
注解了@Controller的类的方法可使用 @ExceptionHandler @InitBinder @MoudelAttribute
注解到方法上
以上这些对所有注解了@requestMapping的方法有效
@ExceptionHandler 用于全局处理控制器的异常
@InitBinder 用来设置WebDataBinder ，WebDataBinder 用来自动绑定前台请求参数到Model
@MoudelAttribute 作用是绑定键值对到Model中，此处是让全局的@RequestMapping都能获取到此处设置的键值对。

看到这里发现@ControllerAdvice其实对异常处理并没有什么帮助，但是如果@ExceptionHandler 不配合 @ControllerAdvice使用，有一种处理方案，写一个BaseController然后 写一个有@ExceptionHandler的方法，然后所有需要的Controller都继承BaseController，很明显这样很麻烦而且代码入侵性太强。差评！

上代码：

package com.wugz.app.controller.exception;

import org.springframework.ui.Model;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.ControllerAdvice;

import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.InitBinder;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.context.request.WebRequest;
import org.springframework.web.servlet.ModelAndView;

import com.wugz.app.utils.BusinessException;


/*
通过@ControllerAdvice，可以对于控制器的全局配置放在同一位置，
注解了@Controller的类的方法可使用 @ExceptionHandler @InitBinder @MoudelAttribute
注解到方法上
以上这些对所有注解了@requestMapping的方法有效
@ExceptionHandler 用于全局处理控制器的异常
@InitBinder 用来设置WebDataBinder ，WebDataBinder 用来自动绑定前台请求参数到Model
@MoudelAttribute 作用是绑定键值对到Model中，此处是让全局的@RequestMapping都能获取到此处设置的键值对
*/

//声明这是一个控制器 建言 @ControllerAdvice 结合了 @Component 所以可以自动注册为bean ,如果这个类只有  @Component 则@ExceptionHandler 不生效
@ControllerAdvice 
public class ExceptionHandlerAdvice {
	
	/***
	 * 
	 * @Description(功能描述)    :  集中处理@requestMapping中抛出的  Exception 异常
	 * @author(作者)             ：  吴桂镇
	 * @date (开发日期)          :  2017年11月30日 下午3:01:06 
	 * @exception                : 
	 * @param ex
	 * @param request
	 * @return  Object
	 */
	@ExceptionHandler(value=Exception.class) //不设置value 则拦截所有的 Exception
	@ResponseBody
	public Object exception(Exception ex,WebRequest request) {
		System.out.println("exception");
		ModelAndView mv = new ModelAndView();
		mv.addObject(123);
		return "return Exception";
	}
	
	/***
	 * 
	 * @Description(功能描述)    :  处理@requestMapping中抛出的 业务异常
	 * @author(作者)             ：  吴桂镇
	 * @date (开发日期)          :  2017年11月30日 下午3:01:31 
	 * @exception                : 
	 * @param ex
	 * @param request
	 * @return  Object
	 */
	@ExceptionHandler(value=BusinessException.class)
	@ResponseBody
	public Object businessException(Exception ex,WebRequest request) {
		System.out.println("businessException");
		return "return BusinessException";
	}
	
	@ModelAttribute
	public void addAttribute(Model model) {
		System.out.println("addAttribute");
	}
	
	@InitBinder
	public void initBinder(WebDataBinder binder) {
		System.out.println("initBinder");
	}
	
}

方式二 实现HandlerExceptionResolver
这个就不废话直接上代码了

package com.wugz.app.controller.exception;

import java.io.IOException;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.http.MediaType;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;

import com.alibaba.fastjson.JSONObject;
import com.wugz.app.utils.BusinessException;
/**
 * 
  * @ClassName(类名)      : MyExceptionHandler
  * @Description(描述)    : 通过实现HandlerExceptionResolver 也可以进行统一的异常处理 
  * 					  ,比较这种方式 增加了对目标方法相关信息的获取，可以根据这些信息进行相关的记录
  * @author(作者)         ：吴桂镇
  * @date (开发日期)      ：2017年11月30日 下午3:23:27
  *
 */
@Component
public class MyExceptionHandler implements HandlerExceptionResolver {

	@Override
	public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler,
			Exception ex) {
		ModelAndView mv = new ModelAndView();
		HandlerMethod handlerMethod = (HandlerMethod) handler;
		Method method = handlerMethod.getMethod();
		Annotation an = method.getAnnotation(ResponseBody.class);
		JSONObject result = new JSONObject();
		
		//异常方法没有@ResponseBody 注释 直接返回页面将错误信息
		if(an == null) { 
			//处理异常
			resolverException(ex, result);
			//模拟跳转到处理页面
			mv.setViewName("index"); 
			//将异常信息放置到前台 接受代码示例 ${requestScope.errorMessage.msg} 或者 
			//Object msg =  request.getAttribute("errorMessage"); 然后在 js中 var result = '<%=msg%>'; 此时的result 是一个json格式的字符串
			mv.addObject("errorMessage", result);
			
		//异常方法有@ResponseBody 则返回json 字符串 
		}else { 
			//处理异常
			resolverException(ex, result);
			//将返回信息写到 ResponseBody中 不跳转页面 就像 使用了 @ResponseBody
	        response.setContentType(MediaType.APPLICATION_JSON_VALUE);
	        response.setCharacterEncoding("UTF-8");
	        response.setHeader("Cache-Control", "no-cache, must-revalidate");  
	        try {
	            response.getWriter().write(result.toJSONString());
	        } catch (IOException e) {
	            e.printStackTrace();
	        }
		}
		return mv;
	}
	
	//处理异常
	private void resolverException(Exception ex, JSONObject result) {
		
		if(ex instanceof BusinessException) {
			resolverBussinessException(ex, result);
		}  else {
			resolverOtherException(ex, result); 
		}
	}

	/*
     * 处理业务层异常 
     */
    private void resolverBussinessException(Exception ex,  JSONObject result) {
        //BusinessException businessException = (BusinessException) ex;
        result.put("msg", "业务异常");
    }
    
    /*
     * 处理其他异常
     */
    private void resolverOtherException(Exception ex, JSONObject result) {
        result.put("msg", "系统异常");
    }

}

ps：一般来讲这两种方式没啥不同，都比较简单
第一种因为会写到统一Controller配置的类中，相对来讲配置的管理相对集中一点。
第二种因为实现了HandlerExceptionResolver 可以获取到handler，这个Object 的 handler 可以强制转换成HandlerMethod，这个HandlerMethod就是源码里HandlerMapping传给HandlerAdapter进行参数解析的重要因素，通过他可以获取很多信息，这一点优势是第一种方法没有的！

注：修改后的代码

@ExceptionHandler(value=Exception.class) //不设置value 则拦截所有的 Exception
	@ResponseBody
	public Object exception(Exception ex,WebRequest request,HandlerMethod handler) {
		HandlerMethod handlerMethod = (HandlerMethod) handler;
		System.out.println("exception");
		ModelAndView mv = new ModelAndView();
		mv.addObject(123);
		return "return Exception";
	}

可以发现增加参数HandlerMethod spring也可以帮我们赋值，可以说这两种的区别很小了。。。。

---

补充： 其实还是有些区别的，具体看代码注释吧，所以说如果需要到HandlerMethod 获取信息，最好的方式还是实现HandlerExceptionResolver，另外在使用HandlerMethod 的时候一定判断是否为空

/***
	 * 
	 * @Description(功能描述)    :  集中处理@requestMapping中抛出的  Exception 异常 ，如果有些异常在 HandlerMethod 为空的时候就抛出了
	 * 							 比如上传文件大小超出限制的 MaxUploadSizeExceededException HandlerMethod为空 则不会进入当前的异常捕获方法
	 * 							如果去掉参数HandlerMethod 则会进入 例如nohandlerException 
	 * @author(作者)             ：  
	 * @date (开发日期)          :  2017年11月30日 下午3:01:06 
	 * @exception                : 
	 * @param ex
	 * @param request
	 * @param HandlerMethod  可以获取到异常方法的相关信息，利用反射
	 * @return  Object
	 */
	@ExceptionHandler(value=Exception.class) //不设置value 则拦截所有的 Exception
	@ResponseBody
	public Object exception(Exception ex,WebRequest request,HandlerMethod handler) {
		HandlerMethod handlerMethod = (HandlerMethod) handler;
		System.out.println("exception");
		ModelAndView mv = new ModelAndView();
		mv.addObject(123);
		return "return Exception";
	}
	
	@ExceptionHandler(value=Exception.class) //不设置value 则拦截所有的 Exception
	@ResponseBody
	public Object nohandlerException(Exception ex,WebRequest request) {
		System.out.println("nohandlerException");
		ModelAndView mv = new ModelAndView();
		mv.addObject(123);
		return "return nohandlerException";
	}