SpringMVC請求流程源碼分析

2022 年 5 月 29 日
筆記
SpringMVC, 源碼分析

一、SpringMVC使用

1.工程創建

創建maven工程。
添加java、resources目錄。
引入Spring-webmvc 依賴。

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>5.3.4</version>
</dependency>

刪除 src/main/webapp/WEB-INF/web.xml 配置文件。從tomcat的示例工程中找一份web.xml替換，這裡推薦從\webapps\ROOT\WEB-INF中拿，並且在其中添加context的監聽器和servlet配置，配置如下。

<!--Context 載入監聽器 -->
<listener>
     <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<servlet>
     <servlet-name>dispatcherServlet</servlet-name>
     <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
     <init-param>
     	 <param-name>contextConfigLocation</param-name>
         <param-value>classpath:application.xml</param-value>
     </init-param>
     <!--Web伺服器一旦啟動，Servlet就會實例化創建對象，然後初始化(預備創建對象)-->
     <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>dispatcherServlet</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>

在 resources 目錄中創建springmvc.xml文件，並添加如下配置：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="//www.springframework.org/schema/beans"
       xmlns:xsi="//www.w3.org/2001/XMLSchema-instance"
       xmlns:context="//www.springframework.org/schema/context"
       xmlns:mvc="//www.springframework.org/schema/mvc"
       xsi:schemaLocation="//www.springframework.org/schema/beans
                           //www.springframework.org/schema/beans/spring-beans.xsd
                           //www.springframework.org/schema/context
                           //www.springframework.org/schema/context/spring-context.xsd //www.springframework.org/schema/mvc //www.springframework.org/schema/mvc/spring-mvc.xsd">
    <!--配置spring包掃描路徑，被@Component、@Controller、@Service、@Repository標註的類都會交由Spring託管一個Bean-->
    <context:component-scan base-package="com.ybe.*"/>
    <!--配置視圖解析器-->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix" value="/"/>
        <property name="suffix" value=".jsp"></property>
    </bean>
</beans>

在 src/main/webapp/WEB-INF/下添加 applicationContext.xml文件，配置如下：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="//www.springframework.org/schema/beans"
       xmlns:xsi="//www.w3.org/2001/XMLSchema-instance"
       xmlns:context="//www.springframework.org/schema/context"
       xmlns:mvc="//www.springframework.org/schema/mvc"
       xsi:schemaLocation="//www.springframework.org/schema/beans
                           //www.springframework.org/schema/beans/spring-beans.xsd
                           //www.springframework.org/schema/context
                           //www.springframework.org/schema/context/spring-context.xsd //www.springframework.org/schema/mvc //www.springframework.org/schema/mvc/spring-mvc.xsd">
</beans>

創建Controller類，程式碼如下：

package com.ybe.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class HelloController {

    @RequestMapping("/hello")
    public String helloWorld(){
        System.out.println("hello world");
        return "index";
    }
}

2.工程配置

點擊Add Configurations或者Run->Add Configurations。
配置本地tomcat的目錄
配置瀏覽器地址，點擊上圖左上角的 + 號，選擇Tomcat Server選項後，點擊 Deployment 選項，點擊右邊的 + 號。
選擇Artifacts後，選擇springMvcTest:war。

3.啟動工程

二、SpringMVC啟動過程

SpringMVC是依賴Java的Web容器技術，整個springmvc的啟動過程是建立在Servlet技術基礎上的。SpringMVC藉助Web容器和Servelt的生命周期進行了擴展。父容器的初始化在 ContextLoaderListener 類中initWebApplicationContext方法進行，子容器的初始化在 DispatcherServlet 中init方法中進行。

1.父容器啟動過程

如果web.xml中配置了ContextLoaderListener監聽器，則web容器啟動的時候先會調用監聽器ContextLoaderListener的initWebApplicationContext方法。整個過程如下圖：

initWebApplicationContext中的整個過程就是創建了一個spring容器（父容器），並且根據springApplication.xml的配置內容往Spring容器中注入Bean對象。最後把spring容器（this.context對象）放入serveltContext 的屬性中。

2.子容器啟動過程（SpringMvc容器）

DispatcherServlet 是在web.xml配置文件中配置的Servlet類,是SpringMVC的請求分發核心類。所有的請求都由DispatcherServlet去分發處理。

DispatcherServlet 的繼承關係如下圖：

