天天看点

SpringBoot之浅析TomCat端口号设置

修改TomCat的端口号大概可以分为这样的两类吧,一种是用配置项的方式,另一种是用程序实现的方式。配置项包含:设置命令行参数、系统参数、虚拟机参数、SpringBoot默认的application.properties(或者是application.yml等类似的方式)。用程序实现的方式,则需要实现EmbeddedServletContainerCustomizer接口,并将此实现类注入为Spring的Bean。我们先说配置项的方式。

通常我们用配置项的方式来修改TomCat端口号的时候,需要进行这样的配置(或类似的方式):

看到这样的一个配置项再结合我们自己在使用ConfigurationProperties的时候所进行的设置,我们可以推断一下应该会存在一个这样的JavaBean,在这个JavaBean上使用了ConfigurationProperties注解,并且它的prefix的值为server。既然有了一个这样的推想,那么我们就要去证明这个推想。在SpringBoot中也确实存在了我们所推想的这样的一个JavaBean:ServerProperties。ServerProperties这个类的UML如下所示:

SpringBoot之浅析TomCat端口号设置

ServerProperties实现了EnvironmentAware接口,说明它可以获取Environment中的属性值,它也实现了Ordered接口,这个这里先记着,我们在后面再说,它也实现了EmbeddedServletContainerCustomizer接口,我们在上面说的第二种修改TomCat端口号的方式就是实现EmbeddedServletContainerCustomizer接口,并注入为Spring的Bean,而ServerProperties就实现了这个接口。但是这里还有一个问题,在这个类上没有添加Component注解(或者是相同作用的注解)。但是我们在SpringBoot中还发现了这样的一个类:ServerPropertiesAutoConfiguration。从名字我们可以猜出这个类应该是为ServerProperties提供自动配置的一个类,这个类也确实是这样的一个作用,关于SpringBoot的自动配置功能比较复杂,我们这里先不展开,有这方面疑问的童鞋可以在下面留言。我们去ServerPropertiesAutoConfiguration这个类中看一下这个类的代码:

通过上面的分析,我们看到了在哪里将ServerProperties包装为Spring容器的Bean的。下面我们来简单的说一下ServerProperties这个类中都为我们提供了什么东西:

以及它的内部类,分别用来做和TomCat设置相关的内容、Jetty设置相关的内容、Undertow设置相关的内容以及Session设置相关的内容。关于ServerProperties中的属性值的设置请参考之前的文章,这里就不再多说了。

SpringBoot之浅析TomCat端口号设置

在ServerProperties中最重要的一个方法是customize方法,这个方法是用来设置容器相关的内容的。

现在的关键问题是customize这个方法是在什么时候被调用的呢?通过翻开它的调用链,我们在SpringBoot中发现了这样的一个类:EmbeddedServletContainerCustomizerBeanPostProcessor在这个类中有这样的一个方法,

如果你对Spring中的生命周期熟悉的话,那么你看到postProcessBeforeInitialization这个方法的时候一定不会陌生,首先应该想到它应该是实现了BeanPostProcessor这个接口。那么现在还存在的一个问题是,只有这个类是一个Spring中的Bean的时候,它才会被调用到,那么这个类是什么时候被注入到Spring的容器中的呢 ?答案就在EmbeddedServletContainerAutoConfiguration这个类中。这个类的作用是自动配置嵌入式的Servlet容器。在这个类上用了这样的一个注解:

Import这个注解在实现SpringBoot的自动配置功能的时候起到了非常重要的作用!Import这个注解中的value所指定的Class可以分为这样的三类:一类是实现了ImportSelector接口,一类是实现了ImportBeanDefinitionRegistrar接口,不属于前面说的这两种的就是第三种,具体的可以看一下这个方法org.springframework.context.annotation.ConfigurationClassParser#processImports。而上面所提到的BeanPostProcessorsRegistrar这个类就是实现了ImportBeanDefinitionRegistrar这个接口的。我们看一下这个类中的内容(EmbeddedServletContainerAutoConfiguration的内部类):

到现在为止,关于SpringBoot设置TomCat启动端口号的简单分析就算是结束了。但是这里还有一个问题,如果我们既用配置项的形式设置了TomCat的端口号,同时又自定义了一个实现了EmbeddedServletContainerCustomizer接口的Bean,并且没有Order相关的设置,那么最终生效的会是哪个配置呢?答案是实现了EmbeddedServletContainerCustomizer接口的Spring Bean。在org.springframework.boot.context.embedded.EmbeddedServletContainerCustomizerBeanPostProcessor#postProcessBeforeInitialization(org.springframework.boot.context.embedded.ConfigurableEmbeddedServletContainer)中的方法的内容如下: