深度解析SpringBoot内嵌Web容器

待我称王封你为后i 2023-10-12 22:01 4阅读 0赞

## 前言 ##

今天分享一个SpringBoot的内嵌Web容器，在SpringBoot还没有出现时，我们使用Java开发了Web项目，需要将其部署到Tomcat下面，需要配置很多xml文件，SpringBoot出现后，就从繁琐的xml文件中解脱出来了，SpringBoot将Web容器进行了内嵌，我们只需要将项目打成一个jar包，就可以运行了，大大省略了开发成本，那么SpringBoot是怎么实现的呢，我们今天就来详细介绍。

## SpringBoot提供的内嵌容器 ##

SpringBoot提供了四种Web容器，分别为Tomcat，Jetty，Undertow，Netty。

### Tomcat ###

Spring Boot 默认使用 Tomcat 作为嵌入式 Web 容器。Tomcat 作为一个流行的 Web 容器，容易能够理解、配置和管理。可以通过使用spring-boot-starter-web来启用 Tomcat 容器。

### Jetty ###

Jetty 同样是一个流行的嵌入式 Web 容器，它的缺省配置相对精简，从而有利快速启动。可以通过使用spring-boot-starter-jetty来启用 Jetty 容器。

### Undertow ###

Undertow 是一个由 JBoss 开发的轻量级的嵌入式 Web 服务器。它具有出色的性能和低资源占用率，是一个适合微服务实现的 Web 服务器。可以使用spring-boot-starter-undertow来启用 Undertow 容器。

### Netty ###

Netty是一个高性能的网络框架，需要引入spring-boot-starter-webflux和spring-boot-starter-reactor-netty来开启Netty作为Web容器。

## 使用 ##

因为SpringBoot默认的是Tomcat作为Web容器，如果我们需要使用使用其他Web容器，那么需要排除Tomcat容器，再引入其他容器，Tomcat容器位于spring-boot-starter-web模块下，所以我们需要在maven的pom.xml中移除Tomcat，如下。

xml复制代码<dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-web</artifactId>
          <version>3.0.2</version>
          <exclusions>
              <exclusion>
                  <groupId>org.springframework.boot</groupId>
                  <artifactId>spring-boot-starter-tomcat</artifactId>
              </exclusion>
          </exclusions>
    </dependency>

然后引入对应的Web容器，比如引入Undertow

xml复制代码<dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-undertow</artifactId>
    </dependency>

然后可以在yml文件中配置相应容器的参数，如下配置undertow.

yml复制代码server:
      port: 8080
      undertow:
        threads:
          worker: 10
          io: 10
        direct-buffers: true

其他web容器可以根据实际情况配置，从ServerProperties配置文件中可以查看对应的Web容器的相关配置。

![format_png][]

## 源码解析 ##

下面从源码进行分析，我们先使用SpringBoot的默认Web容器Tomcat进行分析。

那么源码应该从哪里看起呢，对于SpringBoot这么庞大复杂的项目，首先，我们在使用SpringBoot的时候，需要在application.yml文件中配置相关信息，比如端口，如果不配置端口，默认是8080，那么这个端口肯定是web容器的端口，如果是Tomcat，那么Tomcat就设置为这个端口，Undertow也是，依此类推。

那么这里就是一个入口，在SpringBoot中，我们要获取yml文件中的配置信息，一般是通过`@ConfigurationProperties`注解，我们可以按住ctrl，然后鼠标点击这个port，就能跳到对应的属性类里面。

![format_png 1][]

属性类ServerProperties就是专门获取yml文件中的配置，然后以供使用。

![format_png 2][]

到了属性类里面后，我们继续ctrl，然后会弹出很多类，如下所示。

![format_png 3][]

因为我们使用的是Tomcat，那么就选择一个Tomcat相关的类，我们选择`TomcatWebServerFactoryCustomizer`，这个类实现了接口`WebServerFactoryCustomizer`，并实现了方法customize。

