Skip to content
Server Plugin

條件式標頭

必要相依性:io.ktor:ktor-server-conditional-headers

程式碼範例: conditional-headers

原生伺服器Ktor 支援 Kotlin/Native,可讓您在無需額外執行階段或虛擬機的情況下執行伺服器。 支援:✅

ConditionalHeaders 外掛程式可避免在內容自上次請求後未變更時傳送內容主體。這是透過使用以下標頭來實現的:

  • Last-Modified 回應標頭包含資源修改時間。例如,如果用戶端請求包含 If-Modified-Since 值,Ktor 僅會在資源於指定日期之後被修改時才傳送完整回應。請注意,對於靜態檔案,Ktor 會在安裝 ConditionalHeaders 後自動附加 Last-Modified 標頭。
  • Etag 回應標頭是特定資源版本的識別碼。例如,如果用戶端請求包含 If-None-Match 值,在此值與 Etag 相符的情況下,Ktor 將不會傳送完整回應。您可以在設定 ConditionalHeaders 時指定 Etag 值。

新增相依性 ​

若要使用 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。