Spring Boot - 支持 HTTPS

前言

基本上現在網絡訪問都會使用 HTTPS,因此很有必要為我們的后端應用增添 HTTPS 訪問能力。

本篇博文主要介紹下在 Spring Boot 下開啟 HTTPS 訪問配置過程。

準備工作

HTTPS 訪問前提是需要有一個 HTTPS 證書,證書的獲取過程常見的有如下途徑:

  • 商用證書:一些專業的商用證書需要我們進行購買,價格也挺貴的。
  • 免費證書:網絡上有些機構會提供一些免費證書,比如一些云服務器廠商,一個賬號可以申請多個證書(20 個左右),證書有效期大概一年左右。
  • 本地證書:如果只是對本地 HTTPS 訪問進行測試,我們可以直接使用 Java JDK 自帶的管理工具keytool來生成一個本地證書。

這里我們為 Spring Boot 配置 HTTPS,就直接使用 本地證書 即可,進入到%JAVA_HOME%/bin目錄,執行如下命令生成一個本地數字證書:

keytool -genkey -alias tomcathttps -keyalg RSA -keysize 2048 -keystore whyn.p12 -validity 5

其中:

  • -genkey:表示創建一個新的密鑰
  • -alias:表示密鑰(即 keystore,相當于加密后的私鑰)的別名
  • -keyalg RSA:表示使用的加密算法是 RSA,一種非對稱性加密算法
  • -keysize:表示密鑰長度
  • -keystore:表示生成的密鑰存放位置
  • -validity:表示密鑰有效時間,單位為天

執行以上命令,最終會生成一個密鑰,我們這里的密鑰為:whyn.p12

導入密鑰

上面步驟我們已經生成了一個密鑰文件whyn.p12,接下來就可以將其導入到 Spring Boot 項目中了,步驟如下:

  • 將密鑰whyn.p12拷貝到項目resources目錄下

  • application.properties中,配置服務器開啟 HTTPS:

    # 配置端口
    server.port=8080
    # 配置協議
    server.ssl.protocol=TLS
    # 密鑰文件名
    server.ssl.key-store=classpath:whyn.p12 
    # 密鑰別名
    server.ssl.key-alias=tomcathttps 
    # 密鑰密碼
    server.ssl.key-store-password=123456
    

以上就已完成了配置,此時運行項目,瀏覽器輸入https://localhost:8080就可以進行訪問。

:由于我們使用的是自簽名證書,不被系統信任,因此第一次訪問時,瀏覽器會出現以下警告頁面,此時我們允許繼續訪問即可。

同時支持 HTTP 和 HTTPS

按上文配置,此時如果我們訪問http://localhost:8080,會發現訪問失敗,這是因為 Spring Boot 默認不支持同時在配置中啟動 HTTP 和 HTTPS。

如果我們想同時支持 HTTP 和 HTTPS,只需將其中一個用代碼進行配置即可。

Spring Boot 推薦的做法是使用配置文件配置開啟 HTTPS,而使用代碼配置開啟 HTTP,因為 HTTP 通過代碼進行開啟的方式相對簡單,如下所示:

@Configuration
public class EnableHTTPConfig {

    @Bean
    public ServletWebServerFactory servletContainer() {
        TomcatServletWebServerFactory tomcat = new TomcatServletWebServerFactory();
        tomcat.addAdditionalTomcatConnectors(createTomcatConnector());
        return tomcat;
    }

    private Connector createTomcatConnector() {
        Connector connector = new Connector("org.apache.coyote.http11.Http11NioProtocol");
        connector.setPort(8081);
        return connector;
    }
}

我們只需向 Spring IOC 容器中注入一個配置Bean即可,此時運行程序,可以看到以下輸出:

enable http & https

可以看到,我們已經成功同時開啟了 HTTP 和 HTTPS 協議。

:實際上,雖然我們能同時啟用 HTTP 和 HTTPS,但在實際項目部署時,一般都避免使用 HTTP 進行訪問,因為 HTTP 是明文傳輸,信息很容易被別人截獲,使用 HTTPS 的安全性會更高一些。
因此,更加常用的做法是將 HTTP 的訪問重定向到對應的 HTTPS 中,具體代碼如下:

@Configuration
public class EnableHTTPConfig {

    @Bean
    TomcatServletWebServerFactory servletContainer() {
        TomcatServletWebServerFactory tomcat = new TomcatServletWebServerFactory() {
            @Override
            protected void postProcessContext(Context context) {
                SecurityConstraint constraint = new SecurityConstraint();
                constraint.setUserConstraint("CONFIDENTIAL");
                SecurityCollection collection = new SecurityCollection();
                collection.addPattern("/*");
                constraint.addCollection(collection);
                context.addConstraint(constraint);
            }
        };
        tomcat.addAdditionalTomcatConnectors(createTomcatConnector());
        return tomcat;
    }

    private Connector createTomcatConnector() {
        Connector connector = new Connector("org.apache.coyote.http11.Http11NioProtocol");
        connector.setScheme("http");
        connector.setPort(8081);
        connector.setSecure(false);
        // 重定向到 8080 端口
        connector.setRedirectPort(8080);
        return connector;
    }
}

上述代碼中,我們配置了 HTTP 請求的端口為 8081,并配置了將來自 8081 端口的所有請求都重定向到 8080 端口。

參考

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,443評論 6 532
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,530評論 3 416
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事?!?“怎么了?”我有些...
    開封第一講書人閱讀 176,407評論 0 375
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,981評論 1 312
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,759評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,204評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,263評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,415評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,955評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,782評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,983評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,528評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,222評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,650評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,892評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,675評論 3 392
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,967評論 2 374