![format_png 4][]

customize的参数是`ConfigurableTomcatWebServerFactory`，它是一个接口，它还继承了接口`ConfigurableWebServerFactory`，我们从`ConfigurableWebServerFactory`中看出里面有设置端口，地址等方法。

![format_png 5][]

我们再回头看`ConfigurableTomcatWebServerFactory`，可以看出里面是一些Tomcat相关的方法。

![format_png 6][]

然后继续看`ConfigurableUndertowWebServerFactory`,可以看出里面是对Undertow的一些属性设置的方法。

![format_png 7][]

我们回到`TomcatWebServerFactoryCustomizer`类中，SpringBoot使用了它的`PropertyMapper`类对属性进行设置，我们可以看出它使用propertyMapper.from().to()语法，其实就是将ServerProperties中的属性设置到ConfigurableTomcatWebServerFactory中，这个属性设置是在Spring对Bean进行初始化时候设置的，使用的是Spring的后置处理器来实现的，后面我们继续说。

![format_png 8][]

然后我们继续看一下`TomcatWebServerFactoryCustomizer`，他有一个构造函数，参数是Environment和ServerProperties，那么就证明其他地方对其进行了new操作。

![format_png 9][]

我们也是用ctrl套路，点击构造函数后跳到了`EmbeddedWebServerFactoryCustomizerAutoConfiguration`自动装配类中，这个类中有四个静态类，我们可以看出，他们的作用都是创建对应的定制器Bean，其实就是将yml文件中的Web容器配置进行装配，以供后面使用。

![format_png 10][]

上面说的这一堆其实就是SpringBoot的自动装配，其目的就是创建对应的Customizer，因为每个Web容器的配置项不一样，所以就需要不同的Customizer和Factory。

> 上面说了这么多，怎么感觉和源码没关系呢，没错，其实上面说的并不是核心源码，那么怎么找到核心源码呢？我们思考一下，既然上面是部分源码，那么源码肯定会执行到这里。

### 查看调用链 ###

我们在上面的`TomcatWebServerFactoryCustomizer`类中的`customize`方法中打一个断点，然后debug，于是得到调用链如下。

![format_png 11][]

我们可以看出会调用`onRefresh()`方法，因为`AbstractApplicationContext`使用的是**模板方法**模式，具体的实现交给子类实现，因为使用的是Tomcat，所以交给了`ServletWebServerApplicationContext`类来实现，具体的子类里面有一个`createWebServer()`方法，它就是创建Web容器。

![format_png 12][]

具体实现如下，如下是Tomcat的实现，里面会涉及到两个重要的接口`WebServer`和`WebServerFactory`。

![format_png 13][]

### WebServer ###

WebServer是容器的顶层接口，具体实现交给具体的容器实现类，如Tomcat则使用`TomcatWebServer`，Undertow则使用`UndertowWebServer`,Jetty，Netty也是如此。

此接口提供了一些方法，start()启动Web服务器，stop()停止Web服务器，getPort()获取服务器端口。

![format_png 14][]

不过对于start()和stop()，它们只是接口抽象的规范，在具体的实现中，也并不是全部都按照这个标准，start()方法上有备注`Starts the web server. Calling this method on an already started server has no effect.`，翻译为:`启动web服务器。在已启动的服务器上调用此方法无效。`，比如Tomcat的就没有在start()方法中启动服务器，具体我们等会会看。

### WebServerFactory ###

WebServerFactory是一个接口，没有定义任何方法，它就创建Web服务器的工厂的标记接口，Spring中很多地方也是这样的风格。

![format_png 15][]

这个接口重要的两个子接口，也是我们需要关注的两个子接口分别是`ServletWebServerFactory`和`ReactiveWebServerFactory`，它们两个都定义了一个方法`getWebServer`。

`Jetty`，`Undertow`，`Tomcat`三个都属于Servlet容器，所以使用的是`ServletWebServerFactory`来创建Web容器。

