Skip to content

Ktor Client 中的 WebSockets 序列化

ContentNegotiation 外掛程式類似,WebSockets 允許您以特定格式序列化/反序列化文字框架。Ktor 客戶端開箱即用支援以下格式:JSON、XML、CBOR 和 ProtoBuf。

新增相依性

在使用 kotlinx.serialization 轉換器之前,您需要按照 Setup 章節中的說明新增 Kotlin 序列化外掛程式。

JSON

要序列化/反序列化 JSON 資料,您可以選擇以下任一程式庫:kotlinx.serializationGsonJackson

在組建指令碼中新增 ktor-serialization-kotlinx-json 構件:

Kotlin
Groovy
XML

在組建指令碼中新增 ktor-serialization-gson 構件:

Kotlin
Groovy
XML

在組建指令碼中新增 ktor-serialization-jackson 構件:

Kotlin
Groovy
XML

XML

要序列化/反序列化 XML,請在組建指令碼中新增 ktor-serialization-kotlinx-xml

Kotlin
Groovy
XML

請注意,jsNode 目標不支援 XML 序列化

CBOR

要序列化/反序列化 CBOR,請在組建指令碼中新增 ktor-serialization-kotlinx-cbor

Kotlin
Groovy
XML

ProtoBuf

要序列化/反序列化 ProtoBuf,請在組建指令碼中新增 ktor-serialization-kotlinx-protobuf

Kotlin
Groovy
XML

配置序列化程式

JSON 序列化程式

要於 WebSockets 配置中註冊 JSON 序列化程式,請建立一個帶有 Json 參數的 KotlinxWebsocketSerializationConverter 執行個體,並將此執行個體指派給 contentConverter 屬性:

kotlin
import io.ktor.serialization.kotlinx.*
import kotlinx.serialization.json.*

val client = HttpClient(CIO) {
    install(WebSockets) {
        contentConverter = KotlinxWebsocketSerializationConverter(Json)
    }
}

要註冊 Gson 序列化程式,請將 GsonWebsocketContentConverter 指派給 contentConverter 屬性:

kotlin
import io.ktor.serialization.gson.*

install(WebSockets) {
    contentConverter = GsonWebsocketContentConverter()
}

要註冊 Jackson 序列化程式,請將 JacksonWebsocketContentConverter 指派給 contentConverter 屬性:

kotlin
import io.ktor.serialization.jackson.*

install(WebSockets) {
    contentConverter = JacksonWebsocketContentConverter()
}

XML 序列化程式

要於 WebSockets 配置中註冊 XML 序列化程式,請建立一個帶有 XML 參數的 KotlinxWebsocketSerializationConverter 執行個體,並將此執行個體指派給 contentConverter 屬性:

kotlin
import nl.adaptivity.xmlutil.serialization.*

install(WebSockets) {
    contentConverter = KotlinxWebsocketSerializationConverter(XML)
}

CBOR 序列化程式

要於 WebSockets 配置中註冊 CBOR 序列化程式,請建立一個帶有 Cbor 參數的 KotlinxWebsocketSerializationConverter 執行個體,並將此執行個體指派給 contentConverter 屬性:

kotlin
import io.ktor.serialization.kotlinx.cbor.*

install(WebSockets) {
    contentConverter = KotlinxWebsocketSerializationConverter(Cbor)
}

ProtoBuf 序列化程式

要於 WebSockets 配置中註冊 ProtoBuf 序列化程式,請建立一個帶有 ProtoBuf 參數的 KotlinxWebsocketSerializationConverter 執行個體,並將此執行個體指派給 contentConverter 屬性:

kotlin
import io.ktor.serialization.kotlinx.protobuf.*

install(WebSockets) {
    contentConverter = KotlinxWebsocketSerializationConverter(ProtoBuf)
}

接收與傳送資料

建立資料類別

要將文字框架序列化/反序列化為物件,您需要建立一個資料類別,例如:

kotlin
data class Customer(val id: Int, val firstName: String, val lastName: String)

如果您使用 kotlinx.serialization,請確保該類別具有 @Serializable 註解:

kotlin
@Serializable
data class Customer(val id: Int, val firstName: String, val lastName: String)

若要進一步了解 kotlinx.serialization,請參閱 Kotlin 序列化指南

傳送資料

要以指定格式在文字框架中傳送類別執行個體,請使用 sendSerialized 函式:

kotlin
client.webSocket(method = HttpMethod.Get, host = "127.0.0.1", port = 8080, path = "/customer") {
    sendSerialized(Customer(1, "Jane", "Smith"))
}

接收資料

要接收並轉換文字框架的內容,請呼叫接受資料類別作為參數的 receiveDeserialized 函式:

kotlin
client.webSocket(method = HttpMethod.Get, host = "127.0.0.1", port = 8080, path = "/customer/1") {
    val customer = receiveDeserialized<Customer>()
    println("A customer with id ${customer.id} is received by the client.")
}

若要從 incoming 通道接收反序列化後的框架,請使用 WebsocketContentConverter.deserialize 函式。WebsocketContentConverter 可透過 DefaultClientWebSocketSession.converter 屬性取得。

您可以在此處找到完整的範例:client-websockets-serialization