Ktor ClientのWebSockets
必要な依存関係: io.ktor:ktor-client-websockets
コード例: client-websockets
クライアント用のWebsocketsプラグインを使用すると、サーバーとメッセージをやり取りするためのWebSocketセッションを処理できます。
すべてのエンジンがWebSocketsをサポートしているわけではありません。サポートされているエンジンの概要については、制限事項を参照してください。
サーバー側でのWebSocketサポートについては、Ktor ServerのWebSocketsWebsockets プラグインを使用すると、サーバーとクライアント間で双方向の通信セッションを作成できます。を参照してください。
依存関係の追加
WebSocketsを使用するには、ビルドスクリプトにktor-client-websocketsアーティファクトを含める必要があります。
implementation(ktorLibs.client.websockets)implementation ktorLibs.client.websockets<dependency>
<groupId>io.ktor</groupId>
<artifactId>ktor-client-websockets-jvm</artifactId>
<version>${ktor_version}</version>
</dependency>WebSocketsのインストール
WebSocketsプラグインをインストールするには、クライアント構成ブロック内でinstall関数に渡します。
import io.ktor.client.*
import io.ktor.client.engine.cio.*
import io.ktor.client.plugins.websocket.*
//...
val client = HttpClient(CIO) {
install(WebSockets)
}設定
必要に応じて、WebSockets.Configでサポートされているプロパティを渡すことで、installブロック内でプラグインを設定できます。
maxFrameSizeFrameサイズを設定します。 contentConverterpingIntervalMillisLong形式で指定します。 pingIntervalDuration形式で指定します。 pingIntervalプロパティおよびpingIntervalMillisプロパティはOkHttpエンジンには適用されません。OkHttpのping間隔を設定するには、エンジン設定を使用できます。
import io.ktor.client.engine.okhttp.OkHttp
val client = HttpClient(OkHttp) {
engine {
preconfigured = OkHttpClient.Builder()
.pingInterval(20, TimeUnit.SECONDS)
.build()
}
} 次の例では、Pingフレームを自動的に送信してWebSocket接続を維持するために、WebSocketsプラグインが20秒(20_000ミリ秒)のPing間隔で設定されています。
val client = HttpClient(CIO) {
install(WebSockets) {
pingIntervalMillis = 20_000
}
}WebSocketセッションの操作
クライアントのWebSocketセッションは、DefaultClientWebSocketSessionインターフェースによって表されます。このインターフェースは、WebSocketフレームの送受信やセッションのクローズを行うためのAPIを提供します。
WebSocketセッションへのアクセス
HttpClientは、WebSocketセッションにアクセスするための主に2つの方法を提供します。
webSocket()関数は、ブロック引数として
DefaultClientWebSocketSessionを受け取ります。kotlinrunBlocking { client.webSocket( method = HttpMethod.Get, host = "127.0.0.1", port = 8080, path = "/echo" ) { // this: DefaultClientWebSocketSession } }- webSocketSession()関数は
DefaultClientWebSocketSessionインスタンスを返し、runBlockingやlaunchスコープの外部からセッションにアクセスできるようにします。
WebSocketセッションの処理
関数ブロック内で、指定されたパスのハンドラーを定義します。ブロック内では、次の関数やプロパティを使用できます。
send()send()関数を使用します。 outgoingoutgoingプロパティを使用します。フレームはFrameクラスで表されます。 incomingincomingプロパティを使用します。フレームはFrameクラスで表されます。 close()close()関数を使用します。 フレームタイプ
WebSocketフレームのタイプを検査し、それに応じて処理することができます。一般的なフレームタイプには次のようなものがあります。
Frame.Textはテキストフレームを表します。その内容を読み取るにはFrame.Text.readText()を使用します。Frame.Binaryはバイナリフレームを表します。その内容を読み取るにはFrame.Binary.readBytes()を使用します。Frame.Closeはクローズフレームを表します。セッション終了の理由を取得するにはFrame.Close.readReason()を使用します。
例
以下の例では、echo WebSocketエンドポイントを作成し、サーバーとの間でメッセージを送受信する方法を示します。
package com.example
import io.ktor.client.*
import io.ktor.client.engine.cio.*
import io.ktor.client.plugins.websocket.*
import io.ktor.http.*
import io.ktor.websocket.*
import kotlinx.coroutines.*
import java.util.*
fun main() {
val client = HttpClient(CIO) {
install(WebSockets) {
pingIntervalMillis = 20_000
}
}
runBlocking {
client.webSocket(method = HttpMethod.Get, host = "127.0.0.1", port = 8080, path = "/echo") {
while(true) {
val othersMessage = incoming.receive() as? Frame.Text
println(othersMessage?.readText())
val myMessage = Scanner(System.`in`).next()
if(myMessage != null) {
send(myMessage)
}
}
}
}
client.close()
}完全な例については、client-websocketsを参照してください。
