Server Plugin

HttpsRedirect

所需依賴項: io.ktor:ktor-server-http-redirect

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

原生伺服器

Ktor 支援 Kotlin/Native，可讓您在沒有額外執行時間或虛擬機器的情況下執行伺服器。

支援: ✅

HttpsRedirect 插件會在處理呼叫之前，將所有 HTTP 請求重新導向至其 HTTPS 對應項。預設情況下，資源會傳回 301 Moved Permanently，但可以配置為 302 Found。

新增依賴項

若要使用 HttpsRedirect，您需要在建置腳本中包含 ktor-server-http-redirect artifact：

Gradle (Kotlin)Gradle (Groovy)Maven

安裝 HttpsRedirect

若要將 HttpsRedirect 插件安裝到應用程式中， 請在指定的

模組

模組可讓您透過分組路由來建構應用程式。

中將其傳遞給 install 函數。 以下程式碼片段顯示了如何安裝 HttpsRedirect ...

• ... 在 embeddedServer 函數呼叫內部。
• ... 在明確定義的 module 內部，它是 Application 類別的擴充功能。

embeddedServermodule

上述程式碼會以預設配置安裝 HttpsRedirect 插件。

當位於反向代理之後時，您需要安裝 ForwardedHeader 或 XForwardedHeader 插件以正確偵測 HTTPS 請求。如果您在安裝其中一個插件後遇到無限重新導向，請查看 此常見問題 (FAQ) 條目 以取得更多詳細資訊。

配置 HttpsRedirect

以下程式碼片段顯示了如何配置所需的 HTTPS 連接埠，並為所請求的資源傳回 301 Moved Permanently：

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

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