Ktor Server의 WebSockets 직렬화
ContentNegotiation 플러그인과 유사하게, WebSockets을 사용하면 텍스트 프레임을 특정 형식으로 직렬화/역직렬화(serialize/deserialize)할 수 있습니다. Ktor는 기본적으로 JSON, XML, CBOR, ProtoBuf 형식을 지원합니다.
의존성 추가
kotlinx.serialization 변환기(converter)를 사용하기 전에, 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>직렬화기(Serializer) 구성
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에서 확인할 수 있습니다.