![format_png 16][]

而`Netty`不是Servlet容器，所以使用的是`ReactiveWebServerFactory`来创建Web容器。

![format_png 17][]

> 上面对这两个接口进行了介绍，基本上整个Web容器都是围绕这两个接口来，我们下面继续分析。

### 获取WebServerFactory ###

首先我们要先获取web服务的工厂类的Bean，才能创建Web容器，因为我们使用的是Tomcat，所以获取到的工厂类是`TomcatServletWebServerFactory`，具体的获取Bean的过程我们就没有必要去一一说明，只要对Spring IOC稍微熟悉一点就能理解，我们主要说一下在后置处理器。

上面我们介绍了Tomcat容器的定制器Customizer，里面对Web容器的配置属性进行组装，它就是发生在Bean的初始化前，用到的Bean后置处理器是`WebServerFactoryCustomizerBeanPostProcessor`。

![format_png 18][]

Bean的后置处理器中，会调用对应的定制器，Tomcat调用的就是`TomcatWebServerFactoryCustomizer`，其他的也一样，其目的都是定制WebServerFactory。

经过一系列处理后，就从IOC容器中获取到了`WebServerFactory`Bean，然后再使用这个工厂去创建Web服务。

### 创建Web服务 ###

获取到WebServerFactory后，就可以创建Web容器，因为使用的是Tomcat，所以使用的是`TomcatServletWebServerFactory`，如下，我们就看到了Tomcat的身影。

![format_png 19][]

最后启动Tomcat容器是在TomcatWebServer中，在TomcatWebServer的构造函数中调用initialize()，在initialize()中我们看是this.tomcat.start()，Tomcat被启动了。

![format_png 20][]

上面我们在说`WebServer`接口的时候，说了启动`start()`方法，在Tomcat的实现中就没有使用`start()`来启动容器，但是在Undertow中，就使用了`start()`方法来启动容器。

### Undertow容器启动 ###

上面我们介绍了Tomcat容器的创建，Undertow的流程和Tomcat基本上是一样的，但是在启动的时候，Undertow是在start()方法中启动，而start()方法需要在 finishRefresh()这一步中执行。

![format_png 21][]

在finishRefresh()中，会调用生命周期处理器

![format_png 22][]

最终会走到WebServerStartStopLifecycle这个生命周期，这里就会调用WebServer中的start()方法。

![format_png 23][]

最终在UndertowWebServer中启动Undertow容器

![format_png 24][]

具体执行顺序如下。

finishRefresh() -> getLifecycleProcessor().onRefresh() -> startBeans(true) -> start() -> doStart(this.lifecycleBeans, member.name, this.autoStartupOnly) -> bean.start() -> this.webServer.start()

> 上面我们分析了Tomcat和Undertow的创建流程，Jetty和Netty也是大同小异，因为Spring使用了模板方法模式，具体的实现交给具体的Web容器，所以在整体结构上是差不多的，只是实现方式不同。

## 总结 ##

关于SpringBoot的内嵌Web容器，就说得差不多了，我们从各种Web容器进行介绍，包括他们的有点，怎么在SpringBoot中使用，并对源码进行解析，在源码解析这里，我们并没有进行芝麻细节式解析，而是从大体上进行解析，只有对大致结构了解，才能更好地进行深度学习。

SpringBoot内嵌容器涉及的知识点还是比较多，需要对Spring和SpringBoot有一定的了解才能更好地学习它，本文基于SpringBoot3.0进行解析， SpringBoot3.0中，Servlet也是遵循Jakata EE规范。

