Skip to content
Server Plugin

HttpsRedirect

必要的相依性io.ktor:ktor-server-http-redirect

程式碼範例 ssl-engine-main-redirect

Native 伺服器
Ktor 支援 Kotlin/Native,並允許您在沒有額外執行階段或虛擬機的情況下執行伺服器。
支援:✅

HttpsRedirect 外掛程式會在處理呼叫之前,將所有 HTTP 請求重新導向至 HTTPS 對應版本。預設情況下,資源會傳回 301 Moved Permanently,但也可以配置為 302 Found

新增相依性

要使用 HttpsRedirect,您需要在建置指令碼中包含 ktor-server-http-redirect 構件:

Kotlin
Groovy
XML

安裝 HttpsRedirect

要將 HttpsRedirect 外掛程式安裝至應用程式,請將其傳遞給指定

模組
模組允許您透過分組路由來組織應用程式的結構。
中的 install 函式。 下方的程式碼片段展示了如何安裝 HttpsRedirect ...

  • ... 在 embeddedServer 函式呼叫中。
  • ... 在明確定義的 module(即 Application 類別的擴充函式)中。
kotlin
kotlin

上述程式碼會以預設配置安裝 HttpsRedirect 外掛程式。

當位於反向代理後方時,您需要安裝 ForwardedHeaderXForwardedHeader 外掛程式以正確偵測 HTTPS 請求。如果您在安裝這些外掛程式之一後遇到無限次重新導向,請參閱 此常見問題項目 以了解更多詳細資訊。

配置 HttpsRedirect

下方的程式碼片段展示了如何配置所需的 HTTPS 連接埠,並針對請求的資源傳回 301 Moved Permanently

kotlin
install(HttpsRedirect) {
    sslPort = 8443
    permanentRedirect = true
}

您可以在此處找到完整的範例:ssl-engine-main-redirect