【Spring專題】「技術原理」從源碼角度去深入分析關於Spring的異常處理ExceptionHandler的實現原理

ExceptionHandler的作用

ExceptionHandler是Spring框架提供的一個註解，用於處理應用程序中的異常。當應用程序中發生異常時，ExceptionHandler將優先地攔截異常並處理它，然後將處理結果返回到前端。該註解可用於類級別和方法級別，以捕獲不同級別的異常。

在Spring中使用ExceptionHandler非常簡單，只需在需要捕獲異常的方法上註解@ExceptionHandler，然後定義一個方法，該方法將接收異常並返回異常信息，並將該異常信息展示給前端用戶。

ExceptionHandler的使用

說明：針對可能出問題的Controller，新增註解方法@ExceptionHandler，下面是一個基本的ExceptionHandler示例：

@RestController
public class ExceptionController {
	
    @ExceptionHandler(Exception.class)
    public ResponseEntity<String> handleException(Exception ex) {
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
                .body("An error occurred: " + ex.getMessage());
    }
    @RequestMapping("/test")
    public String test() throws Exception {
        throw new Exception("Test exception!");
    }
}

在上面的示例中，我們定義了一個叫做ExceptionController的類，該類是一個@RestController註解的控制器，它包括一個可以產生異常的請求處理程序，一個用於捕獲和處理異常的@ExceptionHandler方法。

@RequestMapping註解配置了一個名爲“/test”的API，該API將拋出一個異常，該異常將由我們上面的ExceptionHandler進行處理。當請求“/test”時，Controller方法將引發異常並觸發@ExceptionHandler方法。

在上面的@ExceptionHandler方法中，我們通過ResponseEntity將異常信息提供給客戶端，HTTP狀態碼設置爲500。這使客戶端了解已發生錯誤，並能夠在日誌中記錄異常信息以便日後調試。

總之，使用ExceptionHandler能夠更好的掌控應用的異常信息，使得應用在發生異常的時候更加可控，並且更加容易進行調試。

ExceptionHandler的注意事項

Controller類下多個@ExceptionHandler上的異常類型不能出現一樣的，否則運行時拋異常。
@ExceptionHandler下方法返回值類型支持多種，常見的ModelAndView，@ResponseBody註解標註，ResponseEntity等類型都OK.

源碼分析介紹

原理說明-doDispatch

代碼片段位於：org.springframework.web.servlet.DispatcherServlet#doDispatch

執行@RequestMapping方法拋出異常後，Spring框架 try-catch的方法捕獲異常, 正常邏輯發不發生異常都會走processDispatchResult流程，區別在於異常的參數是否爲null .

	HandlerExecutionChain mappedHandler = null;
	Exception dispatchException = null;
	ModelAndView mv = null;
    try{
        //根據請求查找handlerMapping找到controller
        mappedHandler=getHandler(request); 
        //找到處理器適配器HandlerAdapter
        HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler()); 
        if(!mappedHandler.applyPreHandle(request,response)){ 
            //攔截器preHandle
            return ;
        }      
        //調用處理器適配器執行@RequestMapping方法
        mv=ha.handle(request,response); 
        //攔截器postHandle
        mappedHandler.applyPostHandle(request,response,mv);  
    }catch(Exception ex){
        dispatchException=ex;
    }
    //將異常信息傳入了
    processDispatchResult(request,response,mappedHandler,mv,dispatchException)

原理說明-processDispatchResult

代碼片段位於：org.springframework.web.servlet.DispatcherServlet#processDispatchResult

如果 @RequestMapping 方法拋出異常，攔截器的postHandle方法不執行，進入processDispatchResult，判斷入參dispatchException，不爲null , 代表發生異常，調用processHandlerException處理。

原理說明-processHandlerException

代碼片段位於：org.springframework.web.servlet.DispatcherServlet#processHandlerException

this當前對象指dispatchServlet，handlerExceptionResolvers可以看到三個HandlerExceptionResolver，這三個是Spring框架幫我們註冊的，遍歷有序集合handlerExceptionResolvers，調用接口的resolveException方法。

註冊的第一個HandlerExceptionResolver.ExceptionHandlerExceptionResolver, 繼承關係如下面所示。

原理說明-AbstractHandlerExceptionResolver

代碼片段位於:org.springframework.web.servlet.handler.AbstractHandlerExceptionResolver#resolveException

這裏AbstractHandlerExceptionResolver的shouldApplyTo都返回true, logException用來記錄日誌、prepareResponse方法，用來設置response的Cache-Control。

異常處理方法就位於doResolveException

注意：AbstractHandlerExceptionResolver和AbstractHandlerMethodExceptionResolver名字看起來非常相似，但是作用不同，一個是面向整個類的，一個是面向方法級別的。

原理說明-AbstractHandlerMethodExceptionResolver

代碼片段位於:org.springframework.web.servlet.handler.AbstractHandlerMethodExceptionResolver#shouldApplyTo

