SpringBoot源碼解析 -- Tomcat，SpringMVC啟動

SpringBoot深入理解 -- @AliasFor注解的作用
 SpringBoot源碼解析 -- SpringBoot啟動過程
 SpringBoot源碼解析 -- AutoConfigure的實現原理
 SpringBoot源碼解析 -- @ComponentScan的實現原理
 SpringBoot源碼解析 -- @Value,@Autowired實現原理
 SpringBoot源碼解析 -- Tomcat，SpringMVC啟動
 SpringBoot源碼解析 -- Logging，Environment啟動

本文通過閱讀SpringBoot源碼杈女，分享SpringBoot中Tomcat，SpringMvc組件的啟動過程。
源碼分析基于spring boot 2.1

Tomcat

在解析SpringBoot啟動的文章中說過达椰，SERVLET應用使用的ApplicationContext是AnnotationConfigServletWebServerApplicationContext翰蠢。
其父類ServletWebServerApplicationContext，通過ServletWebServerFactory創(chuàng)建并初始化WebServer啰劲，WebServer兼容不同的servlet容器（tomcat梁沧，jetty，netty）蝇裤，提供統(tǒng)一的start廷支，stop操作。
ServletWebServerApplicationContext還負責注冊Servlet猖辫，Filter酥泞，ServletContextListener的工作。
ServletWebServerApplicationContext#servletConfig啃憎，GenericWebApplicationContext#servletContext都是servlet規(guī)范提供的類芝囤。

ApplicationContext#run -> AnnotationConfigServletWebServerApplicationContext#refresh -> AbstractApplicationContext#refresh -> AbstractApplicationContext#onRefresh -> ServletWebServerApplicationContext#onRefresh -> ServletWebServerApplicationContext#createWebServer

private void createWebServer() {
    WebServer webServer = this.webServer;
    ServletContext servletContext = getServletContext();
    if (webServer == null && servletContext == null) {
        ServletWebServerFactory factory = getWebServerFactory();
        // #1 
        this.webServer = factory.getWebServer(getSelfInitializer());    
    }
    else if (servletContext != null) {
        try {
            // #2
            getSelfInitializer().onStartup(servletContext);     
        }
        catch (ServletException ex) {
            throw new ApplicationContextException("Cannot initialize servlet context", ex);
        }
    }
    initPropertySources();
}

#1 創(chuàng)建webServer，注意getSelfInitializer()通過方法引用構造了一個ServletContextInitializer辛萍，該ServletContextInitializer會調用ServletWebServerApplicationContext#selfInitialize方法
#2 webServer已經存在悯姊，直接調用ServletWebServerApplicationContext#selfInitialize

ServletWebServerFactoryConfiguration中判斷當前JAVA環(huán)境中存在的servlet容器依賴，構造對應的WebServerFactory贩毕。
這里只關注tomcat悯许。
TomcatServletWebServerFactory#getWebServer

public WebServer getWebServer(ServletContextInitializer... initializers) {
    // #1
    Tomcat tomcat = new Tomcat();   
    File baseDir = (this.baseDirectory != null) ? this.baseDirectory : createTempDir("tomcat");
    tomcat.setBaseDir(baseDir.getAbsolutePath());   
    Connector connector = new Connector(this.protocol);
    tomcat.getService().addConnector(connector);
    customizeConnector(connector);
    tomcat.setConnector(connector);
    tomcat.getHost().setAutoDeploy(false);
    configureEngine(tomcat.getEngine());
    for (Connector additionalConnector : this.additionalTomcatConnectors) {
        tomcat.getService().addConnector(additionalConnector);
    }
    // #2
    prepareContext(tomcat.getHost(), initializers); 
    // #3
    return getTomcatWebServer(tomcat);  
}

#1 構造Tomcat對象，并配置相關屬性
#2 對Tomcat Context做一個預先配置
#3 轉化為Spring的TomcatWebServer對象

#2步驟會構造一個TomcatStarter辉阶，TomcatStarter是一個ServletContainerInitializer實現類先壕。ServletContainerInitializer也是servlet規(guī)范提供的類，servlet容器啟動后調用ServletContainerInitializer#onStartup谆甜。

TomcatStarter#initializers是ServletContextInitializer數組垃僚， TomcatStarter#onStartup會遍歷該數組，調用ServletContextInitializer#onStartup规辱。
ServletWebServerApplicationContext#createWebServer方法#1步驟調用getSelfInitializer()方法構造了一個ServletContextInitializer谆棺，該ServletContextInitializer一直傳遞給TomcatServletWebServerFactory#getWebServer，并用于構造TomcatStarter罕袋。
所以tomcat啟動后最終會調用ServletWebServerApplicationContext#selfInitialize

