Skip to content
Server Plugin

默认标头

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

原生服务器
Ktor 支持 Kotlin/Native,允许您无需额外运行时或虚拟机即可运行服务器。
支持: ✅

DefaultHeaders 插件会将标准的 ServerDate 标头添加到每个响应中。此外,您可以提供额外的默认标头并覆盖 Server 标头。

添加依赖项

要使用 DefaultHeaders,您需要在构建脚本中引入 ktor-server-default-headers artifact:

Kotlin
Groovy
XML

安装 DefaultHeaders

要将 DefaultHeaders 插件安装到应用程序中, 请在指定的

模块
模块允许您通过分组路由来组织应用程序。
中将其传递给 install 函数。 下面的代码片段展示了如何安装 DefaultHeaders ...

  • ... 在 embeddedServer 函数调用内部。
  • ... 在显式定义的 module 内部,它是 Application 类的扩展函数。
kotlin
kotlin

DefaultHeaders 插件也可以安装到特定路由。 如果您需要针对不同的应用程序资源使用不同的 DefaultHeaders 配置,这可能很有用。

配置 DefaultHeaders

添加额外标头

要自定义默认标头列表,请使用 header(name, value) 函数将所需标头传递给 installname 形参接受一个 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 覆盖。