乐趣区

SpringBoot源码解析-TomcatSpringMVC启动

jiezi

本文通过阅读 SpringBoot 源码，分享 SpringBoot 中 Tomcat，SpringMvc 组件的启动过程。
源码分析基于 spring boot 2.1

Tomcat

在解析 SpringBoot 启动的文章中说过，SERVLET 应用使用的 ApplicationContext 是 AnnotationConfigServletWebServerApplicationContext。
其父类 ServletWebServerApplicationContext，通过 ServletWebServerFactory 创建并初始化 WebServer，WebServer 兼容不同的 servlet 容器（tomcat，jetty，netty），提供统一的 start，stop 操作。
ServletWebServerApplicationContext 还负责注册 Servlet，Filter，ServletContextListener 的工作。
ServletWebServerApplicationContext#servletConfig，GenericWebApplicationContext#servletContext 都是 servlet 规范提供的类。

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 创建 webServer，注意 getSelfInitializer()通过方法引用构造了一个 ServletContextInitializer，该 ServletContextInitializer 会调用 ServletWebServerApplicationContext#selfInitialize 方法
#2 webServer 已经存在，直接调用 ServletWebServerApplicationContext#selfInitialize

ServletWebServerFactoryConfiguration 中判断当前 JAVA 环境中存在的 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 规范提供的类，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 线程都是后台线程，所以要创建一个阻塞的非后台线程保持进程。

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 规范提供的）
这些注解由 @ServletComponentScan 注解处理，@ServletComponentScan 注解通过 @Import 引入 ServletComponentScanRegistrar，ServletComponentScanRegistrar 实现了 ImportBeanDefinitionRegistrar（关于 ImportBeanDefinitionRegistrar 接口，可以回顾之前解析 SpringBoot AutoConfigure 的文章），ServletComponentScanRegistrar#registerBeanDefinitions 引入了 ServletComponentRegisteringPostProcessor，
该 PostProcessor 扫描对应目录下的 @WebFilter，@WebListener，@WebServlet 注解，使用对应的 ServletComponentHandler 进行处理。有兴趣的同学可以自行阅读代码。

如果您觉得本文不错，欢迎关注我的微信公众号，您的关注是我坚持的动力！

退出移动版