上圖可知DispatcherServlet 繼承了HttpServletBean。在HttpServletBean中重寫了init()，Web容器啟動的時候會根據配置文件中定義的Servlet進行創建，並且會根據配置項（load-on-startup）覺定在什麼時候調用Servlet的init方法，init方法在整個Servlet的生命周期中只會調用一次。初始化init方法的主體實現過程如下：

1.WebApplicationContextUtils.getWebApplicationContext(getServletContext()) 從ServletContext中獲取屬性為WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE的對象，即Spring父容器對象。

2.wac.addApplicationListener(new SourceFilteringListener(wac, new ContextRefreshListener()))，給子容器添加應用監聽器，該監聽器在後面的finishRefresh()方法中進行觸發，方法裡面封裝了初始化SpringMVC中九大組件的邏輯。

3.publishEvent(new ContextRefreshedEvent(this))發布Context刷新事件，會觸發SourceFilteringListener監聽器，最終進行initStrategies的調用。

3.九大組件的初始化

initStrategies是SpringMVC中九大組件的初始化方法其中9個方法對應9個組件的初始化，本文中只講映射器和適配器的創建過程，initStrategies程式碼如下：

// 初始化 MultipartResolver:主要用來處理文件上傳.如果定義過當前類型的bean對象，那麼直接獲取，如果沒有的話，可以為null
initMultipartResolver(context);
// 初始化 LocaleResolver:主要用來處理國際化配置,基於URL參數的配置(AcceptHeaderLocaleResolver)，基於session的配置(SessionLocaleResolver)，基於cookie的配置(CookieLocaleResolver)
initLocaleResolver(context);
// 初始化 ThemeResolver:主要用來設置主題Theme
initThemeResolver(context);
// 初始化 HandlerMapping:映射器，用來將對應的request跟controller進行對應
initHandlerMappings(context);
// 初始化 HandlerAdapter:處理適配器，主要包含Http請求處理器適配器，簡單控制器處理器適配器，註解方法處理器適配器
initHandlerAdapters(context);
// 初始化 HandlerExceptionResolver:基於HandlerExceptionResolver介面的異常處理
initHandlerExceptionResolvers(context);
// 初始化 RequestToViewNameTranslator:當controller處理器方法沒有返回一個View對象或邏輯視圖名稱，並且在該方法中沒有直接往response的輸出流裡面寫數據的時候，spring將會採用約定好的方式提供一個邏輯視圖名稱
initRequestToViewNameTranslator(context);
// 初始化 ViewResolver: 將ModelAndView選擇合適的視圖進行渲染的處理器
initViewResolvers(context);
// 初始化 FlashMapManager: 提供請求存儲屬性，可供其他請求使用
initFlashMapManager(context);

1.處理器映射器的初始化

1.initHandlerMappings 初始化映射器，在此方法中第一步會獲取容器中實現了HandlerMapping的Bean對象，如果有則用自定義的HandlerMapping實現類作為this.handlerMappings的值；如果沒有自定義類，則獲取SpringMVC預先定義好的策略類。程式碼流程如下：

2.ClassPathResource resource = new ClassPathResource(DEFAULT_STRATEGIES_PATH, DispatcherServlet.class);獲取DispatcherServlet.properties資源文件，位置在spring-webmvc中，路徑resources/org/springframework/web/servlet/DispatcherServlet.properties，該資源文件中定義了SpringMVC組件的默認實現策略類，具體內容如下：

# Default implementation classes for DispatcherServlet's strategy interfaces.
# Used as fallback when no matching beans are found in the DispatcherServlet context.
# Not meant to be customized by application developers.
org.springframework.web.servlet.LocaleResolver=org.springframework.web.servlet.i18n.AcceptHeaderLocaleResolver
org.springframework.web.servlet.ThemeResolver=org.springframework.web.servlet.theme.FixedThemeResolver

org.springframework.web.servlet.HandlerMapping=org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping,org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping,org.springframework.web.servlet.function.support.RouterFunctionMapping

org.springframework.web.servlet.HandlerAdapter=org.springframework.web.servlet.mvc.HttpRequestHandlerAdapter,org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter,org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter,org.springframework.web.servlet.function.support.HandlerFunctionAdapter
    org.springframework.web.servlet.HandlerExceptionResolver=org.springframework.web.servlet.mvc.method.annotation.ExceptionHandlerExceptionResolver,org.springframework.web.servlet.mvc.annotation.ResponseStatusExceptionResolver,org.springframework.web.servlet.mvc.support.DefaultHandlerExceptionResolver

