SpringBoot学习之路---嵌入式Servlet容器自动配置原理

上篇博客介绍了一下嵌入式Servlet容器怎么修改它的默认属性值,这篇博客简单记录一下嵌入式Servlet容器它是怎么帮我们配置的,以及我们自定义它的属性时,它又是怎么运转的?


说起自动配置,我们现在应该不陌生了,无非就是XXXAutoConfiguration,今天的主角也是一样。EmbeddedServletContainerAutoConfiguration这个类就是帮我们自动配置嵌入式的Servlet容器的。点进去看看它的源码:

@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE)
@Configuration
@ConditionalOnWebApplication
@Import(BeanPostProcessorsRegistrar.class)
public class EmbeddedServletContainerAutoConfiguration {

也是一个组合注解,@Configuration表明这是一个配置类,@ConditionalOnWebApplication表明需要web应用,而@Import(BeanPostProcessorsRegistrar.class)则引入了BeanPostProcessorsRegistrar这个类,这个类的具体作用后面再来说明。


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();
		}

	}

这几个方法其实本质上就是来帮我们生成要选用的Servlet容器(tomcat、jetty、undertow)。

这里以tomcat为例:

	@ConditionalOnClass({ Servlet.class, Tomcat.class })//判断当前是否引入了Tomcat依赖;
	@ConditionalOnMissingBean(value = EmbeddedServletContainerFactory.class, search = SearchStrategy.CURRENT)//判断当前容器没有用户自己定义EmbeddedServletContainerFactory:嵌入式的Servlet容器工厂;作用:创建嵌入式的Servlet容器

如果条件成立,它会帮我们在容器中添加TomcatEmbeddedServletContainerFactory这个组件。顾名思义这个工厂对象帮我们生成一个嵌入式的Servlet容器。

EmbeddedServletContainerFactoryTomcatEmbeddedServletContainerFactory的接口规范:

public interface EmbeddedServletContainerFactory {

   //获取嵌入式的Servlet容器
   EmbeddedServletContainer getEmbeddedServletContainer(
         ServletContextInitializer... initializers);

}

它是一个接口,有一个方法可以获取Servlet容器,那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);
}

一目了然了。这个实现方法里面会默认配置一些tomcat的属性,最终把这个tomcat启动和传入进EmbeddedServletContainer中并返回在容器内。

我们如果要选其他的Servlet容器也是差不多的道理。


我们对嵌入式容器的配置修改是怎么生效?

之前我的一篇博客介绍到了要修改嵌入式Servlet容器有两种方法

ServerProperties、EmbeddedServletContainerCustomizer

要么通过ServerProperties提供的属性去配置文件修改,要么自定义一个EmbeddedServletContainerCustomizer来修改,

ServerProperties其实就是EmbeddedServletContainerCustomizer的子类,所以它们其实是一个东西,我们的问题就转换成了EmbeddedServletContainerCustomizer是怎么帮咱们修改配置的呢?

大家还记得吗?刚刚@Import(BeanPostProcessorsRegistrar.class)还没有介绍呢,它导入的这个类到底是什么呢?

BeanPostProcessorsRegistrar简单来说它在底层导入EmbeddedServletContainerCustomizerBeanPostProcessor进容器。

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;
}


方法说明写在注释中了,我们小结一下:

1)、SpringBoot根据导入的依赖情况,给容器中添加相应的EmbeddedServletContainerFactory【TomcatEmbeddedServletContainerFactory】

2)、容器中某个组件要创建对象就会惊动后置处理器;EmbeddedServletContainerCustomizerBeanPostProcessor;

只要是嵌入式的Servlet容器工厂,后置处理器就工作;

3)、后置处理器,从容器中获取所有的EmbeddedServletContainerCustomizer,调用定制器的定制方法

谢谢观看哈!

发布了38 篇原创文章 · 获赞 46 · 访问量 7535

猜你喜欢

转载自blog.csdn.net/Jokeronee/article/details/105223223