Ktor ServerにおけるWebSocketsシリアライゼーション
ContentNegotiationプラグインと同様に、WebSocketsでは特定のフォーマットでテキストフレームをシリアライズ/デシリアライズできます。Ktorは初期状態で、JSON、XML、CBOR、ProtoBufのフォーマットをサポートしています。
依存関係の追加
kotlinx.serializationコンバーターを使用する前に、Setupセクションの説明に従ってKotlinシリアライゼーションプラグインを追加する必要があります。
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.*
install(WebSockets) {
contentConverter = KotlinxWebsocketSerializationConverter(Json)
}Gsonシリアライザーを登録するには、contentConverter プロパティに GsonWebsocketContentConverter を割り当てます:
import io.ktor.serialization.gson.*
install(WebSockets) {
contentConverter = GsonWebsocketContentConverter()
}Jacksonシリアライザーを登録するには、contentConverter プロパティに JacksonWebsocketContentConverter を割り当てます:
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 kotlinx.serialization.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)データの受信
テキストフレームのコンテンツを受信して変換するには、データクラスをパラメータとして受け取る receiveDeserialized 関数を呼び出します:
webSocket("/customer") {
val customer = receiveDeserialized<Customer>()
println("A customer with id ${customer.id} is received by the server.")
}デシリアライズされたフレームをincomingチャネルから受信するには、WebsocketContentConverter.deserialize 関数を使用します。WebsocketContentConverter は WebSocketServerSession.converter プロパティを介して利用できます。
データの送信
指定したフォーマットを使用してテキストフレームでデータオブジェクトを送信するには、sendSerialized 関数を使用できます:
webSocket("/customer/1") {
sendSerialized(Customer(1, "Jane", "Smith"))
}完全なサンプルはこちらで確認できます: server-websockets-serialization。
