Spring Boot 项目启动指定 HTTP 端口的几种方式

从上面的章节当中，我们可以看到 Spring Boot 在启动容器的时候默认通过 8080 来暴露 http 服务的。如果我们需要指定暴露 http 服务的端口，我们应该怎么做呢？其实可以通过下面几种方式来指定我们暴露的 http 服务端口。

1、配置文件

我们可以在配置文件当中通过 server.port 来指定我们服务启动暴露的端口。

application.properties

server.port=8888

启动控制台，日志如下所示：

它的实现原理如下：

[server.port] -> 
ServerProperties -> 
ServletWebServerFactoryCustomizer ->
ConfigurableWebServerFactory -> 
TomcatServletWebServerFactory

2、自定义 TomcatConnectorCustomizer

Spring 项目当中，可以通过 ServletWebServerFactory 来获取到 WebServer.Tomcat 的实现类是 TomcatServletWebServerFactory。在这个对象里面，可以通过 tomcatConnectorCustomizers 属性它是一个 Set<TomcatConnectorCustomizer> 。TomcatConnectorCustomizer 可以指定容器启动暴露的端口。

自定义 TomcatConnectorCustomizer

@Bean
public TomcatConnectorCustomizer customServerPortTomcatConnectorCustomizer() {
    return connector -> connector.setPort(8888);
}

启动控制台，日志如下所示：

3、自定义 WebServerFactoryCustomizer

TomcatServletWebServerFactory 不仅仅实现了 ServletWebServerFactory ，同时他也实现了WebServerFactory。而且 Spring Boot 来提供了 WebServerFactoryCustomizer 这个接口来定制化WebServerFactory， TomcatServletWebServerFactory同时也是实现了WebServerFactory的子接口 ConfigurableWebServerFactory。这个接口是可以对 WebServer 进行配置化，包括 Web 容器的端口。

自定义 WebServerFactoryCustomizer

@Bean
public WebServerFactoryCustomizer customServerPortWebServerFactoryCustomizer() {
    return factory -> {
        if (factory instanceof ConfigurableWebServerFactory) {
            ConfigurableWebServerFactory webServerFactory = ConfigurableWebServerFactory.class.cast(factory);
            webServerFactory.setPort(8888);
        }
    };
}

启动控制台，日志如下所示：

4、自定义 BeanPostProcessor

其实自定义 WebServerFactoryCustomizer 它的起始类是通过 WebServerFactoryCustomizerBeanPostProcessor 来进行自定义 WebServerFactory。具体的代码逻辑如下：

我们也可以模仿它通过自定义 BeanPostProcess 来自定义 Web 容器暴露的端口。

自定义 BeanPostProcessor

@Bean
public BeanPostProcessor customServerPortBeanPostProcessor() {
    return new BeanPostProcessor() {
        @Override
        public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
            if(bean instanceof ConfigurableWebServerFactory) {
                ConfigurableWebServerFactory webServerFactory = ConfigurableWebServerFactory.class.cast(bean);
                webServerFactory.setPort(8888);
            }
            return bean;
        }
    };
}

启动控制台，日志如下所示：

5、指定传入请求参数

在 Idea 工具中添加项目请求参数： --server.port=8888，如下所示：

启动控制台，日志如下所示：

它的实现原理是通过：org.springframework.boot.SpringApplication#configurePropertySources 把请求参数添加到 Spring 对环境变量的抽象 Environment 当中，然后通过以下方式把 server.port 设置到 Tomcat 容器当中：

把 Environment 值设置 Tomcat 的 port

- ConfigurationPropertiesBindingPostProcessor#postProcessBeforeInitialization 
把 Environment 中的 [server.port] 绑定到 ServerProperties 这个 bean 当中
- ServletWebServerFactoryCustomizer#customize
把 ServerProperties 的 port 设置到 Tomcat 当中
- AbstractConfigurableWebServerFactory#setPort

6、指定传入系统参数

在 Idea 工具中添加系统变量： -Dserver.port=8888，如下所示：

然后在 org.springframework.boot.SpringApplication#prepareEnvironment 调用 getOrCreateEnvironment() 之后，查看 environment，通过如下公式获取 ConfigurableEnvironment 对象中的 server.port

environment.getPropertySources().get("systemProperties").getProperty("server.port")

如下所示：

然后通过以下方式把 server.port 设置到 Tomcat 容器当中：

把 Environment 值设置 Tomcat 的 port

- ConfigurationPropertiesBindingPostProcessor#postProcessBeforeInitialization 
把 Environment 中的 [server.port] 绑定到 ServerProperties 这个 bean 当中
- ServletWebServerFactoryCustomizer#customize
把 ServerProperties 的 port 设置到 Tomcat 当中
- AbstractConfigurableWebServerFactory#setPort

以上就是博主现在已知的修改Spring Boot 项目启动指定 HTTP 端口的几种方式。