Server Plugin

預設標頭

所需依賴: io.ktor:ktor-server-default-headers

原生伺服器

Ktor 支援 Kotlin/Native，並允許您在沒有額外運行時或虛擬機器的情況下運行伺服器。

支援: ✅

DefaultHeaders 插件會將標準的 Server 和 Date 標頭加入到每個回應中。此外，您還可以提供額外的預設標頭並覆寫 Server 標頭。

加入依賴

若要使用 DefaultHeaders，您需要將 ktor-server-default-headers Artifact 包含在建置腳本中：

Gradle (Kotlin)Gradle (Groovy)Maven

安裝 DefaultHeaders

若要將 DefaultHeaders 插件安裝到應用程式中， 請將其傳遞給指定

模組

模組允許您透過分組路由來組織應用程式。

中的 install 函數。 下方的程式碼片段展示了如何安裝 DefaultHeaders ...

• ... 在 embeddedServer 函數呼叫中。
• ... 在明確定義的 module 內部，該模組是 Application 類別的擴展函數。

embeddedServermodule

DefaultHeaders 插件也可以安裝到特定路由。 如果您需要為不同的應用程式資源提供不同的 DefaultHeaders 設定，這可能很有用。

配置 DefaultHeaders

加入額外標頭

若要自訂預設標頭清單，請透過使用 header(name, value) 函數將所需的標頭傳遞給 install。 name 參數接受一個 HttpHeaders 值，例如：

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

若要加入自訂標頭，請將其名稱作為字串值傳遞：

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

覆寫標頭

若要覆寫 Server 標頭，請使用對應的 HttpHeaders 值：

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

請注意，Date 標頭出於效能原因而被快取，並且無法透過使用 DefaultHeaders 來覆寫。