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

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

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

Tomcat

在解析SpringBoot啟動的文章中說過,SERVLET應(yīng)用使用的ApplicationContext是AnnotationConfigServletWebServerApplicationContext。
其父類ServletWebServerApplicationContext,通過ServletWebServerFactory創(chuàng)建并初始化WebServer,WebServer兼容不同的servlet容器(tomcat,jetty,netty),提供統(tǒng)一的start,stop操作。
ServletWebServerApplicationContext還負責注冊Servlet,F(xiàn)ilter,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()通過方法引用構(gòu)造了一個ServletContextInitializer,該ServletContextInitializer會調(diào)用ServletWebServerApplicationContext#selfInitialize方法
#2 webServer已經(jīng)存在,直接調(diào)用ServletWebServerApplicationContext#selfInitialize

ServletWebServerFactoryConfiguration中判斷當前JAVA環(huán)境中存在的servlet容器依賴,構(gòu)造對應(yīng)的WebServerFactory。
這里只關(guān)注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 構(gòu)造Tomcat對象,并配置相關(guān)屬性
#2 對Tomcat Context做一個預先配置
#3 轉(zhuǎn)化為Spring的TomcatWebServer對象

#2步驟會構(gòu)造一個TomcatStarter,TomcatStarter是一個ServletContainerInitializer實現(xiàn)類。ServletContainerInitializer也是servlet規(guī)范提供的類,servlet容器啟動后調(diào)用ServletContainerInitializer#onStartup。

TomcatStarter#initializers是ServletContextInitializer數(shù)組, TomcatStarter#onStartup會遍歷該數(shù)組,調(diào)用ServletContextInitializer#onStartup。
ServletWebServerApplicationContext#createWebServer方法#1步驟調(diào)用getSelfInitializer()方法構(gòu)造了一個ServletContextInitializer,該ServletContextInitializer一直傳遞給TomcatServletWebServerFactory#getWebServer,并用于構(gòu)造TomcatStarter。
所以tomcat啟動后最終會調(diào)用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獲取相關(guān)屬性,并設(shè)置到SpringContext中。
#2 查找Spring上下文中的ServletContextInitializer,并調(diào)用onStartup方法。
ServletContextInitializer是一個配置接口,通過編程的方式配置Servlet 3.0+ ServletContext。
它的實現(xiàn)類FilterRegistrationBean,ServletRegistrationBean,ServletListenerRegistrationBean 可以向ServletContext注入Filter,Servlet,ServletContextListener。

TomcatWebServer#構(gòu)造函數(shù) -> 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,并配置相關(guān)屬性
#3 啟動Tomcat,并調(diào)用ServletContainerInitializer#onStartup
#4 綁定ClassLoader
#5 因為所有tomcat線程都是后臺線程,所以要創(chuàng)建一個阻塞的非后臺線程保持進程。

SpringMVC

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

WebMvcAutoConfiguration負責構(gòu)造RequestMappingHandlerAdapter,HandlerMethodReturnValueHandler,HttpMessageConverter,RequestMappingHandlerMapping等組件
DispatcherServletAutoConfiguration負責構(gòu)造DispatcherServlet組件
關(guān)于SpringMVC,可以參考之前的文章 -- Spring Mvc原理

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

@WebFilter,@WebListener,@WebServlet也可以注入Servlet,F(xiàn)ilter,ServletContextListener。(這三個接口都是servlet規(guī)范提供的)
這些注解由@ServletComponentScan注解處理,@ServletComponentScan注解通過@Import引入ServletComponentScanRegistrar,ServletComponentScanRegistrar實現(xiàn)了ImportBeanDefinitionRegistrar(關(guān)于ImportBeanDefinitionRegistrar接口,可以回顧之前解析SpringBoot AutoConfigure的文章),ServletComponentScanRegistrar#registerBeanDefinitions引入了ServletComponentRegisteringPostProcessor,
該PostProcessor掃描對應(yīng)目錄下的@WebFilter,@WebListener,@WebServlet注解,使用對應(yīng)的ServletComponentHandler進行處理。有興趣的同學可以自行閱讀代碼。

如果您覺得本文不錯,歡迎關(guān)注我的微信公眾號,您的關(guān)注是我堅持的動力!


最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

友情鏈接更多精彩內(nèi)容