SpringMVC 4.3 源码分析之 HandlerExcep

1. HandlerExceptionResolver 概述

HandlerExceptionResolver: 在处理 handler 映射 或执行 HandlerExecutionChain/Handler 抛出的异常信息, 一般是返回对应的 ModelAndView(PS: 设置 ViewName 与 Model 中的属性信息), 其主接口如下:

// 针对 通过 path 获取 handler 或 执行handler时出现异常的处理类
public interface HandlerExceptionResolver {
    // 通过解析异常查询配置以得到符合条件的 ModelAndView 对象
    ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex);
}

其主要实现类如下:

1. SimpleMappingExceptionResolver
    在配置信息中配置 异常Class <-> ViewName的映射的 异常处理器
2. ResponseStatusExceptionResolver
    根据异常 class 上面的 @ResponseStatus 中注解的 Http Code 与 reson 进行返回 ModeAndView
3. DefaultHandlerExceptionResolver
    默认异常解析器, 进行异常的类型进行相应的解析操作, 在 Http 头部设置对应的 Code, 最后返回对应的 ModelAndView
4. ExceptionHandlerExceptionResolver
    通过激活在 方法上注释 @ExceptionHandler 注解的方法来处理对应的异常, 激活的操作通过 InvocableHandlerMethod 来进行操作 (Invocable 是 invoke的变形)
5. HandlerExceptionResolverComposite
    异常处理的组合模式类, 通过刷选满足条件的 ExceptionResolver, 只要有能解决这个异常的, 则直接返回

2. 简单异常处理类 SimpleMappingExceptionResolver

在这个类中主要有个存储异常类型 class <-> ViewName 的 Properties, 存储 viewName <-> HttpCode的Properties, 当出现异常了, 就通过这个 properties 进行获取 viewName, 并通过 viewName 获取对应的 HttpCode; 主要有如下属性:

// 配置 异常 Class <--> ViewName 映射关系的 Property 的文件
private Properties exceptionMappings;
// 忽略的异常的类型
private Class<?>[] excludedExceptions;
// Set the name of the default error view 设置默认的 错误页面
private String defaultErrorView;
// 默认的 Http 返回的状态值
private Integer defaultStatusCode;
// 这里配置的是 ViewName <--> Http Code 的映射关系
private Map<String, Integer> statusCodes = new HashMap<String, Integer>();

3. 根据 Exception 上的注解 ResponseStatus 设置httpCode 的ResponseStatusExceptionResolver

这个异常处理类比较简单, 主要是出了异常, 则根据 Exception 上的注解@ResponseStatus 来获取 HttpCode 与 ErrorMsg, 而返回的是一个空的 ModelAndView

4. 默认的异常处理类 DefaultHandlerExceptionResolver

这是一个根据异常的类型设置 http code 与 ErrorMsg 的 异常处理类, 主要处理的异常如下:

1. 处理 NoSuchRequestHandlingMethodException, 设置 http code 404 --> SC_NOT_FOUND
2. 处理 HttpRequestMethodNotSupportedException, 设置 http code 405 -- > SC_METHOD_NOT_ALLOWED
3. 处理 HttpMediaTypeNotSupportedException, 设置 http code 415 --> SC_UNSUPPORTED_MEDIA_TYPE
4. 处理 HttpMediaTypeNotAcceptableException, 设置 http code 406 --> SC_NOT_ACCEPTABLE
5. 处理 MissingPathVariableException, 设置 http code 500 --> SC_INTERNAL_SERVER_ERROR
6. 处理 MissingServletRequestParameterException, 设置 http code 400 --> SC_BAD_REQUEST
7. 处理 ServletRequestBindingException, 设置 http code 400 --> SC_BAD_REQUEST
8. 处理 ConversionNotSupportedException, 设置 http code 500 --> SC_INTERNAL_SERVER_ERROR
9. 处理 TypeMismatchException, 设置 http code 400 --> SC_BAD_REQUEST
10. 处理 HttpMessageNotReadableException, 设置 http code 400 --> SC_BAD_REQUEST
11. 处理 HttpMessageNotWritableException, 设置 http code 500 --> SC_INTERNAL_SERVER_ERROR
12. 处理 MethodArgumentNotValidException, 设置 http code 400 --> SC_BAD_REQUEST
13. 处理 MissingServletRequestPartException, 设置 http code 400 --> SC_BAD_REQUEST
14. 处理 BindException, 设置 http code 400 --> SC_BAD_REQUEST
15. 处理 NoHandlerFoundException, 设置 http code 404 --> SC_NOT_FOUND
16. 处理 AsyncRequestTimeoutException, 设置 http code 503 --> SC_SERVICE_UNAVAILABLE

