デフォルトヘッダー
必要な依存関係: io.ktor:ktor-server-default-headers
NativeサーバーKtorはKotlin/Nativeをサポートしており、追加のランタイムや仮想マシンなしでサーバーを実行できます。のサポート: ✅
DefaultHeaders プラグインは、各レスポンスに標準の Server および Date ヘッダーを追加します。さらに、追加のデフォルトヘッダーを指定したり、Server ヘッダーを上書きしたりすることもできます。
依存関係の追加
DefaultHeaders を使用するには、ビルドスクリプトに ktor-server-default-headers アーティファクトを追加します。
implementation(ktorLibs.server.defaultHeaders)implementation ktorLibs.server.defaultHeaders<dependency>
<groupId>io.ktor</groupId>
<artifactId>ktor-server-default-headers-jvm</artifactId>
<version>${ktor_version}</version>
</dependency>DefaultHeaders のインストール
アプリケーションに DefaultHeaders プラグインをインストールするには、指定したモジュールモジュールを使用すると、ルートをグループ化してアプリケーションを構造化できます。内の install 関数に渡します。 次の例は、DefaultHeaders をインストールする方法を示しています。
embeddedServer()関数呼び出し内でのインストール。Applicationクラスで明示的に定義されたmodule()拡張関数内でのインストール。
import io.ktor.server.engine.*
import io.ktor.server.netty.*
import io.ktor.server.application.*
import io.ktor.server.plugins.defaultheaders.*
fun main() {
embeddedServer(Netty, port = 8080) {
install(DefaultHeaders)
// ...
}.start(wait = true)
}import io.ktor.server.application.*
import io.ktor.server.plugins.defaultheaders.*
// ...
fun Application.module() {
install(DefaultHeaders)
// ...
}DefaultHeaders プラグインは、特定のルートにインストールすることもできます。 これは、アプリケーションの異なるリソースに対して異なる DefaultHeaders 設定が必要な場合に便利です。
DefaultHeaders の設定
追加ヘッダーの追加
デフォルトヘッダーのリストをカスタマイズするには、header(name, value) 関数を使用して、追加したいヘッダーを install に渡します。name パラメーターには HttpHeaders の値を受け取ります。例:
install(DefaultHeaders) {
header(HttpHeaders.ETag, "7c876b7e")
}カスタムヘッダーを追加するには、その名前を文字列値として渡します:
install(DefaultHeaders) {
header("Custom-Header", "Some value")
}ヘッダーの上書き
Server ヘッダーを上書きするには、対応する HttpHeaders の値を使用します:
install(DefaultHeaders) {
header(HttpHeaders.Server, "Custom")
}パフォーマンス上の理由から Date ヘッダーはキャッシュされており、DefaultHeaders を使用して上書きすることはできない点に注意してください。
