重学SpringBoot3-ServletWebServerFactoryAutoConfiguration类

重学SpringBoot3-ServletWebServerFactoryAutoConfiguration类

CoderJia 18 2024-03-15

在Spring Boot 3中,ServletWebServerFactoryAutoConfiguration 类扮演着至关重要的角色,它负责自动配置内嵌的 Servlet 容器,例如 Tomcat、Jetty 或 Undertow。这种自动配置能力是 Spring Boot 框架的核心特性之一,它极大地简化了 Spring 应用的开发和部署过程。本文将深入探讨ServletWebServerFactoryAutoConfiguration 类的工作原理、配置方式以及如何通过它来定制内嵌Servlet容器。

ServletWebServerFactoryAutoConfiguration工作原理

org.springframework.boot.autoconfigure.web.servlet.ServletWebServerFactoryAutoConfiguration

ServletWebServerFactoryAutoConfiguration类位置

ServletWebServerFactoryAutoConfiguration 类通过 Spring 的条件注解机制(如 @ConditionalOnClass@ConditionalOnMissingBean 等)来检测 classpath 中可用的 Servlet 容器实现,并据此配置相应的 ServletWebServerFactory 实例。这个工厂实例负责创建和配置内嵌的Servlet容器,并且绑定了ServerProperties 配置类,所有和服务器有关的配置既以 server. 开头的配置。

关键组件

ServletWebServerFactoryAutoConfiguration 配置了一系列的工厂 Bean,这些工厂 Bean 基于应用的依赖和属性进行条件化的配置。主要包括:

  • TomcatServletWebServerFactory
  • JettyServletWebServerFactory
  • UndertowServletWebServerFactory

每个工厂都对应一个特定的 Servlet 容器实现,它们提供了丰富的配置选项,允许开发者定制容器的行为,如端口号、SSL配置、会话设置等。

TomcatServletWebServerFactory为例

TomcatServletWebServerFactory 是一个非常关键的类,它负责为 Spring Boot 应用配置和创建内嵌的 Tomcat 服务器。这一工厂类使得开发者能够轻松地定制Tomcat 服务器的各种设置,如端口号、SSL 配置、会话超时设置、以及其他多项服务器级别的配置。通过使用 TomcatServletWebServerFactory,开发者可以在不牺牲 Spring Boot 应用简易性和速度的前提下,享受到强大的 Tomcat 服务器定制功能。

ServletWebServerFactory会创建webServer的时机

我们倒着来看。

TomcatServletWebServerFactory 有 getWebServer() 方法,是用来创建和配置 Tomcat Web 服务器的。

org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory#getWebServer

getWebServer()

按住 Ctrl+左键,显示的是 ServletWebServerApplicationContext 的 createWebServer() 调用了 getWebServer 方法,它检查 webServer 和 servletContext 是否为 null。如果都为 null,那么它将创建一个新的 WebServer 实例,并将其注册到 BeanFactory 中,以便在需要时可以获取。同时,它还会创建两个生命周期 bean,一个用于优雅地关闭 Web 服务器,另一个用于启动和停止 Web 服务器。

org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext#createWebServer

createWebServer()方法

按住 Ctrl+左键,显示的是 ServletWebServerApplicationContext 的 onRefresh() 调用了 createWebServer() 方法,onRefresh() 又是由 AbstractApplicationContext 调用,既 Spring容器启动的时候,找了个时机创建 webServer。

org.springframework.context.support.AbstractApplicationContext#onRefresh

onRefresh()

关键特性

TomcatServletWebServerFactory 提供了以下几个关键特性来帮助开发者定制内嵌 Tomcat 服务器:

  • 端口配置:可以设置 HTTP 和 HTTPS 的端口,支持程序运行时动态更改端口。
  • SSL配置:支持 SSL/TLS 设置,让开发者可以配置HTTPS安全连接。
  • 会话管理:允许开发者定制会话超时时间、会话持久化机制等。
  • 错误页面:可以定制错误页面来优化用户体验。
  • 连接器和协议定制:支持对 Tomcat 连接器(Connector)和协议的高级定制,包括线程池配置、连接超时设置等。

使用方式

在 Spring Boot 应用中,通常不需要直接实例化 TomcatServletWebServerFactory。相反,可以通过 application.properties 或 application.yml 文件进行配置,或者通过编程方式定制 Tomcat 的特定行为。

通过配置文件

application.propertiesapplication.yml中添加 Tomcat 的配置,例如:

# application.properties
server.port=8080
server.ssl.key-store=classpath:keystore.jks
server.ssl.key-store-password=password
server.ssl.keyStoreType=JKS
server.servlet.session.timeout=20m

通过编程方式定制

如果需要更高级的定制,可以创建一个配置类并注入 TomcatServletWebServerFactory 的 Bean,示例如下:

import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class TomcatConfig {

    @Bean
    public WebServerFactoryCustomizer<TomcatServletWebServerFactory> webServerFactoryCustomizer() {
        return factory -> {
            factory.setPort(8080);
            // 其他定制...
        };
    }
}

结论

ServletWebServerFactoryAutoConfiguration 类是 Spring Boot 自动配置内嵌 Servlet 容器的关键,它极大地简化了开发和部署过程。通过灵活的配置选项,开发者可以轻松定制容器的行为,以满足不同的应用需求。随着 Spring Boot 3 的推出,这一机制变得更加强大和灵活,使得 Spring Boot 继续保持其作为现代 Java 开发的首选框架的地位。