5. 基于注解@ExceptionHandler 的异常处理类 ExceptionHandlerExceptionResolver

其实就是在指定的方法上标注 @ExceptionHandler 最后通过 InvocableHandlerMethod 进行激活方法 <-- 这个方法就是处理异常的; 其主要有如下属性:

// HandlerMethod 参数解析器
private List<HandlerMethodArgumentResolver> customArgumentResolvers;
// 组合模式的 HandlerMethod 参数解析器
private HandlerMethodArgumentResolverComposite argumentResolvers;
// HandlerMethod 返回值处理器
private List<HandlerMethodReturnValueHandler> customReturnValueHandlers;
// 组合模式的 HandlerMethod 返回值处理器
private HandlerMethodReturnValueHandlerComposite returnValueHandlers;
// Http 消息转换器
private List<HttpMessageConverter<?>> messageConverters;
// MediaType 解决器(PS: 根据请求 uri 尾缀, 或 Header 中的信息, 来决定 MediaType)
private ContentNegotiationManager contentNegotiationManager = new ContentNegotiationManager();
// 对 Response 进行增强的 Advice
private final List<Object> responseBodyAdvice = new ArrayList<Object>();
// IOC 工厂类
private ApplicationContext applicationContext;
// 缓存异常处理类 key: 包含处理异常的方法, value: ExceptionHandlerMethodResolver <-- 这里包含了 Exception <--> method 的键值对
private final Map<Class<?>, ExceptionHandlerMethodResolver> exceptionHandlerCache = new ConcurrentHashMap<Class<?>, ExceptionHandlerMethodResolver>(64);
// 被 @ControllerAdvice 注解修饰的的处理类, 再被包装成 ExceptionHandlerMethodResolver
private final Map<ControllerAdviceBean, ExceptionHandlerMethodResolver> exceptionHandlerAdviceCache = new LinkedHashMap<ControllerAdviceBean, ExceptionHandlerMethodResolver>();

而对应的激活方法主要如下:

// 这里是获取 能处理异常 Exception 的handler, 并且封装成 ServletInvocableHandlerMethod
// (PS: InvocableHandlerMethod 主要是激活方法, 并且通过 HandlerMethodReturnValueHandler 来处理一下返回值, 这里的参数 providedArgs 是首选参数, 比如说异常处理的 InvocableHandlerMethod, 这时会传来参数 Exception, cause)
ServletInvocableHandlerMethod exceptionHandlerMethod = getExceptionHandlerMethod(handlerMethod, exception);
if (exceptionHandlerMethod == null) return null;
// 给 ServletInvocableHandlerMethod 设置 argumentResolver
exceptionHandlerMethod.setHandlerMethodArgumentResolvers(this.argumentResolvers);
// 给 ServletInvocableHandlerMethod 设置 returnValueHandler
exceptionHandlerMethod.setHandlerMethodReturnValueHandlers(this.returnValueHandlers);  
// 封装统一的 Request 类
ServletWebRequest webRequest = new ServletWebRequest(request, response);
ModelAndViewContainer mavContainer = new ModelAndViewContainer();

try {
    logger.debug("Invoking @ExceptionHandler method: " + exceptionHandlerMethod);
    Throwable cause = exception.getCause();
    if (cause != null) { // Expose cause as provided argument as well // 激活处理异常的方法 (首选参数是 exception, cause)
        exceptionHandlerMethod.invokeAndHandle(webRequest, mavContainer, exception, cause, handlerMethod);
    } else { // 若 cause == null, 则只传递 exception
        exceptionHandlerMethod.invokeAndHandle(webRequest, mavContainer, exception, handlerMethod);
    }
}catch (Throwable invocationEx) {
    return null;
}

6. 总结

总体上 HandlerExceptionResolver 的设计体系和HandlerMethodArgumentResolver 差不多, 设计上夹杂着策略, 模版, 适配器 等等, 而我们常用的 @ ExceptionHandler 就是通过ExceptionHandlerExceptionResolver 来解决的(PS: 将异常信息及Cause 作为参数传入 InvocableHandlerMethod, 最终激活方法)!