private void selfInitialize(ServletContext servletContext) throws ServletException {
    // #1
    prepareWebApplicationContext(servletContext);   
    registerApplicationScope(servletContext);   
    WebApplicationContextUtils.registerEnvironmentBeans(getBeanFactory(), servletContext);
    // #2
    for (ServletContextInitializer beans : getServletContextInitializerBeans()) {   
        beans.onStartup(servletContext);
    }
}

#1 從ServletContext獲取相關屬性改淑，并設置到SpringContext中。
#2 查找Spring上下文中的ServletContextInitializer浴讯，并調用onStartup方法朵夏。
ServletContextInitializer是一個配置接口，通過編程的方式配置Servlet 3.0+ ServletContext榆纽。
它的實現類FilterRegistrationBean侍郭，ServletRegistrationBean询吴，ServletListenerRegistrationBean 可以向ServletContext注入Filter，Servlet亮元，ServletContextListener猛计。

TomcatWebServer#構造函數 -> TomcatWebServer#initialize

private void initialize() throws WebServerException {
    // #1
    logger.info("Tomcat initialized with port(s): " + getPortsDescription(false));  
    synchronized (this.monitor) {
        try {
            addInstanceIdToEngineName();
            // #2
            Context context = findContext();    
            context.addLifecycleListener((event) -> {
                if (context.equals(event.getSource()) && Lifecycle.START_EVENT.equals(event.getType())) {
                    removeServiceConnectors();
                }
            });

            // #3
            this.tomcat.start();    

            rethrowDeferredStartupExceptions();

            // #4
            try {
                ContextBindings.bindClassLoader(context, context.getNamingToken(), getClass().getClassLoader());    
            }
            catch (NamingException ex) {
                // Naming is not enabled. Continue
            }

            // #5
            startDaemonAwaitThread();   
        }
        catch (Exception ex) {
            stopSilently();
            destroySilently();
            throw new WebServerException("Unable to start embedded Tomcat", ex);
        }
    }
}

#1 打印Tomcat啟動日志
#2 獲取Tomcat Context，并配置相關屬性
#3 啟動Tomcat爆捞，并調用ServletContainerInitializer#onStartup
#4 綁定ClassLoader
#5 因為所有tomcat線程都是后臺線程奉瘤，所以要創(chuàng)建一個阻塞的非后臺線程保持進程。

SpringMVC

SpringMVC組件的啟動就比較簡單了煮甥。

WebMvcAutoConfiguration負責構造RequestMappingHandlerAdapter盗温，HandlerMethodReturnValueHandler，HttpMessageConverter成肘，RequestMappingHandlerMapping等組件
DispatcherServletAutoConfiguration負責構造DispatcherServlet組件
關于SpringMVC,可以參考之前的文章 -- Spring Mvc原理

DispatcherServletAutoConfiguration中使用DispatcherServletRegistrationBean將DispatcherServlet注冊到ServletContext卖局，DispatcherServletRegistrationBean繼承了ServletRegistrationBean，最后由ServletWebServerApplicationContext#selfInitialize完成注入操作双霍。

@WebFilter砚偶，@WebListener，@WebServlet也可以注入Servlet洒闸，Filter染坯，ServletContextListener。（這三個接口都是servlet規(guī)范提供的）
這些注解由@ServletComponentScan注解處理丘逸，@ServletComponentScan注解通過@Import引入ServletComponentScanRegistrar单鹿，ServletComponentScanRegistrar實現了ImportBeanDefinitionRegistrar（關于ImportBeanDefinitionRegistrar接口，可以回顧之前解析SpringBoot AutoConfigure的文章）深纲，ServletComponentScanRegistrar#registerBeanDefinitions引入了ServletComponentRegisteringPostProcessor仲锄，
該PostProcessor掃描對應目錄下的@WebFilter，@WebListener湃鹊，@WebServlet注解儒喊，使用對應的ServletComponentHandler進行處理。有興趣的同學可以自行閱讀代碼涛舍。

如果您覺得本文不錯澄惊，歡迎關注我的微信公眾號唆途，您的關注是我堅持的動力富雅！

SpringBoot源碼解析 -- Tomcat敷待，SpringMVC啟動

SpringBoot源碼解析 -- Tomcat厂抖，SpringMVC啟動

Tomcat

SpringMVC