org.springframework.web.servlet.RequestToViewNameTranslator=org.springframework.web.servlet.view.DefaultRequestToViewNameTranslator

org.springframework.web.servlet.ViewResolver=org.springframework.web.servlet.view.InternalResourceViewResolver

org.springframework.web.servlet.FlashMapManager=org.springframework.web.servlet.support.SessionFlashMapManager

由內容可知HandlerMapping 預製的策略類有 BeanNameUrlHandlerMapping、RequestMappingHandlerMapping、RouterFunctionMapping，其中 RequestMappingHandlerMapping 是我們常用的 HandlerMapping對象。

3.RequestMappingHandlerMapping 的初始化，因為RequestMappingHandlerMapping 實現了InitializingBean介面，所以在容器中初始化完之後會執行afterPropertiesSet方法，其中會調用super.afterPropertiesSet();父類為AbstractHandlerMethodMapping。此方法中會調用initHandlerMethods()，程式碼如下：

protected void initHandlerMethods() {
    // 遍歷 Bean ，逐個處理
    for (String beanName : getCandidateBeanNames()) {
        // 排除目標代理類，AOP 相關，可查看注釋
        if (!beanName.startsWith(SCOPED_TARGET_NAME_PREFIX)) {
            // 處理 Bean
            processCandidateBean(beanName);
        }
    }
    // 初始化處理器的方法們，目前沒有特殊業務邏輯，只是列印日誌
    handlerMethodsInitialized(getHandlerMethods());
}

4.processCandidateBean方法中會判斷BeanName的Bean是否有Controller.class或者RequestMapping.class註解來生成具體的HandlerMethod對象。

2.處理器適配器的初始化

1.initHandlerAdapters 適配器初始化,過程和映射器相似。從上面的內容可知HandlerAdapter與之的策略類有 HttpRequestHandlerAdapter、SimpleControllerHandlerAdapter、RequestMappingHandlerAdapter、HandlerFunctionAdapter。其中 RequestMappingHandlerAdapter 是我們常用的處理器適配器。

2.RequestMappingHandlerAdapter實現了InitializingBean介面，在容器中初始化完之後會調用afterPropertiesSet方法，在此方法中會初始化參數解析器、綁定參數解析器、返回值解析器。此方法程式碼如下：

@Override
public void afterPropertiesSet() {
    // Do this first, it may add ResponseBody advice beans
    // 初始化注釋了@ControllerAdvice的類的相關屬性
    initControllerAdviceCache();

    // 初始化 argumentResolvers 屬性
    if (this.argumentResolvers == null) {
        List<HandlerMethodArgumentResolver> resolvers = getDefaultArgumentResolvers();
        this.argumentResolvers = new HandlerMethodArgumentResolverComposite().addResolvers(resolvers);
    }
    // 初始化 initBinderArgumentResolvers 屬性
    if (this.initBinderArgumentResolvers == null) {
        List<HandlerMethodArgumentResolver> resolvers = getDefaultInitBinderArgumentResolvers();
        this.initBinderArgumentResolvers = new HandlerMethodArgumentResolverComposite().addResolvers(resolvers);
    }
    // 初始化 returnValueHandlers 屬性
    if (this.returnValueHandlers == null) {
        List<HandlerMethodReturnValueHandler> handlers = getDefaultReturnValueHandlers();
        this.returnValueHandlers = new HandlerMethodReturnValueHandlerComposite().addHandlers(handlers);
    }
}

4.攔截器的初始化

因為所有的HandlerMapping預製的策略類都繼承了AbstractHandlerMapping ，而AbstractHandlerMapping 實現了ApplicationContextAware介面，所以在具體的HandlerMapping策略類初始化完之後會調用initApplicationContext方法，該方法中具體實現了攔截器的創建，程式碼如下：

protected void initApplicationContext() throws BeansException {
    // 空實現，交給子類實現，用於註冊自定義的攔截器到interceptors中，目前暫無子類實現
    extendInterceptors(this.interceptors);
    // 掃描已註冊的MappedInterceptor的Bean們，添加到adaptedInterceptors中
    detectMappedInterceptors(this.adaptedInterceptors);
    // 將interceptors初始化成 HandlerInterceptor類型，添加到adaptedInterceptors中
    initInterceptors();
}

三、SpringMVC請求過程

1.請求流程圖

2.業務描述

