本文首發於個人網站：Spring Boot項目如何同時支持HTTP和HTTPS協議
如今，企業級應用程序的常見場景是同時支持HTTP和HTTPS兩種協議，這篇文章考慮如何讓Spring Boot應用程序同時支持HTTP和HTTPS兩種協議。
準備
爲了使用HTTPS連接器，需要生成一份Certificate keystore，用於加密和機密瀏覽器的SSL溝通。
如果你使用Unix或者Mac OS，可以通過下列命令：keytool -genkey -alias tomcat -keyalg RSA，在生成過程中可能需要你填入一些自己的信息，例如我的機器上反饋如下：
可以看出，執行完上述命令後在home目錄下多了一個新的.keystore文件。
實戰
- 首先在resources目錄下新建一個配置文件tomcat.https.properties，用於存放HTTPS的配置信息；
custom.tomcat.https.port=8443
custom.tomcat.https.secure=true
custom.tomcat.https.scheme=https
custom.tomcat.https.ssl=true
custom.tomcat.https.keystore=${user.home}/.keystore
custom.tomcat.https.keystore-password=changeit- 然後在WebConfiguration類中創建一個靜態類TomcatSslConnectorProperties；
@ConfigurationProperties(prefix = "custom.tomcat.https")
public static class TomcatSslConnectorProperties {
private Integer port;
private Boolean ssl = true;
private Boolean secure = true;
private String scheme = "https";
private File keystore;
private String keystorePassword;
//這裏爲了節省空間，省略了getters和setters，讀者在實踐的時候要加上
public void configureConnector(Connector connector) {
if (port != null) {
connector.setPort(port);
}
if (secure != null) {
connector.setSecure(secure);
}
if (scheme != null) {
connector.setScheme(scheme);
}
if (ssl != null) {
connector.setProperty("SSLEnabled", ssl.toString());
}
if (keystore != null && keystore.exists()) {
connector.setProperty("keystoreFile", keystore.getAbsolutePath());
connector.setProperty("keystorePassword", keystorePassword);
}
}
}- 通過註解加載tomcat.https.properties配置文件，並與TomcatSslConnectorProperties綁定，用註解修飾WebConfiguration類；
@Configuration
@PropertySource("classpath:/tomcat.https.properties")
@EnableConfigurationProperties(WebConfiguration.TomcatSslConnectorProperties.class)
public class WebConfiguration extends WebMvcConfigurerAdapter {...}- 在WebConfiguration類中創建EmbeddedServletContainerFactory類型的Srping bean，並用它添加之前創建的HTTPS連接器。
@Bean
public EmbeddedServletContainerFactory servletContainer(TomcatSslConnectorProperties properties) {
TomcatEmbeddedServletContainerFactory tomcat = new TomcatEmbeddedServletContainerFactory();
tomcat.addAdditionalTomcatConnectors(createSslConnector(properties));
return tomcat;
}
private Connector createSslConnector(TomcatSslConnectorProperties properties) {
Connector connector = new Connector();
properties.configureConnector(connector);
return connector;
}- 通過
mvn spring-boot:run啓動應用程序； - 在瀏覽器中訪問URL
https://localhost:8443/internal/tomcat.https.properties
- 在瀏覽器中訪問URL
http://localhost:8080/internal/application.properties
分析
根據之前的文章和官方文檔，Spring Boot已經對外開放了很多服務器配置，這些配置信息通過Spring Boot內部的ServerProperties類完成綁定，若要參考Spring Boot的通用配置項，請點擊這裏
Spring Boot不支持通過application.properties同時配置HTTP連接器和HTTPS連接器。在官方文檔70.8中提到一種方法，是將屬性值硬編碼在程序中。
因此我們這裏新建一個配置文件tomcat.https.properties來實現，但是這並不符合“Spring Boot風格”，後續有可能應該會支持“通過application.properties同時配置HTTP連接器和HTTPS連接器”。我添加的TomcatSslConnectorProperties是模仿Spring Boot中的ServerProperties的使用機制實現的，這裏使用了自定義的屬性前綴custom.tomcat而沒有用現有的server.前綴，因爲ServerProperties禁止在其他的配置文件中使用該命名空間。
@ConfigurationProperties(prefix = "custom.tomcat.https")這個註解會讓Spring Boot自動將custom.tomcat.https開頭的屬性綁定到TomcatSslConnectorProperties這個類的成員上（確保該類的getters和setters存在）。值得一提的是，在綁定過程中Spring Boot會自動將屬性值轉換成合適的數據類型，例如custom.tomcat.https.keystore的值會自動綁定到File對象keystore上。
使用@PropertySource("classpath:/tomcat.https.properties")來讓Spring Boot加載tomcat.https.properties文件中的屬性。
使用@EnableConfigurationProperties(WebConfiguration.TomcatSslConnectorProperties.class)讓Spring Boot自動創建一個屬性對象，包含上述通過@PropertySource導入的屬性。
在屬性值導入內存，並構建好TomcatSslConnectorProperties實例後，需要創建一個EmbeddedServletContainerFactory類型的Spring bean，用於創建EmbeddedServletContainer。
通過createSslConnector方法可以構建一個包含了我們指定的屬性值的連接器，然後通過tomcat.addAdditionalTomcatConnectors(createSslConnector(properties));設置tomcat容器的HTTPS連接器。
參考資料
Spring Boot 1.x系列
- Spring Boot的自動配置、Command-line-Runner
- 瞭解Spring Boot的自動配置
- Spring Boot的@PropertySource註解在整合Redis中的使用
- Spring Boot項目中如何定製HTTP消息轉換器
- Spring Boot整合Mongodb提供Restful接口
- Spring中bean的scope
- Spring Boot項目中使用事件派發器模式
- Spring Boot提供RESTful接口時的錯誤處理實踐
- Spring Boot實戰之定製自己的starter
本號專注於後端技術、JVM問題排查和優化、Java面試題、個人成長和自我管理等主題，爲讀者提供一線開發者的工作和成長經驗，期待你能在這裏有所收穫。
