SpringBoot嵌入式Servlet容器與定制化組件超詳細講解

Posted on by

嵌入式Servlet容器

在Spring Boot中，默認支持的web容器有 Tomcat, Jetty, 和 Undertow

1、原理分析

那麼這些web容器是怎麼註入的呢？我們一起來分析一下

當SpringBoot應用啟動發現當前是Web應用，它會創建一個web版的ioc容器ServletWebServerApplicationContext

這個類下面有一個createWebServer()方法，當執行關鍵代碼ServletWebServerFactory factory = this.getWebServerFactory();時，它會在系統啟動的時候尋找 ServletWebServerFactory（Servlet 的web服務器工廠—> 用於生產Servlet 的web服務器）

private void createWebServer() {
    WebServer webServer = this.webServer;
    ServletContext servletContext = this.getServletContext();
    if (webServer == null && servletContext == null) {
        StartupStep createWebServer = this.getApplicationStartup().start("spring.boot.webserver.create");
        // 獲取ServletWebFactory
        ServletWebServerFactory factory = this.getWebServerFactory();
        createWebServer.tag("factory", factory.getClass().toString());
        // 這裡會去調用系統中獲取到的web容器工廠類的getWebServer()方法
        this.webServer = factory.getWebServer(new ServletContextInitializer[]{this.getSelfInitializer()});
        createWebServer.end();
        this.getBeanFactory().registerSingleton("webServerGracefulShutdown", new WebServerGracefulShutdownLifecycle(this.webServer));
        this.getBeanFactory().registerSingleton("webServerStartStop", new WebServerStartStopLifecycle(this, this.webServer));
    } else if (servletContext != null) {
        try {
            this.getSelfInitializer().onStartup(servletContext);
        } catch (ServletException var5) {
            throw new ApplicationContextException("Cannot initialize servlet context", var5);
        }
    }
    this.initPropertySources();
}

獲取ServletWebFactory

protected ServletWebServerFactory getWebServerFactory() {
    String[] beanNames = this.getBeanFactory().getBeanNamesForType(ServletWebServerFactory.class);
    if (beanNames.length == 0) {
        throw new MissingWebServerFactoryBeanException(this.getClass(), ServletWebServerFactory.class, WebApplicationType.SERVLET);
    } else if (beanNames.length > 1) {
        throw new ApplicationContextException("Unable to start ServletWebServerApplicationContext due to multiple ServletWebServerFactory beans : " + StringUtils.arrayToCommaDelimitedString(beanNames));
    } else {
        return (ServletWebServerFactory)this.getBeanFactory().getBean(beanNames[0], ServletWebServerFactory.class);
    }
}

SpringBoot底層默認有很多的WebServer工廠：TomcatServletWebServerFactory,，JettyServletWebServerFactory和 UndertowServletWebServerFactory

那麼究竟返回哪一個工廠呢？

我們需要分析一下底層的自動配置類，ServletWebServerFactoryAutoConfiguration

@AutoConfiguration
@AutoConfigureOrder(-2147483648)
@ConditionalOnClass({ServletRequest.class})
@ConditionalOnWebApplication(
    type = Type.SERVLET
)
@EnableConfigurationProperties({ServerProperties.class})
@Import({ServletWebServerFactoryAutoConfiguration.BeanPostProcessorsRegistrar.class, EmbeddedTomcat.class, EmbeddedJetty.class, EmbeddedUndertow.class})
public class ServletWebServerFactoryAutoConfiguration {
    public ServletWebServerFactoryAutoConfiguration() {
    }
    ...

它引入瞭一個配置類ServletWebServerFactoryConfiguration，這個類裡面會根據動態判斷系統中到底導入瞭那個Web服務器的包，然後去創建對應的web容器工廠，spring-boot-starter-web這個依賴默認導入tomcat，所以我們系統會創建TomcatServletWebServerFactory，由這個工廠創建tomcat容器並啟動

一旦我們獲取到web Server的工廠類，createWebServer()方法就會去調用this.webServer = factory.getWebServer(new ServletContextInitializer[]{this.getSelfInitializer()});

根據斷點一直深入，我們可以發現，Tomcat, Jetty, 和 Undertow的工廠類最後都會去調用getWebServer()方法，設置瞭鏈接參數，例如TomcatServletWebServerFactory的getWebServer()方法

在方法的最後，它會執行return this.getTomcatWebServer(tomcat);，跟著斷點深入，我們發現它會去調用對應web容器類的構造方法，如TomcatWebServer的構造方法，啟動tomcat容器

public TomcatWebServer(Tomcat tomcat, boolean autoStart, Shutdown shutdown) {
    this.monitor = new Object();
    this.serviceConnectors = new HashMap();
    Assert.notNull(tomcat, "Tomcat Server must not be null");
    this.tomcat = tomcat;
    this.autoStart = autoStart;
    this.gracefulShutdown = shutdown == Shutdown.GRACEFUL ? new GracefulShutdown(tomcat) : null;
    // 初始化方法initialize---會調用this.tomcat.start();啟動容器
    this.initialize();
}

2、Servlet容器切換

Spring Boot默認使用的是tomcat容器，那如果我們想要使用Undertow應該如何切換呢

隻需要修改pom文件即可，排除web啟動器中tomcat相關的依賴

然後導入Undertow相關啟動器

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-undertow</artifactId>
</dependency>

3、定制Servlet容器配置

如果想要自己定義一個Servlet容器，可以通過哪些途徑呢？

