SpringBoot内嵌Tomcat的实现原理解析

淡淡的烟草味﹌ 2022-12-12 12:25 236阅读 0赞

### 一、序言 ###

使用SpringBoot经常会使用内嵌的tomcat做为项目的启动容器，本文将从源码的角度出发，剖析SpringBoot内嵌Tomcat的实现原理，讨论Tomcat何时创建、何时启动以及怎么启动。

### 二、引入Tomcat组件 ###

导入依赖：

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

项目启动：

@SpringBootApplication
    public class Application { 
        public static void main(String[] args) { 
            SpringApplication.run(Application.class, args);
        }
    }

以上是一段常见的SpringBoot项目依赖和启动的代码。引入`spring-boot-starter-web`同时会默认引入`spring-boot-starter-tomcat`，即Tomcat启动的相关环境。而对于项目启动代码，`@SpringBootApplication`主要实现Spring组件扫描和自动配置。该注解是复合注解，其中`@EnableAutoConfiguration`本身也是一个复合注解，包含以下内容：

@AutoConfigurationPackage
    @Import(AutoConfigurationImportSelector.class)
    public @interface EnableAutoConfiguration { 
    }

这两个注解比较关键。`@AutoConfigurationPackage`主要实现自动配置包，会扫描`@SpringbootApplication`标注的类所在包名及其子包，将创建的组件添加到容器中；而`@Import`则是导入了AutoConfigurationImportSelector.class，实现查找classpath上所有jar包中的META-INF/spring.factories，找出其中的自动配置类并导入到容器中，其中Web容器所对应的自动配置类为ServletWebServerFactoryAutoConfiguration。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hzZjE1NzY4NjE1Mjg0_size_16_color_FFFFFF_t_70_pic_center]  
ServletWebServerFactoryAutoConfiguration中支持好几种web容器，比如Tomcat、Jetty和Undertow。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hzZjE1NzY4NjE1Mjg0_size_16_color_FFFFFF_t_70_pic_center 1]  
而EmbeddedTomcat则是Tomcat组件相关的类，本身是一个FactoryBean，用来实例化TomcatServletWebServerFactory。此时TomcatServletWebServerFactory中就包含了创建和启动Tomcat的方法getWebServer()。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hzZjE1NzY4NjE1Mjg0_size_16_color_FFFFFF_t_70_pic_center 2]

### 三、Tomcat组件启动 ###

SpringBoot是在项目启动的时候才同时启动Tomcat的，很显然getWebServer()是在项目启动的过程中调用的。跟踪SpringApplication的run()，其中存在refreshContext(context)，此时主要完成容器的刷新。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hzZjE1NzY4NjE1Mjg0_size_16_color_FFFFFF_t_70_pic_center 3]  
容器刷新跟踪到最后是AbstractApplicationContext中的onRefresh()，显然这是一个钩子函数，应用了模板方法，查看所有的实现方法，其中有一个ServletWebServerApplicationContext，则是当前Web容器的实现。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hzZjE1NzY4NjE1Mjg0_size_16_color_FFFFFF_t_70_pic_center 4]

而ServletWebServerApplicationContext中主要是去获得ServletWebServerFactory对象，同时调用getWebServer创建WebServer对象。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hzZjE1NzY4NjE1Mjg0_size_16_color_FFFFFF_t_70_pic_center 5]  
此时，主要处理的是Tomcat容器对象的创建、环境配置和启动。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hzZjE1NzY4NjE1Mjg0_size_16_color_FFFFFF_t_70_pic_center 6]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hzZjE1NzY4NjE1Mjg0_size_16_color_FFFFFF_t_70_pic_center 7]

### 四、总结 ###

到这里，基本就走完了内嵌Tomcat创建启动的整个流程。其实核心主要还是依赖于SpringBoot的自动配置。项目启动的过程中，扫描classpath下的META-INF/spring.factories，实例化工厂对象TomcatServletWebServerFactory，在调用run()方法的时候完成Tomcat对象的创建，环境设置和启动，从而实现Tomcat容器的自动化处理。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hzZjE1NzY4NjE1Mjg0_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/9b3fdb595ba64ccfb064469e135438e8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hzZjE1NzY4NjE1Mjg0_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221123/f814d92c1d644944a12d828651c00d60.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hzZjE1NzY4NjE1Mjg0_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221123/e0f736c0389f4be7bfc37b299dc20c99.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hzZjE1NzY4NjE1Mjg0_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20221123/ca3ca076e892498fa0083d7108fb8b08.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hzZjE1NzY4NjE1Mjg0_size_16_color_FFFFFF_t_70_pic_center 4]: /images/20221123/1f6ff34a1395489fb8b5ed3c145b6e83.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hzZjE1NzY4NjE1Mjg0_size_16_color_FFFFFF_t_70_pic_center 5]: /images/20221123/ae681348c51a467681432b631175ffd8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hzZjE1NzY4NjE1Mjg0_size_16_color_FFFFFF_t_70_pic_center 6]: /images/20221123/5661f15bff374172ab235fcbae742fee.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hzZjE1NzY4NjE1Mjg0_size_16_color_FFFFFF_t_70_pic_center 7]: /images/20221123/28cbb150cc224a66ae0b174deb065984.png