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。