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 アーティファクトを追加します:
implementation(ktorLibs.server.httpRedirect)implementation ktorLibs.server.httpRedirect<dependency>
<groupId>io.ktor</groupId>
<artifactId>ktor-server-http-redirect-jvm</artifactId>
<version>${ktor_version}</version>
</dependency>HttpsRedirect のインストール
アプリケーションに HttpsRedirect プラグインをインストールするには、指定した モジュールモジュールを使用すると、ルートをグループ化してアプリケーションを構造化できます。 内で install 関数に渡します。 以下の例は、HttpsRedirect をインストールする方法を示しています:
embeddedServer()関数の呼び出し内。Applicationクラスに明示的に定義されたmodule()拡張関数内。
import io.ktor.server.engine.*
import io.ktor.server.netty.*
import io.ktor.server.application.*
import io.ktor.server.plugins.httpsredirect.*
fun main() {
embeddedServer(Netty, port = 8080) {
install(HttpsRedirect)
// ...
}.start(wait = true)
}import io.ktor.server.application.*
import io.ktor.server.plugins.httpsredirect.*
// ...
fun Application.module() {
install(HttpsRedirect)
// ...
}上記のコードは、デフォルト設定で HttpsRedirect プラグインをインストールします。
リバースプロキシの背後にある場合は、HTTPSリクエストを適切に検出するために ForwardedHeader または XForwardedHeader プラグインをインストールする必要があります。これらのプラグインのいずれかをインストールした後に無限リダイレクトが発生する場合は、詳細についてこちらのFAQ項目を確認してください。
HttpsRedirect の設定
以下のコードスニペットは、目的のHTTPSポートを設定し、リクエストされたリソースに対して 301 Moved Permanently を返すように設定する方法を示しています:
install(HttpsRedirect) {
sslPort = 8443
permanentRedirect = true
}完全なサンプルはこちらで確認できます: ssl-engine-main-redirect。
