Spring Boot 中嵌入式 Servlet 容器自動配置原理解析
1.參照 Spring Boot 自動配置包裡面的web模塊
EmbeddedServletContainerAutoConfiguration 嵌入式的 Servlet 容器自動配置
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE) @Configuration @ConditionalOnWebApplication @Import(BeanPostProcessorsRegistrar.class) //導入BeanPostProcessorsRegistrar:Spring註解版;給容器中導入一些組件 //導入瞭EmbeddedServletContainerCustomizerBeanPostProcessor: //後置處理器:bean初始化前後(創建完對象,還沒賦值賦值)執行初始化工作 public class EmbeddedServletContainerAutoConfiguration { ..... @Configuration @ConditionalOnClass({ Servlet.class, Tomcat.class })//判斷當前是否引入瞭Tomcat依賴; @ConditionalOnMissingBean(value = EmbeddedServletContainerFactory.class, search = SearchStrategy.CURRENT)//判斷當前容器沒有用戶自己定義EmbeddedServletContainerFactory:嵌入式的Servlet容器工廠;作用:創建嵌入式的Servlet容器 public static class EmbeddedTomcat { @Bean public TomcatEmbeddedServletContainerFactory tomcatEmbeddedServletContainerFactory() { return new TomcatEmbeddedServletContainerFactory(); } } /** * Nested configuration if Jetty is being used. */ @Configuration @ConditionalOnClass({ Servlet.class, Server.class, Loader.class, WebAppContext.class }) @ConditionalOnMissingBean(value = EmbeddedServletContainerFactory.class, search = SearchStrategy.CURRENT) public static class EmbeddedJetty { @Bean public JettyEmbeddedServletContainerFactory jettyEmbeddedServletContainerFactory() { return new JettyEmbeddedServletContainerFactory(); } } /** * Nested configuration if Undertow is being used. */ @Configuration @ConditionalOnClass({ Servlet.class, Undertow.class, SslClientAuthMode.class }) @ConditionalOnMissingBean(value = EmbeddedServletContainerFactory.class, search = SearchStrategy.CURRENT) public static class EmbeddedUndertow { @Bean public UndertowEmbeddedServletContainerFactory undertowEmbeddedServletContainerFactory() { return new UndertowEmbeddedServletContainerFactory(); } }
2.EmbeddedServletContainerFactory(嵌入式Servlet容器工廠)
public interface EmbeddedServletContainerFactory { //獲取嵌入式的Servlet容器 EmbeddedServletContainer getEmbeddedServletContainer( ServletContextInitializer... initializers); }
Ctrl+H 顯示繼承關系:
3.EmbeddedServletContainer(嵌入式的Servlet容器)
4.以TomcatEmbeddedServletContainerFactory為例
@Override public EmbeddedServletContainer getEmbeddedServletContainer( ServletContextInitializer... initializers) { //創建一個Tomcat Tomcat tomcat = new Tomcat(); //配置Tomcat的基本環節 File baseDir = (this.baseDirectory != null ? this.baseDirectory : createTempDir("tomcat")); tomcat.setBaseDir(baseDir.getAbsolutePath()); Connector connector = new Connector(this.protocol); tomcat.getService().addConnector(connector); customizeConnector(connector); tomcat.setConnector(connector); tomcat.getHost().setAutoDeploy(false); configureEngine(tomcat.getEngine()); for (Connector additionalConnector : this.additionalTomcatConnectors) { tomcat.getService().addConnector(additionalConnector); } prepareContext(tomcat.getHost(), initializers); //將配置好的Tomcat傳入進去,返回一個EmbeddedServletContainer;並且啟動Tomcat服務器 return getTomcatEmbeddedServletContainer(tomcat); }
5.嵌入式容器的配置修改生效原理
依次向下生效:
ServerProperties
:綁定配置文件裡面的屬性EmbeddedServletContainerCustomizer
:嵌入式Servlet容器的定制器,修改Servlet容器配置EmbeddedServletContainerCustomizerBeanPostProcessor
//初始化之前 @Override public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { //如果當前初始化的是一個ConfigurableEmbeddedServletContainer類型的組件 if (bean instanceof ConfigurableEmbeddedServletContainer) { // postProcessBeforeInitialization((ConfigurableEmbeddedServletContainer) bean); } return bean; } private void postProcessBeforeInitialization( ConfigurableEmbeddedServletContainer bean) { //獲取所有的定制器,調用每一個定制器的customize方法來給Servlet容器進行屬性賦值; for (EmbeddedServletContainerCustomizer customizer : getCustomizers()) { customizer.customize(bean); } } private Collection<EmbeddedServletContainerCustomizer> getCustomizers() { if (this.customizers == null) { // Look up does not include the parent context this.customizers = new ArrayList<EmbeddedServletContainerCustomizer>( this.beanFactory //從容器中獲取所有這葛類型的組件:EmbeddedServletContainerCustomizer //定制Servlet容器,給容器中可以添加一個EmbeddedServletContainerCustomizer類型的組件 .getBeansOfType(EmbeddedServletContainerCustomizer.class, false, false) .values()); Collections.sort(this.customizers, AnnotationAwareOrderComparator.INSTANCE); this.customizers = Collections.unmodifiableList(this.customizers); } return this.customizers; } //ServerProperties也是定制器
步驟:
1、Spring Boot 根據導入的依賴情況,給容器中添加相應的EmbeddedServletContainerFactory【TomcatEmbeddedServletContainerFactory】
2、容器中某個組件要創建對象就會驚動後置處理器;EmbeddedServletContainerCustomizerBeanPostProcessor;隻要是嵌入式的 Servlet 容器工廠,後置處理器就工作;
3、後置處理器,從容器中獲取所有的 EmbeddedServletContainerCustomizer,調用定制器的定制方法
本文需結合代碼片段內的文字註釋瀏覽。
以上為個人經驗,希望能給大傢一個參考,也希望大傢多多支持WalkonNet。
推薦閱讀:
- 解決springboot URL帶有斜杠的轉義字符百分之2F導致的400錯誤
- 解決springboot application.properties server.port配置問題
- 解決SpringBoot內嵌Tomcat並發容量的問題
- Java Springboot之Spring傢族的技術體系
- Spring Boot優化後啟動速度快到飛起技巧示例