1.請求進來後會調用FrameworkServlet的service()方法，該方法中會調用(HttpServlet) super.service 方法，其中會調用doXXX()方法，而doXXX()方法在FrameworkServlet重寫，每個doXXX()方法中又會調用processRequest(request, response)方法，processRequest中會調用doService()，doService()中又會調用doDispatch()，整個業務處理邏輯定義在doDispatch方法中。

2.循環遍歷在啟動過程中創建的handlerMapping處理器映射器集合查找對應處理器，傳入參數為 request 請求對象，返回的是HandlerExecutionChain類型的對象，程式碼如下

protected HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception {
    if (this.handlerMappings != null) {
        //遍歷
        for (HandlerMapping mapping : this.handlerMappings) {
            HandlerExecutionChain handler = mapping.getHandler(request);
            if (handler != null) {
                return handler;
            }
        }
    }
    return null;
}

在getHandler方法中如果找到具體的handler對象(HandlerMethod類型)，會繼續封裝handler對象為一個executionChain處理器鏈鏈對象(HandlerExecutionChain類型)，程式碼如下：

Object handler = getHandlerInternal(request);
if (handler == null) {
	handler = getDefaultHandler();
}
// 如果handler為null 即返回null。說明當前的處理器映射器不匹配。
if (handler == null) {
	return null;
}
// Bean name or resolved handler?
if (handler instanceof String) {
    String handlerName = (String) handler;
    handler = obtainApplicationContext().getBean(handlerName);
}

// Ensure presence of cached lookupPath for interceptors and others
if (!ServletRequestPathUtils.hasCachedPath(request)) {
	initLookupPath(request);
}
//創建處理器鏈
HandlerExecutionChain executionChain = getHandlerExecutionChain(handler, request);

getHandlerInternal是多態方法，具體的實現類中有不同的實現方式。查找具體的HandlerMethod邏輯比較複雜，請自行查看源碼。

3.循環遍歷在啟動過程中創建的handlerAdapters處理器適配器集合查找對應處理器適配器，傳入參數為handler處理器對象，返回的是RequestMappingHandlerAdapter類型的處理器適配器，程式碼如下：

protected HandlerAdapter getHandlerAdapter(Object handler) throws ServletException {
    if (this.handlerAdapters != null) {
        //循環判斷哪個適配器能處理傳入的處理器
        for (HandlerAdapter adapter : this.handlerAdapters) {
            if (adapter.supports(handler)) {
                return adapter;
            }
        }
    }
    throw new ServletException("No adapter for handler [" + handler +
                               "]: The DispatcherServlet configuration needs to include a HandlerAdapter that supports this handler");
}

4.循環執行mappedHandler(HandlerExecutionChain攔截器鏈)對象的攔截器preHandle方法。

5.處理器適配器調用處理方法，最終會執行ServletInvocableHandlerMethod.invokeAndHandle()方法，此方法中會調用invokeForRequest，invokeForRequest中會先拿到Controller中方法的具體參數值，再執行該方法，最後會返回ModelAndView對象。

6.循環執行mappedHandler(HandlerExecutionChain攔截器鏈)對象的攔截器postHandle方法。

7.processDispatchResult方法中會先查找找到具體的視圖引擎，程式碼如下：

protected View resolveViewName(String viewName, @Nullable Map<String, Object> model,
                               Locale locale, HttpServletRequest request) throws Exception {
    if (this.viewResolvers != null) {
        for (ViewResolver viewResolver : this.viewResolvers) {
            View view = viewResolver.resolveViewName(viewName, locale);
            if (view != null) {
                return view;
            }
        }
    }
    return null;
}

然後渲染視圖內容，底層其實就是請求的轉發，程式碼如下：

public void render(@Nullable Map<String, ?> model, HttpServletRequest request,
                   HttpServletResponse response) throws Exception {
    if (logger.isDebugEnabled()) {
        logger.debug("View " + formatViewName() +
                     ", model " + (model != null ? model : Collections.emptyMap()) +
                     (this.staticAttributes.isEmpty() ? "" : ", static attributes " + this.staticAttributes));
    }
    //合併返回結果，將 Model 中的靜態數據和請求中的動態數據進行合併
    Map<String, Object> mergedModel = createMergedOutputModel(model, request, response);
    prepareResponse(request, response);
    //進行渲染
    renderMergedOutputModel(mergedModel, getRequestToExpose(request), response);
}

8.循環執行mappedHandler(HandlerExecutionChain攔截器鏈)對象的攔截器afterCompletion方法。

Tags: SpringMVC 源碼分析