Skip to content
Client Plugin

BOM 移除工具

必要相依性:io.ktor:ktor-client-bom-remover

程式碼範例: client-bom-remover

位元組順序記號 (BOM) 是一個編碼在 Unicode 檔案或資料流中的字元。BOM 的主要目的是標示文字資料流的編碼,以及 16 位元和 32 位元編碼的位元組順序。

在某些情況下,有必要從回應本文中移除 BOM。例如,在 UTF-8 編碼中,BOM 的存在是可選的,當遇到不知道如何處理 BOM 的軟體讀取時,可能會導致問題。

Ktor 用戶端提供了 BOMRemover 外掛程式,可從採用 UTF-8、UTF-16 (BE)、UTF-16 (LE)、UTF-32 (BE) 和 UTF-32 (LE) 編碼的回應本文中移除 BOM。

請注意,移除 BOM 時,Ktor 不會變更 Content-Length 標頭,該標頭會保留初始回應的長度。

新增相依性 ​

若要使用 BOMRemover,您需要在建置指令碼中包含 ktor-client-bom-remover 構件:

kotlin
implementation(ktorLibs.client.bomRemover)
上述程式碼片段使用 Ktor version catalog 來指定 Ktor 相依性。
groovy
implementation ktorLibs.client.bomRemover
上述程式碼片段使用 Ktor version catalog 來指定 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)
}