WebServer 初始化過程

在上一節中 Spring Boot 初始化了 WebServer 對應的工廠類。同時，我們也知道對應 Web容器的WebServer實現類有:TomcatWebServer、JettyWebServer和UndertowWebServer。

這節重點講解這些 WebServer 是如何被初始化，又如何啟動的。

WebServer 接口的源代碼如下。

public interface WebServer {void start() throws WebServerException;void stop() throws WebServerException;int getPort();}

接口定義了 3 個方法: start 方法為啟動容器，stop 方法為停止容器,getPort 方法為獲得容器端口。

現在以 Tomcat 的啟動為例來說明整個內置容器的加載與啟動。在上節中，工廠類已經被自動配置初始化。那么，在什么地方用到它們的呢?這要回到最初 Spring Boot 啟動的過程中。

還記得 SpringApplication 的 run 方法中有一個調用初始化容器的方法 refreshContext 嗎?

我們就從這個方法開始追蹤。

public ConfigurableApplicationContext run(String... args) {try {//初始化容器refreshContext(context);} catch (Throwable ex) {}

在 run 方法中調用了 refreshContext 方法，refreshContext 方法中又調用了refresh 方法。

private void refreshContext(ConfigurableApplicationContext context) {//調用 refresh 方法refresh(context);refresh 方法的代碼如下。protected void refresh(ApplicationContext applicationContext) {Assert. isInstanceOf(AbstractApplicat ionContext. class, applicationContext);((AbstractApplicationContext) applicationContext).refresh();}

通過 refresh 方法我們能看到什么呢?對的，就是 AbstractApplicationContext 這個抽象類，該類的實例化對象在調用 refreshContext 方法之前，已經通過 createApplicationContext 方法進行實例化了。createApplicationContext 方法的源代碼如下。

protected ConfigurableApplicat ionContext createApplicationContext() {//首先獲取容器的類變量Class> contextClass = this . applicat ionContextClass;/如果為 null,則根據 web 應用類型按照默認類進行創建if (contextClass == null) {trywitch (this . webApplicat ionType) {contextClass = Class . forName(DEFAULT_ _SERVLET _WEB_ _CONTEXT_ CLASS);break;case REACTIVE:contextClass = Class . forName (DEFAULT_ REACTIVE_ WEB_ CONTEXT_ CLASS);break;default:contextClass = Class . forName (DEFAULT CONTEXT. CLASS);}catch (ClassNotFoundException ex) {如果存在對應的 Class 配置，則通過 Spring 提 供的 BeanUtils 來進行實例化 return(ConfigurableApplicationContext) BeanUtils. instantiateClass(contextClass);}}}

ServletWeb 項目默認會實例化 DEFAULT_ _SERVLET_ WEB_ _CONTEXT _CLASS 常量指定的 org.springframework.boot.web.servlet.context.AnnotationConfigServletWebServerApplicationContext 類。

在 refresh 方法中調用的 AbstractApplicationContext 的 refresh 方法就是這個常量配置的類的 refresh 方法但 AnnotationConfigServletWebServerApplicationContext 方法內并沒有該refresh 方法，該方法定義在它的父類 ServletWebServerApplicationContext 中。

@Overridepublic final void refresh() throws BeansException, IllegalStateExceptiontry {super . refresh();} catch (RuntimeException ex) {stopAndReleaseWebServer();throw ex;}}

ServletWebServerApplicationContext 的 refresh 方法僅調用了父類AbstractApplication-Context 中的 refresh 方法。AbstractApplicationContext 中的 refresh方法的代碼如下。

@Overridepublic void refresh() throws BeansException, IllegalStateException {synchronized (this . startupShutdownMonitor)try {...onRefresh();}catch (BeansException ex) {}

忽略掉 refresh 方法中的其他方法，我們重點了解下其調用的 onRefresh 方法。

protected void onRefresh() throws BeansException {//為子類提供，默認不做任何操作我們發現這個 onRefresh 方法默認是空的，待其子類來實現。也就是說，該方法真正的實現又回到了它的子類 ServletWebServerApplicationContext 中。@Overrideprotected void onRefresh() {super . onRefresh();try {createWebServer();} catch (Throwable ex){throw new ApplicationContextException("Unable to start web server", ex);}

經過一路的代碼跟蹤，終于回到重點方法: createWebServer 方法。

private void createWebServer() {WebServer webServer = this . webServer;ServletContext servletContext = getServletContext();if (webServer == null && servletContext == null) {ServletwebServerFactory factory = getWebServerFactory();this . webServer = factory . getWebServer(getSelfInitializer());} else if (servletContext != null) {initPropertySources();}}

在 ServletWebServerApplicationContext 的 createWebServer 方法中，初始化時默認web-Server 和 servletContext 都為 null,因此直接進入第一個 if 判斷中的業務邏輯。看一下get-WebServerFactory 都做了些什么。

protected ServletWebServerFactory getWebServerFactory() {//使用 Bean name 數組的好處是可以不用考慮層級關系String[] beanNames = getBeanF actory() . getBeanNamesForType(ServletWebServer-Factory.class);if (beanNames.length == 0) {throw new ApplicationContextException("Unable to start ServletWebServe-rApplicationContext due to missing" +"ServletWebServerFactory bean.");if (beanNames . length > 1) {throw new ApplicationContextException("Unable to start ServletwebServer-ApplicationContext due to multiple”+ "ServletWebServerFactory beans :”+StringUtils.arrayToCommaDelimitedString(beanNames));}return getBeanFactory(). getBean(beanNames[0], ServletWebServerFactory.class);}

getWebServerFactory 方法中通過 BeanFactory 獲得類型為 ServletWebServerFactory 類的 beanNames 數組，然后判斷數組長度。當 beanNames 長度為 0 時，說明容器中沒有對應的 Bean 存在，則拋出異常;當 beanNames 長度大于 1 時，說明存在多個對應的 Bean,也就是說有可能同時存在多個 Web 容器的工廠方法，同樣拋出異常;只有 beanNames 長度等于 1 時，說明恰好存在一個對應的 Bean, 才會獲取對應的 Bean 并返回。

如果一層層向上追溯 TomcatServletWebServerFactory 的類結構，我們就會發現，它先是繼承了抽象類AbstractServletWebServerFactory,而抽象類AbstractServletWebServerFactory 又實現了口 ConfigurableServletWebServerFactory 接口ConfigurableServletWebServer-Factory又繼承接口ServletWebServerFactory.這里獲得的 ServletWebServerFactory 的具體實現類，正是我們在上一節中通過自動配置實例化的TomcatServletWebServerFactory 對象的 Bean 名稱。

當獲得 ServletWebServerFactory 之后，便調用了它的 getWebServer 方法，以 Tomcat 為例，其實也就是調用了 TomcatServletWebServerFactory 的 getWebServer 方法。

@Overridepublic WebServer getWebServer(ServletContextInitializer... initializers)//內置 Tomcat 包中提供的類Tomcat tomcat = new Tomcat();//獲取并沒置 baseDir 路徑，不存在則創建一個 ltomcat 為前綴的臨時文件File baseDir = (this. baseDirectory != null) ? this. baseDirectorycreateTempDir("tomcat");tomcat . setBaseDir(baseDir . getAbsolutePath());/創建 ConnectorConnector connector = new Connector(this . protocol);tomcat . getService(). addConnector(connector);// Connector 定制化customi zeConnector(connector);tomcat. setConnector( connector);tomcat. . getHost(). setAutoDeploy(false);configureEngine(tomcat. getEngine());for (Connector additionalConnector : this . additionalTomcatConnectors) {tomcat . getService() . addConnector ( additionalConnector);prepareContext(tomcat . getHost(), initializers);//創建 omcatWebServerreturn getTomcatwebServer(tomcat);}}

TomcatServletWebServerFactory 的 getWebServer 方法中實現了 Tomcat 的創建、BaseDir的設置、Connector 的初始化和定制化等一系列初始化操作。

至此，上面代碼中依舊沒有體現 TomcatServer 的創建和初始化，不要著急，它們就在getWebServer 方法的最后- -行代碼調用的 getTomcatWebServer 方法中。

protected TomcatWebServer getTomcatWebServer (Tomcat tomcat) {return new TomcatWebServer(tomcat, getPort() >=

getTomcatWebServer 方法的實現很簡單，將 getWebServer 中創建的 Tomcat 對象和當前類中 port 值是否大于等于 0 的判斷結果作為 TomcatWebServer 構造方法的參數傳入，創建 TomcatWebServer 對象。

針對 getTomcatWebServer 方法，子類可以重寫該方法，返回一個不同的Tomcat-WebServer 或者添加針對 Tomcat Server 的一些額外操作。

先看 TomcatWebServer 的構造方法源碼。

public class TomcatWebServer implements WebServer {private final Tomcat tomcat;private final boolean autoStart;public TomcatWebServer(Tomcat tomcat, boolean autoStart) {Assert . notNull(tomcat, "Tomcat Server must not be null");this. tomcat = tomcat;this. autoStart = autoStart;initialize();}}

構造方法接收 Tomcat tomcat 和 boolean autoStart 兩個參數，并將其賦值給對應的成員變量。其中 Tomcat 參數不能為 null, autoStart 參數則根據端口是否大于等于 0 來決定是否啟動服務。在構造方法的最后，調用了 nitialize 方法來進行初始化操作。

omcatWebServern 的 initialize 方法源代碼如下。

public class TomcatWebServer implements WebServer {private final Tomcat tomcat;private final boolean autoStart;privatevolatile boolean started;logger. info("Tomcat initialized with port(s): ”+ getPortsDescription(fsynchronized (this .monitor) {// 將 實 例 id 添 加 到 tomcat 引 擎 名 字 中 ， 格 式 為 “ 原 引 / 擎 名 字 實 例 id”Contextcontext=findContext()://添加生命周期的監昕事件context . addL ifecyclelistener((event) -> {if (context . equals(event. getSource()) && Lifecycle . START EVENT.equals(event . getType()))//移除 connector, 磅保當服務器啟動時不會進行協議綁定})//啟動服務，觸發初始化監聽this. tomcat . start();/可以直接在主線程中重新拋出失敗異常， TomcatStarter 不存在或狀態錯誤均會拋出異常rethrowDeferredStartupExceptions();try/綁定一個命名的 context.到類加載器(), getClass().getClassLoader());sLoader(context, context. getNamingTokencatch (NamingException ex)// 當命名不可用時(拋異常)， 直接跳過并繼續// 與 Jetty 不同， 所有 Tomcat 線程都是守護程序線程。創建一 一個阻止非守護程序止立即關閉startDaemonAwaitThread();} catch (Exception ex) {stopSilently();destroySilently();throw new WebServerException("Unable to start embedded Tomcat", e x)；}}}}

通過以上源代碼，可以看出在 TomcatWebServer 的 initialize 方法中做了以下操作:重命名tomcat 弓|擎名稱、對 Context 添加生命周期監聽事件、啟動服務觸發初始化監聽、檢查TomcatStarter 對象是否存在及 Container 狀態是否正確、綁定命名到類加載器、啟動守護等待線程等。

至此，針對 Tomcat 的 TomcatWebServer 的初始化已經完成。關于其他 Web 容器的WebServer 初始化操作，讀者可仿照本節的思路進行源代碼分析，這里不再逐一講解。