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 來進行覆寫。
