SpringBoot啟動嵌入式Tomcat的實現過程

本篇內容介紹了“SpringBoot啟動嵌入式Tomcat的實現過程”的有關知識，在實際案例的操作過程中，不少人都會遇到這樣的困境，接下來就讓小編帶領大家學習一下如何處理這些情況吧！希望大家仔細閱讀，能夠學有所成！

目錄

• Spring Boot中Web容器相關接口

• WebServer

• ServletWebServerFactory

• WebServerFactoryCustomizerBeanPostProcessor

• 創建、啟動嵌入式Web容器

• createWebServer

• getWebServer

• 注冊Servlet

• Servlet注解

• ServletRegistrationBean

• 動態注冊

• 定制Web容器

• ConfigurableServletWebServerFactory

• TomcatServletWebServerFactory

Spring Boot在內部啟動了一個嵌入式Web容器。
Tomcat是組件化設計，所以就是啟動這些組件。

Tomcat獨立部署模式是通過startup腳本啟動，Tomcat中的Bootstrap和Catalina會負責初始化類加載器，并解析server.xml和啟動這些組件。

內嵌模式，Bootstrap和Catalina的工作由Spring Boot代勞，Spring Boot調用Tomcat API啟動這些組件。

Spring Boot中Web容器相關接口

WebServer

為支持各種Web容器，Spring Boot抽象出嵌入式Web容器，定義WebServer接口：

Web容器比如Tomcat、Jetty去實現該接口

ServletWebServerFactory

創建Web容器，返回的就是上面提到的WebServer。

public interface ServletWebServerFactory {
    WebServer getWebServer(ServletContextInitializer... initializers);
}

ServletContextInitializer入參表示ServletContext的初始化器，用于ServletContext中的一些配置：

public interface ServletContextInitializer {
    void onStartup(ServletContext servletContext) throws ServletException;
}

getWebServer會調用ServletContextInitializer#onStartup，即若想在Servlet容器啟動時做一些事情，比如注冊自己的Servlet，可以實現一個ServletContextInitializer，在Web容器啟動時，Spring Boot會把所有實現ServletContextInitializer接口的類收集起來，統一調其onStartup。

WebServerFactoryCustomizerBeanPostProcessor

一個BeanPostProcessor，為定制化嵌入式Web容器，在postProcessBeforeInitialization過程中去尋找Spring容器中WebServerFactoryCustomizer類型的Bean，并依次調用WebServerFactoryCustomizer接口的customize方法做一些定制化。

public interface WebServerFactoryCustomizer<T extends WebServerFactory> {
    void customize(T factory);
}

創建、啟動嵌入式Web容器

Spring的ApplicationContext，其抽象實現類AbstractApplicationContext#refresh

用來新建或刷新一個ApplicationContext，在refresh中會調用onRefresh，AbstractApplicationContext的子類可以重寫onRefresh實現Context刷新邏輯。

因此重寫 ServletWebServerApplicationContext#onRefresh 創建嵌入式Web容器：

重寫onRefresh方法，調用createWebServer創建和啟動Tomcat。

createWebServer

private void createWebServer() {
    // WebServer是Spring Boot抽象出來的接口，具體實現類就是不同Web容器
    WebServer webServer = this.webServer;
    ServletContext servletContext = this.getServletContext();
    
    // 若Web容器尚未創建
    if (webServer == null && servletContext == null) {
        // 通過Web容器工廠創建
        ServletWebServerFactory factory = this.getWebServerFactory();
        // 傳入一個"SelfInitializer"
        this.webServer = factory.getWebServer(new ServletContextInitializer[]{this.getSelfInitializer()});
        
    } else if (servletContext != null) {
        try {
            this.getSelfInitializer().onStartup(servletContext);
        } catch (ServletException var4) {
          ...
        }
    }

    this.initPropertySources();
}

getWebServer

以Tomcat為例，主要調用Tomcat的API去創建各種組件：

public WebServer getWebServer(ServletContextInitializer... initializers) {
    // 1.實例化一個Tomcat【Server組件】
    Tomcat tomcat = new Tomcat();
    
    // 2. 創建一個臨時目錄
    File baseDir = this.baseDirectory != null ? this.baseDirectory : this.createTempDir("tomcat");
    tomcat.setBaseDir(baseDir.getAbsolutePath());
    
    // 3.初始化各種組件
    Connector connector = new Connector(this.protocol);
    tomcat.getService().addConnector(connector);
    this.customizeConnector(connector);
    tomcat.setConnector(connector);
    tomcat.getHost().setAutoDeploy(false);
    this.configureEngine(tomcat.getEngine());
    
    // 4. 創建定制版的"Context"組件
    this.prepareContext(tomcat.getHost(), initializers);
    return this.getTomcatWebServer(tomcat);
}

prepareContext的Context指Tomcat的Context組件，為控制Context組件行為，Spring Boot自定義了TomcatEmbeddedContext類，繼承Tomcat的StandardContext：

