1. HandlerExceptionResolver 概述
HandlerExceptionResolver: 在處理 handler 映射 或執(zhí)行 HandlerExecutionChain/Handler 拋出的異常信息, 一般是返回對應的 ModelAndView(PS: 設置 ViewName 與 Model 中的屬性信息), 其主接口如下:
// 針對 通過 path 獲取 handler 或 執(zhí)行handler時出現(xiàn)異常的處理類
public interface HandlerExceptionResolver {
// 通過解析異常查詢配置以得到符合條件的 ModelAndView 對象
ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex);
}
其主要實現(xiàn)類如下:
1. SimpleMappingExceptionResolver
在配置信息中配置 異常Class <-> ViewName的映射的 異常處理器
2. ResponseStatusExceptionResolver
根據(jù)異常 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, 當出現(xiàn)異常了, 就通過這個 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 返回的狀態(tài)值
private Integer defaultStatusCode;
// 這里配置的是 ViewName <--> Http Code 的映射關系
private Map<String, Integer> statusCodes = new HashMap<String, Integer>();
3. 根據(jù) Exception 上的注解 ResponseStatus 設置httpCode 的ResponseStatusExceptionResolver
這個異常處理類比較簡單, 主要是出了異常, 則根據(jù) Exception 上的注解@ResponseStatus 來獲取 HttpCode 與 ErrorMsg, 而返回的是一個空的 ModelAndView
4. 默認的異常處理類 DefaultHandlerExceptionResolver
這是一個根據(jù)異常的類型設置 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 參數(shù)解析器
private List<HandlerMethodArgumentResolver> customArgumentResolvers;
// 組合模式的 HandlerMethod 參數(shù)解析器
private HandlerMethodArgumentResolverComposite argumentResolvers;
// HandlerMethod 返回值處理器
private List<HandlerMethodReturnValueHandler> customReturnValueHandlers;
// 組合模式的 HandlerMethod 返回值處理器
private HandlerMethodReturnValueHandlerComposite returnValueHandlers;
// Http 消息轉換器
private List<HttpMessageConverter<?>> messageConverters;
// MediaType 解決器(PS: 根據(jù)請求 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 來處理一下返回值, 這里的參數(shù) providedArgs 是首選參數(shù), 比如說異常處理的 InvocableHandlerMethod, 這時會傳來參數(shù) Exception, cause)
ServletInvocableHandlerMethod exceptionHandlerMethod = getExceptionHandlerMethod(handlerMethod, exception);
if (exceptionHandlerMethod == null) return null;
// 給 ServletInvocableHandlerMethod 設置 argumentResolver
exceptionHandlerMethod.setHandlerMethodArgumentResolvers(this.argumentResolvers);
// 給 ServletInvocableHandlerMethod 設置 returnValueHandler
exceptionHandlerMethod.setHandlerMethodReturnValueHandlers(this.returnValueHandlers);
// 封裝統(tǒng)一的 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 // 激活處理異常的方法 (首選參數(shù)是 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 作為參數(shù)傳入 InvocableHandlerMethod, 最終激活方法)!
