Skip to content
Server Plugin

条件付きヘッダー

必要な依存関係: io.ktor:ktor-server-conditional-headers

コード例: conditional-headers

NativeサーバーKtorはKotlin/Nativeをサポートしており、追加のランタイムや仮想マシンなしでサーバーを実行できます。のサポート: ✅

ConditionalHeadersプラグインは、前回のキエスト以降に変更されていない場合、コンテンツのボディの送信を回避します。これは以下のヘッダーを使用して実現されます。

  • Last-Modifiedレスポンスヘッダーには、リソースの変更日時が含まれます。例えば、クライアントリクエストにIf-Modified-Sinceの値が含まれている場合、Ktorは指定された日付以降にリソースが変更されている場合にのみ完全なレスポンスを送信します。静的ファイルの場合、ConditionalHeadersをインストールすると、Ktorが自動的にLast-Modifiedヘッダーを追加することに注意してください。
  • Etagレスポンスヘッダーは、特定のリソースバージョンの識別子です。例えば、クライアントリクエストにIf-None-Matchの値が含まれている場合、その値がEtagと一致すれば、Ktorは完全なレスポンスを送信しません。Etagの値はConditionalHeadersの設定時に指定できます。

依存関係の追加 ​

ConditionalHeadersを使用するには、ビルドスクリプトにktor-server-conditional-headersアーティファクトを追加します。

kotlin
implementation(ktorLibs.server.conditionalHeaders)
上記のコードスニペットでは、Ktorの依存関係を指定するために Ktorバージョンカタログを使用しています。
groovy
implementation ktorLibs.server.conditionalHeaders
上記のコードスニペットでは、Ktorの依存関係を指定するために Ktorバージョンカタログを使用しています。
xml
<dependency>
    <groupId>io.ktor</groupId>
    <artifactId>ktor-server-conditional-headers-jvm</artifactId>
    <version>${ktor_version}</version>
</dependency>

ConditionalHeadersのインストール ​

ConditionalHeadersプラグインをアプリケーションにインストールするには、指定したモジュールモジュールを使用すると、ルートをグループ化してアプリケーションを構造化できます。内のinstall関数に渡します。 以下の例は、ConditionalHeadersをインストールする方法を示しています。

  • embeddedServer()関数呼び出し内でのインストール。
  • Applicationクラスの明示的に定義されたmodule()拡張関数内でのインストール。
kotlin
import io.ktor.server.engine.*
import io.ktor.server.netty.*
import io.ktor.server.application.*
import io.ktor.server.plugins.conditionalheaders.*

fun main() {
    embeddedServer(Netty, port = 8080) {
        install(ConditionalHeaders)
        // ...
    }.start(wait = true)
}
kotlin
import io.ktor.server.application.*
import io.ktor.server.plugins.conditionalheaders.*
// ...
fun Application.module() {
    install(ConditionalHeaders)
    // ...
}

ConditionalHeadersプラグインは、特定のルートにインストールすることもできます。 これは、アプリケーションの異なるリソースに対して異なるConditionalHeaders設定が必要な場合に役立ちます。

ヘッダーの設定 ​

ConditionalHeadersを設定するには、installブロック内でversion関数を呼び出す必要があります。この関数は、指定されたApplicationCallおよびOutgoingContentに対するリソースバージョンのリストへのアクセスを提供します。EntityTagVersionおよびLastModifiedVersionクラスオブジェクトを使用して、必要なバージョンを指定できます。

以下のコードスニペットは、CSSにEtagおよびLast-Modifiedヘッダーを追加する方法を示しています。

kotlin
install(ConditionalHeaders) {
    val file = File("src/main/kotlin/com/example/Application.kt")
    version { call, outgoingContent ->
        when (outgoingContent.contentType?.withoutParameters()) {
            ContentType.Text.CSS -> listOf(
                EntityTagVersion(file.lastModified().hashCode().toString()),
                LastModifiedVersion(Date(file.lastModified()))
            )
            else -> emptyList()
        }
    }
}

完全な例はこちらにあります: conditional-headers。