接口方法實現AbstractHandlerExceptionResolver的resolveException，先判斷shouldApplyTo，AbstractHandlerExceptionResolver 和子類AbstractHandlerMethodExceptionResolver都實現了shouldApplyTo方法，子類的shouldApplyTo都調用父類AbstractHandlerExceptionResolver的shouldApplyTo.

父類AbstractHandlerExceptionResolver的shouldApplyTo方法.

代碼片段位於:org.springframework.web.servlet.handler.AbstractHandlerExceptionResolver#shouldApplyTo

Spring初始化的時候並沒有額外配置 , 所以mappedHandlers和mappedHandlerClasses都爲null, 可以在這塊擴展進行篩選，AbstractHandlerExceptionResolver提供了setMappedHandlerClasses 、setMappedHandlers用於擴展。

doResolveException

代碼片段位於：org.springframework.web.servlet.handler.AbstractHandlerMethodExceptionResolver#doResolveException

Spring請求方法執行一樣的處理方式，設置argumentResolvers、returnValueHandlers，之後進行調用異常處理方法。

獲取@ExceptionHandler

@ExceptionHandler的方法入參支持：Exception ；SessionAttribute 、 RequestAttribute註解、 HttpServletRequest 、HttpServletResponse、HttpSession。

@ExceptionHandler方法返回值常見的可以是: ModelAndView 、@ResponseBody註解、ResponseEntity。

getExceptionHandlerMethod方法

getExceptionHandlerMethod說明：獲取對應的@ExceptionHandler方法，封裝成ServletInvocableHandlerMethod返回。

exceptionHandlerCache是針對Controller層面的@ExceptionHandler的處理方式，而exceptionHandlerAdviceCache是針對@ControllerAdvice的處理方式. 這兩個屬性都位於ExceptionHandlerExceptionResolver中。

ExceptionHandlerMethodResolver，緩存A之前沒存儲過Controller的class ，所以新建一個ExceptionHandlerMethodResolver 加入緩存中，ExceptionHandlerMethodResolver 的初始化工作一定做了某些工作。

resolveMethod方法

根據異常對象讓 ExceptionHandlerMethodResolver 解析得到 method ，匹配到異常處理方法就直接封裝成對象 ServletInvocableHandlerMethod ；就不會再去走@ControllerAdvice裏的異常處理器了，這裏說明了。

resolveMethodByExceptionType根據當前拋出異常尋找匹配的方法，並且做了緩存，以後遇到同樣的異常可以直接走緩存取出

resolveMethodByExceptionType方法，嘗試從緩存A：exceptionLookupCache中根據異常class類型獲取Method ，初始時候肯定緩存爲空，就去遍歷ExceptionHandlerMethodResolver的mappedMethods(上面提及了key爲異常類型，value爲method，exceptionType爲當前@RequestMapping方法拋出的異常，判斷當前異常類型是不是@ExceptionHandler中value聲明的子類或本身，滿足條件就代表匹配上了；

可能存在多個匹配的方法，使用ExceptionDepthComparator排序，排序規則是按照繼承順序來(繼承關係越靠近數值越小，當前類最小爲0,頂級父類Throwable爲int最大值)，排序之後選取繼承關係最靠近的那個，並且ExceptionHandlerMethodResolver的exceptionLookupCache中，key爲當前拋出的異常，value爲解析出來的匹配method.

全局級別異常處理器實現HandlerExceptionResolver接口

public class MyHandlerExceptionResolver implements HandlerExceptionResolver {

    @Override

    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        ModelMap mmp=new ModelMap();
        mmp.addAttribute("ex",ex.getMessage());
        return new ModelAndView("error",mmp);
    }
}

使用方式：只需要將該Bean加入到Spring容器，可以通過Xml配置，也可以通過註解方式加入容器;
方法返回值不爲null纔有意義，如果方法返回值爲null，可能異常就沒有被捕獲.
缺點分析：比如這種方式全局異常處理返回JSP、velocity等視圖比較方便，返回json或者xml等格式的響應就需要自己實現了.如下是我實現的發生全局異常返回JSON的簡單例子.

public class MyHandlerExceptionResolver implements HandlerExceptionResolver {
    @Override
    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        System.out.println("發生全局異常!");
        ModelMap mmp=new ModelMap();
        mmp.addAttribute("ex",ex.getMessage());
        response.addHeader("Content-Type","application/json;charset=UTF-8");
        try {
            new ObjectMapper().writeValue(response.getWriter(),ex.getMessage());
            response.getWriter().flush();
        } catch (IOException e) {
            e.printStackTrace();
        }
        return new ModelAndView();
    }
}

全局級別異常處理器@ControllerAdvice+@ExceptionHandler使用方法

用法說明：這種情況下 @ExceptionHandler與第一種方式用法相同，返回值支持ModelAndView，@ResponseBody等多種形式。