[format_png]: https://img-blog.csdnimg.cn/img_convert/179ffdeb69921b956c3193a844c04bb4.webp?x-oss-process=image/format,png
[format_png 1]: https://img-blog.csdnimg.cn/img_convert/8c774d0bf6cd802ef47f4774a7bc4eae.webp?x-oss-process=image/format,png
[format_png 2]: https://img-blog.csdnimg.cn/img_convert/50318f0826c96e655027bba4eccce246.webp?x-oss-process=image/format,png
[format_png 3]: https://img-blog.csdnimg.cn/img_convert/7084f62702550dd240c613b20f5b6505.webp?x-oss-process=image/format,png
[format_png 4]: https://img-blog.csdnimg.cn/img_convert/c733a7bb341a79b41a6042402307d6ea.webp?x-oss-process=image/format,png
[format_png 5]: https://img-blog.csdnimg.cn/img_convert/976087408acd2ed0224dae80fd3587f4.webp?x-oss-process=image/format,png
[format_png 6]: https://img-blog.csdnimg.cn/img_convert/52c19bdbfd34ac54b795c573f8316b52.webp?x-oss-process=image/format,png
[format_png 7]: https://img-blog.csdnimg.cn/img_convert/39418cf71980297b647f64ab915c4507.webp?x-oss-process=image/format,png
[format_png 8]: https://img-blog.csdnimg.cn/img_convert/29012408df071f7009b9a176ae4e1f14.webp?x-oss-process=image/format,png
[format_png 9]: https://img-blog.csdnimg.cn/img_convert/ba9205ee02c4021b0c20fdad509a1bbf.webp?x-oss-process=image/format,png
[format_png 10]: https://img-blog.csdnimg.cn/img_convert/4f3e8a481ba3a9c20e6e2a37471d5173.webp?x-oss-process=image/format,png
[format_png 11]: https://img-blog.csdnimg.cn/img_convert/a079b374499076de454853e6d496946f.webp?x-oss-process=image/format,png
[format_png 12]: https://img-blog.csdnimg.cn/img_convert/3cb7808ccaa5b8cdcae6adef64a35a52.webp?x-oss-process=image/format,png
[format_png 13]: https://img-blog.csdnimg.cn/img_convert/beda01d33d86b9882d530485e09d1f41.webp?x-oss-process=image/format,png
[format_png 14]: https://img-blog.csdnimg.cn/img_convert/16b0766a655b4b666ab346724dcbfea3.webp?x-oss-process=image/format,png
[format_png 15]: https://img-blog.csdnimg.cn/img_convert/acd2643cc09af39f0f188a608300d03c.webp?x-oss-process=image/format,png
[format_png 16]: https://img-blog.csdnimg.cn/img_convert/3011838e3c6c62ef9011e4c2a07a38f1.webp?x-oss-process=image/format,png
[format_png 17]: https://img-blog.csdnimg.cn/img_convert/6e2f6fc5b4ce74639c9c31876f516bfb.webp?x-oss-process=image/format,png
[format_png 18]: https://img-blog.csdnimg.cn/img_convert/c80672a353a12ca55886830599e4bc14.webp?x-oss-process=image/format,png
[format_png 19]: https://img-blog.csdnimg.cn/img_convert/c38a2175e328044c7695af00aba1011d.webp?x-oss-process=image/format,png
[format_png 20]: https://img-blog.csdnimg.cn/img_convert/2d4d6ee4bc7171af0fe4980c5f967232.webp?x-oss-process=image/format,png
[format_png 21]: https://img-blog.csdnimg.cn/img_convert/62c80a5c4330547450cc2d3e3a0d9fa5.webp?x-oss-process=image/format,png
[format_png 22]: https://img-blog.csdnimg.cn/img_convert/5332b58428ebe0525670a028d3050f14.webp?x-oss-process=image/format,png
[format_png 23]: https://img-blog.csdnimg.cn/img_convert/f58915b51d9cfe394dd659bb247d12ab.webp?x-oss-process=image/format,png
[format_png 24]: https://img-blog.csdnimg.cn/img_convert/aff8a7a729406cb1deaee06e8565245a.webp?x-oss-process=image/format,png