spring MVC 统一异常处理（webapi和web分开处理）

转载： http://blog.csdn.net/m13321169565/article/details/7641978

http://blog.csdn.net/ethan_fu/article/details/44624171

在使用web开发和API 开发都使用到异常的处理，web 异常后跳到指定的错误页面，那么API或AJAX调用需要返回JSON的错误信息，所以我们需要一个统一的异常处理机制来管理这些异常！

1.定义自己的异常处理类

1. import java.io.IOException;
2. import java.lang.reflect.Method;
3. import java.util.Collections;
4. import java.util.List;
5. import java.util.Map;
6. import javax.servlet.ServletException;
7. import javax.servlet.http.HttpServletRequest;
8. import javax.servlet.http.HttpServletResponse;
9. import org.springframework.core.annotation.AnnotationUtils;
10. import org.springframework.http.HttpInputMessage;
11. import org.springframework.http.HttpOutputMessage;
12. import org.springframework.http.HttpStatus;
13. import org.springframework.http.MediaType;
14. import org.springframework.http.converter.HttpMessageConverter;
15. import org.springframework.http.server.ServletServerHttpRequest;
16. import org.springframework.http.server.ServletServerHttpResponse;
17. import org.springframework.util.StringUtils;
18. import org.springframework.web.bind.annotation.ResponseBody;
19. import org.springframework.web.bind.annotation.ResponseStatus;
20. import org.springframework.web.method.HandlerMethod;
21. import org.springframework.web.servlet.ModelAndView;
22. import org.springframework.web.servlet.mvc.method.annotation.ExceptionHandlerExceptionResolver;
23. /**
24. * 不必在Controller中对异常进行处理，抛出即可，由此异常解析器统一控制。<br>
25. * ajax请求（有@ResponseBody的Controller）发生错误，输出JSON。<br>
26. * 页面请求（无@ResponseBody的Controller）发生错误，输出错误页面。<br>
27. * 需要与AnnotationMethodHandlerAdapter使用同一个messageConverters<br>
28. * Controller中需要有专门处理异常的方法。
29. *
30. * @author dongjian
31. *
32. * */
33. public class AnnotationHandlerMethodExceptionResolver extends ExceptionHandlerExceptionResolver {
34. private String defaultErrorView;
35. public String getDefaultErrorView() {
36. return defaultErrorView;
37. }
38. public void setDefaultErrorView(String defaultErrorView) {
39. this.defaultErrorView = defaultErrorView;
40. }
41. /***
42. * 异常后跳转到页面
43. */
44. protected ModelAndView doResolveHandlerMethodException(HttpServletRequest request, HttpServletResponse response, HandlerMethod handlerMethod, Exception exception) {
45. if (handlerMethod == null) {
46. return null;
47. }
48. Method method = handlerMethod.getMethod();
49. if (method == null) {
50. return null;
51. }
52. ModelAndView returnValue = super.doResolveHandlerMethodException(request, response, handlerMethod, exception);
53. ResponseBody responseBodyAnn = AnnotationUtils.findAnnotation(method, ResponseBody.class);
54. if (responseBodyAnn != null) {
55. try {
56. ResponseStatus responseStatusAnn = AnnotationUtils.findAnnotation(method, ResponseStatus.class);
57. if (responseStatusAnn != null) {
58. HttpStatus responseStatus = responseStatusAnn.value();
59. String reason = responseStatusAnn.reason();
60. if (!StringUtils.hasText(reason)) {
61. response.setStatus(responseStatus.value());
62. } else {
63. try {
64. response.sendError(responseStatus.value(), reason);
65. } catch (IOException e) { }
66. }
67. }
68. return handleResponseBody(returnValue, request, response);
69. } catch (Exception e) {
70. return null;
71. }
72. }
73. if(returnValue.getViewName() == null){
74. returnValue.setViewName(defaultErrorView);
75. }
76. return returnValue;
77. }
78. /**
79. * 异常后 返回json
80. * @param returnValue
81. * @param request
82. * @param response
83. * @return
84. * @throws ServletException
85. * @throws IOException
86. */
87. @SuppressWarnings({ "unchecked", "rawtypes" })
88. private ModelAndView handleResponseBody(ModelAndView returnValue, HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
89. Map value = returnValue.getModelMap();
90. HttpInputMessage inputMessage = new ServletServerHttpRequest(request);
91. List<MediaType> acceptedMediaTypes = inputMessage.getHeaders().getAccept();
92. if (acceptedMediaTypes.isEmpty()) {
93. acceptedMediaTypes = Collections.singletonList(MediaType.ALL);
94. }
95. MediaType.sortByQualityValue(acceptedMediaTypes);
96. HttpOutputMessage outputMessage = new ServletServerHttpResponse(response);
97. Class<?> returnValueType = value.getClass();
98. List<HttpMessageConverter<?>> messageConverters = super.getMessageConverters();
99. if (messageConverters != null) {
100. for (MediaType acceptedMediaType : acceptedMediaTypes) {
101. for (HttpMessageConverter messageConverter : messageConverters) {
102. if (messageConverter.canWrite(returnValueType, acceptedMediaType)) {
103. messageConverter.write(value, acceptedMediaType, outputMessage);
104. return new ModelAndView();
105. }
106. }
107. }
108. }
109. if (logger.isWarnEnabled()) {
110. logger.warn("Could not find HttpMessageConverter that supports return type [" + returnValueType + "] and " + acceptedMediaTypes);
111. }
112. return null;
113. }
114. }

2.在spring MVC 配置中添加如下配置

1. <!--  ResponseBody 的类型 -->
2. <bean
3. id="messageConverters" class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter">
4. <property name="supportedMediaTypes">
5. <list>
6. </value>
7. </list>
8. </property>
9. </bean>
10. <bean id="handlerAdapter"
11. class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
12. <property name="cacheSeconds" value="0" />
13. <property name="messageConverters" ref="messageConverters" />
14. </bean>
15. <!-- 设置自定义异常处理 -->
16. <bean id="handlerExceptionResolver" class="com.chengkun.base.exception.AnnotationHandlerMethodExceptionResolver">
17. <property name="defaultErrorView" value="error.jsp"/><!-- 错误页面 -->
18. <property name="messageConverters" ref="messageConverters"/> <!--JSON 处理的messageConverters->
19. </bean>

3.修改web.xml 禁止自动注册，让其使用我们自定义的类

1. <servlet>
2. <servlet-name>spring-mvc</servlet-name>
3. <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
4. <init-param>
5. <param-name>contextConfigLocation</param-name>
6. <param-value>classpath:spring/spring-mvc.xml</param-value>
7. </init-param>
8. <!-- 取消其自动注册的异常解析器 -->
9. <init-param>
10. <param-name>detectAllHandlerExceptionResolvers</param-name>
11. <param-value>false</param-value>
12. </init-param>
13. </load-on-startup>
14. </servlet>

4.在BaseController 中加入异常控制，所有controller必须继承BaseController

1. /**
2. * 异常控制，可以根据不同的异常类型 在此定义不同的错误消息和操作
3. * */
4. @ExceptionHandler(Exception.class)
5. @ResponseStatus(value=HttpStatus.INTERNAL_SERVER_ERROR)
6. public ModelAndView handleException(Exception ex, HttpServletRequest request) {
7. ));
8. }