本文介紹SpringBoot內(nèi)置web服務(wù)器。知識點有SpringBoot默認web服務(wù)器;如何配置當(dāng)前web容器;內(nèi)嵌Web服務(wù)器如何切換(從tomcat到j(luò)etty);Web容器怎么自動配置;web容器啟動源碼解析;SpringBoot內(nèi)置服務(wù)器不使用SPI機制特別說明。
一、SpringBoot默認web服務(wù)器?
在SpringBoot中采用的默認web服務(wù)器是Tomcat,要了解為什么是Tomcat可從源碼入手。
對于web服務(wù)器的配置,也是在自動配置中找,前面學(xué)習(xí)了SpringBoot自動配置WebMVC的知識,可以推測對于Web服務(wù)器的配置應(yīng)該也是在一個自動配置類當(dāng)中進行的,那么可以去/META-INF/spring.factories文件找一下WebMVC的自動配置,在這個自動配置內(nèi)可以間接找到關(guān)于Web服務(wù)器的配置。
org.springframework.boot.autoconfigure.web.servlet.ServletWebServerFactoryAutoConfiguration,\
在上面SpringBoot包的目錄找到這個路徑下的Web服務(wù)器自動配置類。
這個Web服務(wù)器的自動配置類,我們可以看到這個配置類支持3種web服務(wù)器(Tomcat,Jetty,Undertow),具體要配置哪種服務(wù)器由ServletWebServerFactoryConfiguration來決定,同時這里還定義了一個順序,依次是Tomcat->Jetty->Undertow。
那要選擇哪種服務(wù)器呢?看ServletWebServerFactoryConfiguration。
在這個web服務(wù)器工廠配置類中,分別對上述三種服務(wù)器進行了定義:
對Tomcat定義:判斷環(huán)境中是否引入了Tomcat所需的依賴Servlet.class, Tomcat.class, UpgradeProtocol.class,同時用戶沒有自己進行Web服務(wù)器配置(比如自己通過實現(xiàn)ServletWebServerFactory接口進行手動配置web服務(wù)器),那么這個Tomcat服務(wù)器就會生效。
對Jetty定義:所需要的依賴有Servlet.class, Server.class, Loader.class, WebAppContext.class
對Undertow定義:所需要的依賴有Servlet.class, Undertow.class, SslClientAuthMode.class
那么問題來了,SpringBoot如果這幾種都有,那是怎么選擇呢?從ServletWebServerFactoryAutoConfiguration配置類
@Import({ ServletWebServerFactoryAutoConfiguration.BeanPostProcessorsRegistrar.class, ServletWebServerFactoryConfiguration.EmbeddedTomcat.class, ServletWebServerFactoryConfiguration.EmbeddedJetty.class, ServletWebServerFactoryConfiguration.EmbeddedUndertow.class }) public class ServletWebServerFactoryAutoConfiguration
通過@Import就可以看出這里定義了一個順序,依次是Tomcat->Jetty->Undertow,意思就是當(dāng)環(huán)境中有Tomcat滿足的依賴時就會優(yōu)先使用Tomcat,依次往后推。
而一般情況下,在SpringBoot依賴中默認就已經(jīng)引入tomcat的依賴,因此這里對于tomcat來說一般情況下會恒成立,那么Tomcat就會一直作為恒成立條件被SpringBoot首選為默認服務(wù)器。
二、如何配置當(dāng)前web容器?
想要配置當(dāng)前Web容器,可以通過yml配置讓SpringBoot自動加載解析修改配置,也可以通過提供自定義的@Bean方法忽略SpringBoot自動配置采用手動配置方式。
為什么是通過@Bean提供ServletWebServerFactory和WebServerFactoryCustomizer的Bean交給Spring就可以跳過SpringBoot的自動web服務(wù)器配置呢?可從源碼分析如下:
對于WebServerFactoryCustomizer在上面ServletWebServerFactoryConfiguration配置類Factory配置Tomcat,Jetty時在注解上會判斷存過存在自己手動添加的ServletWebServerFactory則不再進行自動配置:
對于WebServerFactoryCustomizer則在ServletWebServerFactoryAutoConfiguration服務(wù)器自動配置類加載時,如果存在自己定義的WebServerFactoryCustomizer,那么就會觸發(fā)一個WebServerFactoryCustomizerBeanPostProcessor后置處理器,在這個后置處理器中會遍歷這些WebServerFactoryCustomizer并且執(zhí)行內(nèi)部customize方法,從而跳過自動配置,轉(zhuǎn)為進行自定義配置:
三、內(nèi)嵌Web服務(wù)器如何切換(從tomcat到j(luò)etty)?
上面通過源碼可以知道一般情況下,Tomcat會一直作為恒成立條件被SpringBoot首選為默認服務(wù)器。
但是我們?nèi)绻幌胗肨omcat作為默認服務(wù)器,例如想切換為Jetty,那么我們應(yīng)該怎么辦呢?
我們可以把Tomcat的相關(guān)依賴在pom.xml中的spring-boot-starter-web中剔除掉,使環(huán)境不再擁有Tomcat依賴,同時加入Jetty的依賴那么就能使Jetty作為滿足條件被SpringBoot選擇了。
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <!-- 剔除Tomcat --> <exclusions> <exclusion> <artifactId>spring-boot-starter-tomcat</artifactId> <groupId>org.springframework.boot</groupId> </exclusion> </exclusions> </dependency> <!-- 加入jetty --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-jetty</artifactId> </dependency>
這樣,SpringBoot重新啟動后就會切換為Jetty服務(wù)器了。
四、Web容器怎么自動配置?
對于Web容器的自動配置,以Tomcat未來可以看上面提到的TomcatServletWebServerFactory,這是通過@Bean自動注入一個Tomcat的工廠類:
這個工廠類內(nèi)部會對Tomcat進行一些初始化操作,最重要的操作在getWebServer方法內(nèi):
首先這個類是SpringBoot包提供的,用的是最底層的tomcat實例進行配置(通過new Tomcat的方式,而這個Tomcat是tomcat源碼包的一個實例類 package org.apache.catalina.startup),具體的配置細節(jié)不做描述,主要對端口,協(xié)議,tomcat組件對象等進行初始化并封裝:
將要發(fā)布的Web應(yīng)用信息Context初始化到tomcat中:
對初始化好的tomcat進行封裝并啟動:
最后將這個tomcat對象封裝為一個TomcatWebServer對象供SpringBoot啟動時調(diào)用。
綜上,web容器的自動配置,實際上是SpringBoot通過創(chuàng)建原生Tomcat對象,對這個對象進行端口,協(xié)議,組件等初始化,并且將Web應(yīng)用信息Context對象封裝到這個tomcat對象中,然后Web應(yīng)用信息配置生命周期監(jiān)聽生效后啟動tomcat,最后將這個過程
封裝到一個WebServer對象中供SpringBoot啟動時調(diào)用。
五、web容器啟動源碼解析?
SpringBoot是什么時候運行了一個web服務(wù)器呢?這個要從SpringBootApplication.run()方法進行分析。以tomcat為例按照上面提到的,這個啟動過程應(yīng)該會調(diào)用到TomcatServletWebServerFactory.getWebServer方法獲取這么一個tomcat實例。
調(diào)用鏈可看下面圖示:
SpringBootApplication.run():
context = createApplicationContext():創(chuàng)建Context環(huán)境,這個方法內(nèi)會根據(jù)當(dāng)前環(huán)境初始化不同的Context,如果是Web環(huán)境則會初始化出AnnotationConfigServletWebApplicationContext:
初始化AnnotationConfigServletWebApplicationContext之后,在構(gòu)造函數(shù)調(diào)用這個context的refresh方法-->onRefresh方法:
調(diào)用onRefresh方法,就會調(diào)用到ServletWebServerApplicationContext的onRefresh方法,在這個方法內(nèi),就對web服務(wù)器進行了創(chuàng)建操作createWebServer():
在createWebServer()方法中,會判斷是外置還是內(nèi)置方式發(fā)布應(yīng)用,分別進行不同的邏輯操作。我們這里以內(nèi)置來學(xué)習(xí):
這樣,SpringBoot啟動時在創(chuàng)建Web服務(wù)器時,就執(zhí)行到了getWebServer的操作,然后再對Web服務(wù)器進行創(chuàng)建,初始化和啟動操作。
綜上:在SpringBoot的run啟動時,會判斷當(dāng)前所處環(huán)境。
如果是Web環(huán)境則通過創(chuàng)建一個ServletWebServerApplicationContext,執(zhí)行構(gòu)造函數(shù)的refresh方法,在refresh方法內(nèi)重寫onRefresh方法,執(zhí)行創(chuàng)建createWebServer()方法,這個方法會根據(jù)當(dāng)前應(yīng)用是內(nèi)置還是外置發(fā)布方式來決定以何種方式獲取web服務(wù)器。
如果是內(nèi)置方式則通過TomcatServletWebServerFactory工廠類來獲取一個首選的web服務(wù)器,然后進行服務(wù)器的初始化配置,應(yīng)用加載生效以及服務(wù)器啟動的操作。
六、SpringBoot內(nèi)置服務(wù)器不使用SPI機制特別說明?
最后還有一個結(jié)論要記住:對于SpringBoot內(nèi)置服務(wù)器不會通過SPI的機制(官網(wǎng)也有特別說明),因為SpringBoot內(nèi)置服務(wù)器是SpringBoot自己幫我們創(chuàng)建了web服務(wù)器來發(fā)布應(yīng)用,不使用SPI機制的目的就是盡可能減少內(nèi)置和外置web服務(wù)器可能存在的沖突,讓web應(yīng)用由SpringBoot自己來管理。詳細原因和原理這里不做研究。
至此,關(guān)于SpringBoot內(nèi)置服務(wù)器的相關(guān)知識解析就到此了。
以上為個人經(jīng)驗,希望能給大家一個參考,也希望大家多多支持服務(wù)器之家。
原文鏈接:https://blog.csdn.net/qq_20395245/article/details/106816754