Skip to content
Client Plugin

BOM リムーバー

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

コード例: client-bom-remover

バイト順マーク(BOM: Byte Order Mark)は、Unicode ファイルまたはストリームでエンコードされる文字です。BOM の主な目的は、テキストのストリームエンコーディングと、16 ビットおよび 32 ビットエンコーディングのバイト順を示すことです。

場合によっては、レスポンスボディから BOM を削除する必要があります。例えば、UTF-8 エンコーディングでは BOM の存在は任意であり、BOM の処理方法に対応していないソフトウェアで読み込まれた場合に問題が発生することがあります。

Ktor クライアントは、UTF-8、UTF-16 (BE)、UTF-16 (LE)、UTF-32 (BE)、UTF-32 (LE) エンコーディングのレスポンスボディから BOM を削除する BOMRemover プラグインを提供しています。

BOM を削除する際、Ktor は Content-Length ヘッダーを変更しないため、初期レスポンスの長さが保持されることに注意してください。

依存関係の追加 ​

BOMRemover を使用するには、ビルドスクリプトに ktor-client-bom-remover アーティファクトを含める必要があります。

kotlin
implementation(ktorLibs.client.bomRemover)
上記のコードスニペットでは、 Ktor バージョンカタログを使用して Ktor の依存関係を指定しています。
groovy
implementation ktorLibs.client.bomRemover
上記のコードスニペットでは、 Ktor バージョンカタログを使用して Ktor の依存関係を指定しています。
xml
<dependency>
    <groupId>io.ktor</groupId>
    <artifactId>ktor-client-bom-remover-jvm</artifactId>
    <version>${ktor_version}</version>
</dependency>
Ktor クライアントに必要なアーティファクトの詳細については、クライアントの依存関係の追加既存のプロジェクトにクライアントの依存関係を追加する方法を学びます。を参照してください。

BOMRemover のインストール ​

BOMRemover をインストールするには、クライアント設定ブロック内の install 関数に渡します。

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