Skip to content
Client Plugin

內容編碼

必要相依性:io.ktor:ktor-client-encoding

程式碼範例: client-content-encoding

Ktor 用戶端提供了 ContentEncoding 外掛程式,可讓您啟用指定的壓縮演算法(例如 gzip 與 deflate)並設定其組態。

此外掛程式提供以下功能性:

  • 設定帶有指定品質值的 Accept-Encoding 標頭。
  • 選擇性地對請求主體進行編碼。
  • 解碼從伺服器接收的內容以獲取原始負載。

新增相依性 ​

若要使用 ContentEncoding,請將 ktor-client-encoding 構件新增至您的建置指令碼中:

kotlin
implementation(ktorLibs.client.encoding)
上述程式碼片段使用 Ktor 版本目錄 來指定 Ktor 相依性。
groovy
implementation ktorLibs.client.encoding
上述程式碼片段使用 Ktor 版本目錄 來指定 Ktor 相依性。
xml
<dependency>
    <groupId>io.ktor</groupId>
    <artifactId>ktor-client-encoding-jvm</artifactId>
    <version>${ktor_version}</version>
</dependency>
若要深入了解 Ktor 用戶端所需的構件,請參閱 新增用戶端相依性了解如何將用戶端相依性新增至現有專案中。。

安裝 ContentEncoding ​

若要安裝 ContentEncoding,請將其傳遞給用戶端配置區塊內的 install 函式:

kotlin
import io.ktor.client.*
import io.ktor.client.engine.cio.*
import io.ktor.client.plugins.compression.*
//...
val client = HttpClient(CIO) {
    install(ContentEncoding)
}

配置 ContentEncoding ​

啟用編碼器 ​

您可以配置支援哪些編碼器,並指定其品質值(用於 Accept-Encoding 標頭中)。

以下範例啟用了具有自訂品質值的 deflate 和 gzip 編碼器:

kotlin
val client = HttpClient(CIO) {
    install(ContentEncoding) {
        deflate(1.0F)
        gzip(0.9F)
    }
}

如有需要,您可以實作 ContentEncoder 介面以建立自訂編碼器,並使用 customEncoder() 函式進行註冊。

設定 mode 屬性 ​

預設情況下,ContentEncoding 僅處理回應解壓縮。您可以使用 mode 屬性來定義外掛程式的運作方式。

可用的值如下:

ContentEncodingConfig.Mode.DecompressResponse
僅解壓縮回應。此為預設模式。
ContentEncodingConfig.Mode.CompressRequest
僅啟用請求主體壓縮。
ContentEncodingConfig.Mode.All
同時啟用回應解壓縮與請求壓縮。

編碼請求主體 ​

若要啟用請求壓縮,請設定 mode 屬性,並在 HttpRequestBuilder 區塊內使用 compress() 函式:

kotlin
import io.ktor.client.*
import io.ktor.client.engine.cio.*
import io.ktor.client.plugins.compression.*
//...
val client = HttpClient(CIO) {
    install(ContentEncoding) {
        mode = ContentEncodingConfig.Mode.CompressRequest
        gzip()
    }
}
client.post("/upload") {
    compress("gzip")
    setBody(someLongBody)
}

在此範例中:

  • mode = ContentEncodingConfig.Mode.CompressRequest 啟用了請求壓縮。
  • gzip() 註冊了 gzip 編碼器。
  • compress("gzip") 對此特定請求套用 gzip 壓縮。
  • Content-Encoding 標頭會自動新增。

有關處理回應的更多詳細資訊,請參閱接收回應。