注冊Servlet

有@RestController，為什么還要自己去注冊Servlet給Tomcat?
可能有些場景需要注冊你自己寫的一個Servlet提供輔助功能，與主程序分開。

Sprong Boot 不注冊Servlet 給Tomcat 直接用 @Controller 就能實現Servlet功能是為啥呢？
因為Sprong Boot默認給我們注冊了DispatcherSetvlet。

Servlet注解

在Spring Boot啟動類上加上 @ServletComponentScan 注解后，使用@WebServlet、@WebFilter、@WebListener標記的Servlet、Filter、Listener就可以自動注冊到Servlet容器。

在Web應用的入口類上加上@ServletComponentScan，并且在Servlet類上加上@WebServlet，這樣Spring Boot會負責將Servlet注冊到內嵌的Tomcat中。

ServletRegistrationBean

Spring Boot提供了

• ServletRegistrationBean

• FilterRegistrationBean

• ServletListenerRegistrationBean

分別用來注冊Servlet、Filter、Listener。
假如要注冊一個Servlet：

返回一個ServletRegistrationBean，并將它當作Bean注冊到Spring，因此你需要把這段代碼放到Spring Boot自動掃描的目錄中，或者放到**@Configuration**標識的類中。
Spring會把這種類型的Bean收集起來，根據Bean里的定義向Tomcat注冊Servlet。

動態注冊

可以創建一個類去實現ServletContextInitializer接口，并把它注冊為一個Bean，Spring Boot會負責調用這個接口的onStartup。

實現ServletContextInitializer接口的類會被spring管理，而不是被Servlet容器管理。

@Component
public class MyServletRegister implements ServletContextInitializer {

    @Override
    public void onStartup(ServletContext servletContext) {
    
        // Servlet 3.0規范新的API
        ServletRegistration myServlet = servletContext
                .addServlet("HelloServlet", HelloServlet.class);
                
        myServlet.addMapping("/hello");
        
        myServlet.setInitParameter("name", "Hello Servlet");
    }

}

ServletRegistrationBean也是通過ServletContextInitializer實現的，它實現了ServletContextInitializer接口。
注意到onStartup方法的參數是我們熟悉的ServletContext，可以通過調用它的addServlet方法來動態注冊新的Servlet，這是Servlet 3.0以后才有的功能。

通過 ServletContextInitializer 接口可以向 Web 容器注冊 Servlet，實現 ServletContextInitializer 接口的Bean被speing管理，但是在什么時機觸發其onStartup()方法的呢？
通過 Tomcat 中的 ServletContainerInitializer 接口實現者，如TomcatStarter，創建tomcat時設置了該類，在tomcat啟動時會觸發ServletContainerInitializer實現者的onStartup()方法，在這個方法中觸發ServletContextInitializer接口的onStartup()方法，如注冊DispatcherServlet。

DispatcherServletRegistrationBean實現了ServletContextInitializer接口，它的作用就是向Tomcat注冊DispatcherServlet，那它是在什么時候、如何被使用的呢？
prepareContext方法調用了另一個私有方法configureContext，這個方法就包括了往Tomcat的Context添加ServletContainerInitializer對象：

context.addServletContainerInitializer(starter, NO_CLASSES);

其中有DispatcherServletRegistrationBean。

定制Web容器

如何在Spring Boot中定制Web容器。在Spring Boot 2.0中可通過如下方式：

ConfigurableServletWebServerFactory

通用的Web容器工廠，定制Web容器通用參數：

@Component
public class MyGeneralCustomizer implements
  WebServerFactoryCustomizer<ConfigurableServletWebServerFactory> {
  
    public void customize(ConfigurableServletWebServerFactory factory) {
        factory.setPort(8081);
        factory.setContextPath("/hello");
     }
}

TomcatServletWebServerFactory

通過特定Web容器工廠進一步定制。

給Tomcat增加一個Valve，這個Valve的功能是向請求頭里添加traceid，用于分布式追蹤。

class TraceValve extends ValveBase {
    @Override
    public void invoke(Request request, Response response) throws IOException, ServletException {

        request.getCoyoteRequest().getMimeHeaders().
        addValue("traceid").setString("1234xxxxabcd");

        Valve next = getNext();
        if (null == next) {
            return;
        }

        next.invoke(request, response);
    }

}

跟方式一類似，再添加一個定制器：

@Component
public class MyTomcatCustomizer implements
        WebServerFactoryCustomizer<TomcatServletWebServerFactory> {

    @Override
    public void customize(TomcatServletWebServerFactory factory) {
        factory.setPort(8081);
        factory.setContextPath("/hello");
        factory.addEngineValves(new TraceValve() );

    }
}

“SpringBoot啟動嵌入式Tomcat的實現過程”的內容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業相關的知識可以關注億速云網站，小編將為大家輸出更多高質量的實用文章！