@ControllerAdvice
public class GlobalController {
    @ExceptionHandler(RuntimeException.class)
    public ModelAndView fix1(Exception e){
        System.out.println("全局的異常處理器");
        ModelMap mmp=new ModelMap();
        mmp.addAttribute("ex",e);
        return new ModelAndView("error",mmp);
    }
}

方式一：提到ExceptionHandlerExceptionResolver不僅維護@Controller級別的@ExceptionHandler，同時還維護的@ControllerAdvice級別的@ExceptionHandler代碼片段位於：

isApplicableToBeanType方法是用來做條件判斷的，@ControllerAdvice註解有很多屬性用來設置條件，
basePackageClasses、assignableTypes、annotations等，比如我限定了annotations爲註解X，那標註了@X 的ControllerA就可以走這個異常處理器，ControllerB就不能走這個異常處理器。

現在問題的關鍵就只剩下了exceptionHandlerAdviceCache是什麼時候掃描@ControllerAdvice的，下面的邏輯和@ExceptionHandler的邏輯一樣了，exceptionHandlerAdviceCache初始化邏輯:

代碼片段位於:org.springframework.web.servlet.mvc.method.annotation.ExceptionHandlerExceptionResolver#afterPropertiesSet，afterPropertiesSet是Spring bean創建過程中一個重要環節。

代碼片段位於：org.springframework.web.servlet.mvc.method.annotation.ExceptionHandlerExceptionResolver#initExceptionHandlerAdviceCache

ControllerAdviceBean.findAnnotatedBeans方法查找了SpringMvc父子容器中標註 @ControllerAdvice 的bean, new ExceptionHandlerMethodResolver初始化時候解析了當前的@ControllerAdvice的bean的@ExceptionHandler,加入到ExceptionHandlerExceptionResolver的exceptionHandlerAdviceCache中，key爲ControllerAdviceBean，value爲ExceptionHandlerMethodResolver . 到這裏exceptionHandlerAdviceCache就初始化完畢。

Spring父子容器中所有@ControllerAdivce的bean的方法

代碼片段位於：org.springframework.web.method.ControllerAdviceBean#findAnnotatedBeans

遍歷了SpringMVC父子容器中所有的bean，標註ControllerAdvice註解的bean加入集合返回。

比較說明

@Controller+@ExceptionHandler、HandlerExceptionResolver接口形式、@ControllerAdvice+@ExceptionHandler優缺點說明：

調用優先級

@Controller+@ExceptionHandler優先級最高
@ControllerAdvice+@ExceptionHandler 略低
HandlerExceptionResolver最低。

三種方式並存的情況優先級越高的越先選擇，而且被一個捕獲處理了就不去執行其他的。

三種方式都支持多種返回類型

@Controller+@ExceptionHandler、@ControllerAdvice+@ExceptionHandler可以使用Spring支持的@ResponseBody、ResponseEntity。
HandlerExceptionResolver方法聲明返回值類型只能是 ModelAndView，如果需要返回JSON、xml等需要自己實現.。

緩存利用

@Controller+@ExceptionHandler的緩存信息在ExceptionHandlerExceptionResolver的exceptionHandlerCache，@ControllerAdvice+@ExceptionHandler的緩存信息在ExceptionHandlerExceptionResolver的exceptionHandlerAdviceCache中,
HandlerExceptionResolver接口是不做緩存的，在異常報錯的情況下才會走自己的HandlerExceptionResolver實現類，多少有點性能損耗.

【Spring專題】「技術原理」從源碼角度去深入分析關於Spring的異常處理ExceptionHandler的實現原理

ExceptionHandler的作用

ExceptionHandler的使用

ExceptionHandler的注意事項

源碼分析介紹

原理說明-doDispatch

原理說明-processDispatchResult

原理說明-processHandlerException

原理說明-AbstractHandlerExceptionResolver

原理說明-AbstractHandlerMethodExceptionResolver

父類AbstractHandlerExceptionResolver的shouldApplyTo方法.

doResolveException

獲取@ExceptionHandler

getExceptionHandlerMethod方法

resolveMethod方法

全局級別異常處理器實現HandlerExceptionResolver接口

全局級別異常處理器@ControllerAdvice+@ExceptionHandler使用方法

Spring父子容器中所有@ControllerAdivce的bean的方法

比較說明

調用優先級

三種方式都支持多種返回類型

緩存利用

【深入瞭解系統性能優化】「實戰技術專題」全方面帶你透徹探索服務優化技術方案（系統服務調優）

【Java技術專題】「攻破技術盲區」帶你攻破你很可能存在的Java技術盲點之動態性技術原理指南（反射技術專題）

【深入淺出Spring原理及實戰】「源碼調試分析」深入源碼探索Spring底層框架的的refresh方法所出現的問題和異常

【Spring專題】「技術原理」從源碼角度去深入分析關於Spring的異常處理ExceptionHandler的實現原理

【算法數據結構專題】「延時隊列算法」史上手把手教你針對層級時間輪（TimingWheel）實現延時隊列的開發實戰落地（下）

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結