Ktor Client における WebSockets のシリアライズ
ContentNegotiation プラグインと同様に、WebSockets を使用するとテキストフレームを特定のフォーマットでシリアライズ/デシリアライズできます。Ktor クライアントは、標準で JSON、XML、CBOR、ProtoBuf のフォーマットをサポートしています。
依存関係の追加
kotlinx.serialization コンバーターを使用する前に、Setup セクションの説明に従って Kotlin serialization プラグインを追加する必要があります。
JSON
JSON データのシリアライズ/デシリアライズには、kotlinx.serialization、Gson、または Jackson のいずれかのライブラリを選択できます。
ビルドスクリプトに ktor-serialization-kotlinx-json アーティファクトを追加します:
implementation(ktorLibs.serialization.kotlinx.json)implementation ktorLibs.serialization.kotlinx.json<dependency>
<groupId>io.ktor</groupId>
<artifactId>ktor-serialization-kotlinx-json-jvm</artifactId>
<version>${ktor_version}</version>
</dependency>ビルドスクリプトに ktor-serialization-gson アーティファクトを追加します:
implementation(ktorLibs.serialization.gson)implementation ktorLibs.serialization.gson<dependency>
<groupId>io.ktor</groupId>
<artifactId>ktor-serialization-gson-jvm</artifactId>
<version>${ktor_version}</version>
</dependency>ビルドスクリプトに ktor-serialization-jackson アーティファクトを追加します:
implementation(ktorLibs.serialization.jackson)implementation ktorLibs.serialization.jackson<dependency>
<groupId>io.ktor</groupId>
<artifactId>ktor-serialization-jackson-jvm</artifactId>
<version>${ktor_version}</version>
</dependency>XML
XML のシリアライズ/デシリアライズを行うには、ビルドスクリプトに ktor-serialization-kotlinx-xml を追加します:
implementation(ktorLibs.serialization.kotlinx.xml)implementation ktorLibs.serialization.kotlinx.xml<dependency>
<groupId>io.ktor</groupId>
<artifactId>ktor-serialization-kotlinx-xml-jvm</artifactId>
<version>${ktor_version}</version>
</dependency>CBOR
CBOR のシリアライズ/デシリアライズを行うには、ビルドスクリプトに ktor-serialization-kotlinx-cbor を追加します:
implementation(ktorLibs.serialization.kotlinx.cbor)implementation ktorLibs.serialization.kotlinx.cbor<dependency>
<groupId>io.ktor</groupId>
<artifactId>ktor-serialization-kotlinx-cbor-jvm</artifactId>
<version>${ktor_version}</version>
</dependency>ProtoBuf
ProtoBuf のシリアライズ/デシリアライズを行うには、ビルドスクリプトに ktor-serialization-kotlinx-protobuf を追加します:
implementation(ktorLibs.serialization.kotlinx.protobuf)implementation ktorLibs.serialization.kotlinx.protobuf<dependency>
<groupId>io.ktor</groupId>
<artifactId>ktor-serialization-kotlinx-protobuf-jvm</artifactId>
<version>${ktor_version}</version>
</dependency>シリアライザーの設定
JSON シリアライザー
WebSockets の設定で JSON シリアライザーを登録するには、Json パラメーターを指定して KotlinxWebsocketSerializationConverter インスタンスを作成し、このインスタンスを contentConverter プロパティに代入します:
import io.ktor.serialization.kotlinx.*
import kotlinx.serialization.json.*
val client = HttpClient(CIO) {
install(WebSockets) {
contentConverter = KotlinxWebsocketSerializationConverter(Json)
}
}Gson シリアライザーを登録するには、GsonWebsocketContentConverter を contentConverter プロパティに代入します:
import io.ktor.serialization.gson.*
install(WebSockets) {
contentConverter = GsonWebsocketContentConverter()
}Jackson シリアライザーを登録するには、JacksonWebsocketContentConverter を contentConverter プロパティに代入します:
import io.ktor.serialization.jackson.*
install(WebSockets) {
contentConverter = JacksonWebsocketContentConverter()
}XML シリアライザー
WebSockets の設定で XML シリアライザーを登録するには、XML パラメーターを指定して KotlinxWebsocketSerializationConverter インスタンスを作成し、このインスタンスを contentConverter プロパティに代入します:
import nl.adaptivity.xmlutil.serialization.*
install(WebSockets) {
contentConverter = KotlinxWebsocketSerializationConverter(XML)
}CBOR シリアライザー
WebSockets の設定で CBOR シリアライザーを登録するには、Cbor パラメーターを指定して KotlinxWebsocketSerializationConverter インスタンスを作成し、このインスタンスを contentConverter プロパティに代入します:
import io.ktor.serialization.kotlinx.cbor.*
install(WebSockets) {
contentConverter = KotlinxWebsocketSerializationConverter(Cbor)
}ProtoBuf シリアライザー
WebSockets の設定で ProtoBuf シリアライザーを登録するには、ProtoBuf パラメーターを指定して KotlinxWebsocketSerializationConverter インスタンスを作成し、このインスタンスを contentConverter プロパティに代入します:
import io.ktor.serialization.kotlinx.protobuf.*
install(WebSockets) {
contentConverter = KotlinxWebsocketSerializationConverter(ProtoBuf)
}データの送受信
データクラスの作成
テキストフレームをオブジェクトへとシリアライズ/デシリアライズするには、データクラスを作成する必要があります。例えば次のようにします:
data class Customer(val id: Int, val firstName: String, val lastName: String)kotlinx.serialization を使用する場合は、このクラスに @Serializable アノテーションが付与されていることを確認してください:
@Serializable
data class Customer(val id: Int, val firstName: String, val lastName: String)kotlinx.serialization の詳細については、Kotlin Serialization Guide を参照してください。
データの送信
指定したフォーマットのテキストフレーム内でクラスインスタンスを送信するには、sendSerialized 関数を使用します:
client.webSocket(method = HttpMethod.Get, host = "127.0.0.1", port = 8080, path = "/customer") {
sendSerialized(Customer(1, "Jane", "Smith"))
}データの受信
テキストフレームのコンテンツを受信して変換するには、データクラスを型パラメーターとして受け取る receiveDeserialized 関数を呼び出します:
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。
