@ControllerAdvice注解原理

1. 啟動(dòng)時(shí)掃描 @ControllerAdvice 注解

在 Spring Boot 應(yīng)用程序啟動(dòng)過(guò)程中，Spring 會(huì)掃描所有的類(lèi)，尋找?guī)в?@ControllerAdvice 注解的類(lèi)。

這是通過(guò) ConfigurationClassPostProcessor 和 ComponentScanAnnotationParser 來(lái)完成的。

這些類(lèi)會(huì)被實(shí)例化并作為 Spring Bean 注入到 Spring 容器中。

2. ControllerAdviceBeanPostProcessor

ControllerAdviceBeanPostProcessor 是一個(gè)實(shí)現(xiàn)了 BeanPostProcessor 接口的類(lèi)。

在應(yīng)用程序啟動(dòng)過(guò)程中，所有 Bean 初始化之后，ControllerAdviceBeanPostProcessor 的 postProcessAfterInitialization 方法會(huì)被調(diào)用。

該方法負(fù)責(zé)處理帶有 @ControllerAdvice 注解的類(lèi)；

postProcessAfterInitialization：

@Override
public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
    if (bean instanceof ControllerAdviceBean) {
        ControllerAdviceBean adviceBean = (ControllerAdviceBean) bean;
        Class<?> beanType = adviceBean.getBeanType();
        if (beanType != null) {
            ExceptionHandlerMethodResolver resolver = new ExceptionHandlerMethodResolver(beanType);
            if (resolver.hasExceptionMappings()) {
                this.exceptionHandlerAdviceCache.put(adviceBean, resolver);
            }
        }
    }
    return bean;
}

3. ExceptionHandlerMethodResolver

在上述 ControllerAdviceBeanPostProcessor 的方法中，會(huì)創(chuàng)建 ExceptionHandlerMethodResolver 實(shí)例來(lái)掃描帶有 @ControllerAdvice 注解的類(lèi)中的所有方法，找到使用了 @ExceptionHandler 注解的異常處理方法。這些方法會(huì)被添加到一個(gè)映射表中，以便后續(xù)處理異常時(shí)能找到對(duì)應(yīng)的處理方法。

4. 注冊(cè)異常處理方法

在 ControllerAdviceBeanPostProcessor 中，異常處理方法會(huì)被注冊(cè)到一個(gè)全局的異常處理器映射表（exceptionHandlerAdviceCache）中。

映射表將異常類(lèi)型與相應(yīng)的處理方法關(guān)聯(lián)起來(lái)，以便在發(fā)生異常時(shí)能夠找到正確的處理方法。

5. 請(qǐng)求處理和異常捕獲

當(dāng) Spring Boot 應(yīng)用程序接收到一個(gè)請(qǐng)求時(shí)，它會(huì)將請(qǐng)求分派給相應(yīng)的 Controller 方法。

在執(zhí)行 Controller 方法時(shí)，如果拋出了異常，DispatcherServlet 會(huì)將異常傳遞給 HandlerExceptionResolver 來(lái)處理。

在這里，ExceptionHandlerExceptionResolver 會(huì)被調(diào)用。

6. ExceptionHandlerExceptionResolver

ExceptionHandlerExceptionResolver 類(lèi)負(fù)責(zé)在全局異常處理器映射表（exceptionHandlerAdviceCache）中查找與異常類(lèi)型關(guān)聯(lián)的處理方法，并執(zhí)行這個(gè)方法來(lái)處理異常。

具體實(shí)現(xiàn)在 doResolveHandlerMethodException 方法中：

protected ModelAndView doResolveHandlerMethodException(HttpServletRequest request, HttpServletResponse response, HandlerMethod handlerMethod, Exception exception) {
    // ...
    ServletInvocableHandlerMethod exceptionHandlerMethod = getExceptionHandlerMethod(handlerMethod, exception);
    if (exceptionHandlerMethod == null) {
       return null;
   }
   // ...
   try {
       exceptionHandlerMethod.invokeAndHandle(webRequest, mavContainer, exceptionResult);
   } catch (Exception invocationEx) {
       // ...
   }
   // ...
   return ModelAndViewResolver.UNRESOLVED;
}

在這個(gè)方法中，`ExceptionHandlerExceptionResolver` 會(huì)根據(jù)異常類(lèi)型查找對(duì)應(yīng)的處理方法。

如果找到了適合的處理方法，它將使用 `ServletInvocableHandlerMethod` 類(lèi)的實(shí)例來(lái)執(zhí)行該方法，并將異常處理結(jié)果（通常是一個(gè) ModelAndView 對(duì)象或 ResponseEntity 對(duì)象）返回給客戶(hù)端；

總結(jié)

`@ControllerAdvice` 的工作原理在 Spring Boot 應(yīng)用程序啟動(dòng)時(shí)涉及到多個(gè)組件和步驟；

在啟動(dòng)過(guò)程中，`ControllerAdviceBeanPostProcessor` 會(huì)掃描帶有 `@ControllerAdvice` 注解的類(lèi)，`ExceptionHandlerMethodResolver` 會(huì)掃描這些類(lèi)中的異常處理方法并將它們注冊(cè)到全局異常處理器映射表中。當(dāng)請(qǐng)求處理過(guò)程中發(fā)生異常時(shí)，`ExceptionHandlerExceptionResolver` 會(huì)從映射表中查找并執(zhí)行相應(yīng)的異常處理方法；

到此這篇關(guān)于SpringBoot中的@ControllerAdvice注解原理詳解的文章就介紹到這了,更多相關(guān)@ControllerAdvice注解原理內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論