Skip to content
Server Plugin

默认标头

必需依赖项:io.ktor:ktor-server-default-headers

原生服务器Ktor 支持 Kotlin/Native,并允许您在无需额外运行时或虚拟机的情况下运行服务器。支持:✅

DefaultHeaders 插件会向每个响应中添加标准的 Server 和 Date 标头。此外,您还可以提供额外的默认标头并重写 Server 标头。

添加依赖项 ​

要使用 DefaultHeaders,请将 ktor-server-default-headers 工件添加到您的构建脚本中:

kotlin
implementation(ktorLibs.server.defaultHeaders)
上述代码片段使用 Ktor 版本目录来指定 Ktor 依赖项。
groovy
implementation ktorLibs.server.defaultHeaders
上述代码片段使用 Ktor 版本目录来指定 Ktor 依赖项。
xml
<dependency>
    <groupId>io.ktor</groupId>
    <artifactId>ktor-server-default-headers-jvm</artifactId>
    <version>${ktor_version}</version>
</dependency>

安装 DefaultHeaders ​

要将 DefaultHeaders 插件安装到您的应用程序中, 请在指定的 模块模块允许您通过对路由进行分组来构建应用程序结构。内将其传递给 install 函数。 以下示例演示了如何安装 DefaultHeaders:

  • 在 embeddedServer() 函数调用中。
  • 在 Application 类上显式定义的 module() 扩展函数中。
kotlin
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)
}
kotlin
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 值,例如:

kotlin
    install(DefaultHeaders) {
        header(HttpHeaders.ETag, "7c876b7e")
    }

要添加自定义标头,请将其名称作为字符串值传递:

kotlin
    install(DefaultHeaders) {
        header("Custom-Header", "Some value")
    }

重写标头 ​

要重写 Server 标头,请使用对应的 HttpHeaders 值:

kotlin
    install(DefaultHeaders) {
        header(HttpHeaders.Server, "Custom")
    }

请注意,出于性能考虑,Date 标头已被缓存,无法使用 DefaultHeaders 进行重写。