SpringBoot嵌入式Servlet容器相关学习笔记

news2025/7/16 2:24:47

大家都知道SrpingBoot是内嵌Servlet容器的，并且默认是Tomcat，本文主要讲一下其中原理。
首先，SpringBoot是支持其它容器的，除了Tomcat外，还有Undertow，Netty以及Jetty。并且这些容器经过封装，最终使用的时候，都是一个WebServer。（但是一开始它们注册到IOC容器中时，并不是这种类型）
在这里插入图片描述
接着开始讲原理，主要分两条线：一是web服务器的创建，二是web服务器的获取及使用。

1.web服务器的创建

既然说服务器是嵌入式的，那必然是自动配置。SpringBoot自动配置类都是XXAutoConfiguration结尾，这里定位到ServletWebServerFactoryAutoConfiguration，这个类就是web服务器的自动配置类，但是服务器的创建并不直接在这个类完成，该类代码如下。

@Import({ ServletWebServerFactoryAutoConfiguration.BeanPostProcessorsRegistrar.class,
		ServletWebServerFactoryConfiguration.EmbeddedTomcat.class,
		ServletWebServerFactoryConfiguration.EmbeddedJetty.class,
		ServletWebServerFactoryConfiguration.EmbeddedUndertow.class })
public class ServletWebServerFactoryAutoConfiguration

观察@Import注解，服务器的具体配置其实是在ServletWebServerFactoryConfiguration这个类中完成的。进入该类，确实可以看到配置了各个服务器对应的bean：

在这里插入图片描述

并且这几个web服务器组件，并不是无条件的注入到IOC容器中的，@ConditionalOnClass注解其实就是做限制的，如果连自身对应的jar包都没有，这个组件就不会被注入。从图片上可以看出，只有Tomcat是正常的，这也就解释了为什么SpringBoot内嵌的web服务器默认是tomcat。
那么Tomcat所需的类为何会存在呢？这主要是因为SpringBoot在启动时发现当前是Web应用，web场景自动导入了tomcat。
以上就是web服务器创建的基本流程，具体细节没有深入。

2.确定Web服务器

刚刚说到这是web场景，而web场景对应的ioc容器，正是ServletWebServerApplicationContext。
这个类有一个属性就是WebServer，前面提到过，其实就是用来接受寻找到的web服务器。从该类的角度来说，其实就是创建WebServer，主要代码如下：

	private void createWebServer() {
	//当前是null
		WebServer webServer = this.webServer;
		ServletContext servletContext = getServletContext();
		if (webServer == null && servletContext == null) {
		//从这里正式开始创建WebServer
			StartupStep createWebServer = this.getApplicationStartup().start("spring.boot.webserver.create");
			//这是核心代码，寻找WebServerFactory，而WebServerFactory正是被刚刚标注@Bean注解的web三个服务器组件所间接实现。默认情况下，获取到的就是tomcat
			ServletWebServerFactory factory = getWebServerFactory();
			createWebServer.tag("factory", factory.getClass().toString());
			//将获取到的web容器赋给webServer
			this.webServer = factory.getWebServer(getSelfInitializer());
			createWebServer.end();
			getBeanFactory().registerSingleton("webServerGracefulShutdown",
					new WebServerGracefulShutdownLifecycle(this.webServer));
			getBeanFactory().registerSingleton("webServerStartStop",
					new WebServerStartStopLifecycle(this, this.webServer));
		}
		else if (servletContext != null) {
			try {
				getSelfInitializer().onStartup(servletContext);
			}
			catch (ServletException ex) {
				throw new ApplicationContextException("Cannot initialize servlet context", ex);
			}
		}
		initPropertySources();
	}

ServletWebServerFactory factory = getWebServerFactory();

这是核心代码，可以看一下里面具体是如何实现的：
在这里插入图片描述
里面逻辑还是比较简单的，其实就是查找容器中ServletWebServerFactory类型的组件的名字。这里不妨再看一下这是什么类型：

通过图片，可以看的非常清楚，这是一个接口，而上文提到的几个服务器组件实现的它，那不就成了找生效的web服务器组件的name了嘛？
通过前文可知，默认情况下，只有Tomcat成功注册，Debug一下：
在这里插入图片描述

return getBeanFactory().getBean(beanNames[0], ServletWebServerFactory.class);

最后return根据name和type查到的明确的web服务器，返回的类型是ServletWebServerFactory。至此，已经获取到一个明确的webServer了。

this.webServer = factory.getWebServer(getSelfInitializer());

因为这里的factory就是刚刚获取的TomcatServletWebServerFactory，所以getWebServer自然就是调用TomcatServletWebServerFactory中的方法：
在这里插入图片描述
这不就是在配置具体的Tomcat嘛，这个方法过后，createWebServer()方法的主要内容已经完成。

3.拓展

3.1 如何切换服务器

在前文中说了，为何是默认tomcat的原因，也解释了tomcat的类的来源，是在web场景下自动导入的。要切换成别的服务器，就要在web-start中排除tomcat相关依赖，并导入其他服务器的依赖，如下：
在这里插入图片描述

3.2 如何定制服务器（未完待续）

1. 直接在yaml文件中修改server为前缀的属性。 是因为在自动配置服务器组件的时候用到了ServerProperties这个类，而这个类中的属性又全来自properties。
在这里插入图片描述
2. 自定义ServletWebServerFactory。因为一开始在createWebServer()方法里是通过调用getWebServerFactory()得到服务器组件，具体是查找类型为ServletWebServerFactory.class的组件。前面说了ServletWebServerFactory是服务器组件间接实现的一个接口，所以可以通过修改父类/接口的功能，来对实现类/子类进行功能扩展。但是由于ServletWebServerFactory这个接口里方法实在是太少了，所以我们定义的是它的子接口ConfigurableServletWebServerFactory。
在这里插入图片描述
3. 通过ServletWebServerFactoryCustomizer（Web服务器的定制化器）后置修改服务器工厂的属性。