Skip to content
Client Plugin

コンテンツエンコーディング

必要な依存関係: io.ktor:ktor-client-encoding

コード例: client-content-encoding

Ktor クライアントは、指定した圧縮アルゴリズム(gzip や deflate など)を有効にしてそれらの設定を行える ContentEncoding プラグインを提供しています。

このプラグインは以下の機能を提供します:

  • 指定された品質値を持つ 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 はレスポンスの解凍(decompression)のみを処理します。プラグインの動作方法を定義するには、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 ヘッダーは自動的に追加されます。

レスポンスの処理に関する詳細については、レスポンスの受信を参照してください。