Server Plugin

預設標頭

必要的相依性：io.ktor:ktor-server-default-headers

原生伺服器

Ktor supports Kotlin/Native and allows you to run a server without an additional runtime or virtual machine.

支援：✅

DefaultHeaders 外掛程式會將標準的 Server 與 Date 標頭新增至每個回應中。此外，您可以提供額外的預設標頭並覆寫 Server 標頭。

新增相依性

若要使用 DefaultHeaders，您需要在建置指令碼中包含 ktor-server-default-headers 構件：

Gradle (Kotlin)Gradle (Groovy)Maven

安裝 DefaultHeaders

若要將 DefaultHeaders 外掛程式安裝到應用程式，請將其傳遞給指定

模組

Modules allow you to structure your application by grouping routes.

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