  • 通過分析ServletWebServerFactoryAutoConfiguration綁定瞭ServerProperties配置類可知，我們想要修改容器的配置，隻需要修改配置文件中對應的server.xxx配置項即可
  • 創建一個配置類，通過@Configuration+@Bean的方式，向容器中註入一個ConfigurableServletWebServerFactory類的實現類，ConfigurableServletWebServerFactory是ServletWebServerFactory類的子類，提供瞭很多方法供我們使用

代碼樣例如下

package com.decade.config;
import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
import org.springframework.boot.web.servlet.server.ConfigurableServletWebServerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class MyConfig {
    @Bean
    public ConfigurableServletWebServerFactory defineWebServletFactory() {
        final TomcatServletWebServerFactory tomcatServletWebServerFactory = new TomcatServletWebServerFactory();
        tomcatServletWebServerFactory.setPort(8081);
        return tomcatServletWebServerFactory;
    }
}

自定義一個ServletWebServerFactoryCustomizer類，它的下面有一個customize()方法，能把配置文件的值和ServletWebServerFactory 進行綁定

Spring官網提供的樣例如下

Spring中有很多xxxxxCustomizer，它的作用是定制化器，可以改變xxxx的默認規則

定制化組件

結合之前的原理分析過程可知，我們分析一個組件的過程可以概括為：

導入對應啟動器xxx-starter—->分析xxxAutoConfiguration—->導入xxx組件—->綁定xxxProperties配置類—–>綁定配置項

那麼如果我們要定制化組件，例如自定義參數解析器或者應用啟動端口等，可以怎麼做呢？

  • 修改配置文件 server.xxx
  • 參考上面編寫一個xxxxxCustomizer類
  • 編寫自定義的配置類xxxConfiguration：使用@Configuration + @Bean替換、增加容器中默認組件
  • 如果是Web應用，編寫一個配置類實現WebMvcConfigurer接口，重寫對應方法即可定制化web功能，或者使用@Bean給容器中再擴展一些組件（這條是最重要的）

註意：@EnableWebMvc + 實現WebMvcConfigurer接口：配置類中定義的@Bean可以全面接管SpringMVC，所有規則全部自己重新配置

原理：

  • WebMvcAutoConfiguration類是SpringMVC的自動配置功能類。配置瞭靜態資源、歡迎頁…
  • 一旦使用@EnableWebMvc會，@Import(DelegatingWebMvcConfiguration.class)

DelegatingWebMvcConfiguration類的作用是：隻保證SpringMVC最基本的使用

  • public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport表明它是WebMvcConfigurationSupport的子類
  • 它會把所有系統中的 WebMvcConfigurer的實現類拿過來，所有功能的定制都是這些WebMvcConfigurer的實現類合起來一起生效

WebMvcConfigurationSupport自動配置瞭一些非常底層的組件，例如RequestMappingHandlerMapping，這些組件依賴的其他組件都是從容器中獲取的，例如ContentNegotiationManager等

由代碼可知，WebMvcAutoConfiguration裡面的配置要能生效必須系統中不存在WebMvcConfigurationSupport類，所以，一旦配置類上加瞭@EnableWebMvc，就會導致WebMvcAutoConfiguration沒有生效

到此這篇關於SpringBoot嵌入式Servlet容器與定制化組件超詳細講解的文章就介紹到這瞭,更多相關SpringBoot Servlet容器內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：