Skip to content
Server Plugin

ソケット

必要な依存関係: io.ktor:ktor-network, io.ktor:ktor-network-tls

コード例: sockets-server, sockets-client, sockets-client-tls

ネイティブサーバーKtorはKotlin/Nativeをサポートしており、追加のランタイムや仮想マシンなしでサーバーを実行できます。のサポート: ✅

Ktorは、サーバーおよびクライアント向けのHTTP/WebSocket処理に加えて、TCPおよびUDPのrawソケットもサポートしています。 内部でjava.nioを使用するサスペンドAPIを公開しています。

ソケットは実験的(experimental)なAPIを使用しており、今後のアップデートで破壊的変更を伴いながら進化する可能性があります。

依存関係の追加 ​

Sockets を使用するには、ビルドスクリプトに ktor-network アーティファクトを追加します:

kotlin
implementation(ktorLibs.network)
上記のコードスニペットでは、Ktorの依存関係を指定するために Ktor バージョンカタログ を使用しています。
groovy
implementation ktorLibs.network
上記のコードスニペットでは、Ktorの依存関係を指定するために Ktor バージョンカタログ を使用しています。
xml
<dependency>
    <groupId>io.ktor</groupId>
    <artifactId>ktor-network-jvm</artifactId>
    <version>${ktor_version}</version>
</dependency>

クライアントでセキュアソケットを使用するには、io.ktor:ktor-network-tls も追加する必要があります。

サーバー ​

サーバーソケットの作成 ​

サーバーソケットを構築するには、SelectorManager のインスタンスを作成し、それに対して SocketBuilder.tcp() 関数を呼び出し、bind を使用して特定のポートにサーバーソケットをバインドします:

kotlin
val selectorManager = SelectorManager(Dispatchers.IO)
val serverSocket = aSocket(selectorManager).tcp().bind("127.0.0.1", 9002)

上記のスニペットは、ServerSocket のインスタンスであるTCPソケットを作成します。 UDPソケットを作成するには、SocketBuilder.udp() を使用します。

着信接続の受け入れ ​

サーバーソケットを作成したら、ソケット接続を受け入れて接続済みソケット(Socket インスタンス)を返す ServerSocket.accept 関数を呼び出す必要があります:

kotlin
val socket = serverSocket.accept()

接続済みソケットを取得すると、ソケットからの読み取りまたはソケットへの書き込みによってデータを送受信できるようになります。

データの受信 ​

クライアントからデータを受信するには、ByteReadChannel を返す Socket.openReadChannel 関数を呼び出す必要があります:

kotlin
val receiveChannel = socket.openReadChannel()

ByteReadChannel はデータを非同期に読み取るためのAPIを提供します。 たとえば、ByteReadChannel.readUTF8Line を使用してUTF-8文字列の1行を読み取ることができます:

kotlin
val name = receiveChannel.readLine()

データの送信 ​

クライアントにデータを送信するには、ByteWriteChannel を返す Socket.openWriteChannel 関数を呼び出します:

kotlin
val sendChannel = socket.openWriteChannel(autoFlush = true)

ByteWriteChannel はバイトシーケンスを非同期に書き込むためのAPIを提供します。 たとえば、ByteWriteChannel.writeStringUtf8 を使用してUTF-8文字列の1行を書き込むことができます:

kotlin
val name = receiveChannel.readLine()
sendChannel.writeStringUtf8("Hello, $name!\n")

ソケットのクローズ ​

接続済みソケットに関連付けられたリソースを解放するには、Socket.close を呼び出します:

kotlin
socket.close()

例 ​

以下のコードサンプルは、サーバー側でソケットを使用する方法を示しています:

kotlin
package com.example

import io.ktor.network.selector.*
import io.ktor.network.sockets.*
import io.ktor.utils.io.*
import kotlinx.coroutines.*

fun main(args: Array<String>) {
    runBlocking {
        val selectorManager = SelectorManager(Dispatchers.IO)
        val serverSocket = aSocket(selectorManager).tcp().bind("127.0.0.1", 9002)
        println("Server is listening at ${serverSocket.localAddress}")
        while (true) {
            val socket = serverSocket.accept()
            println("Accepted ${socket.remoteAddress}")
            launch {
                val receiveChannel = socket.openReadChannel()
                val sendChannel = socket.openWriteChannel(autoFlush = true)
                sendChannel.writeStringUtf8("Please enter your name\n")
                try {
                    while (true) {
                        val name = receiveChannel.readLine()
                        sendChannel.writeStringUtf8("Hello, $name!\n")
                    }
                } catch (e: Throwable) {
                    socket.close()
                }
            }
        }
    }
}

完全なサンプルはこちらで確認できます: sockets-server。

クライアント ​

ソケットの作成 ​

クライアントソケットを構築するには、SelectorManager のインスタンスを作成し、それに対して SocketBuilder.tcp() 関数を呼び出し、connect を使用して接続を確立して接続済みソケット(Socket インスタンス)を取得します:

kotlin
val selectorManager = SelectorManager(Dispatchers.IO)
val socket = aSocket(selectorManager).tcp().connect("127.0.0.1", 9002)

接続済みソケットを取得すると、ソケットからの読み取りまたはソケットへの書き込みによってデータを送受信できるようになります。

セキュアソケットの作成 (SSL/TLS) ​

セキュアソケットを使用すると、TLS接続を確立できます。 セキュアソケットを使用するには、ktor-network-tls の依存関係を追加する必要があります。 その後、接続済みソケットに対して Socket.tls 関数を呼び出します:

kotlin
val selectorManager = SelectorManager(Dispatchers.IO)
val socket = aSocket(selectorManager).tcp().connect("127.0.0.1", 8443).tls()

tls 関数を使用すると、TLSConfigBuilder で提供されるTLSパラメーターを調整できます:

kotlin
val selectorManager = SelectorManager(Dispatchers.IO)
val socket = aSocket(selectorManager).tcp().connect("youtrack.jetbrains.com", port = 443).tls(coroutineContext = coroutineContext) {
    trustManager = object : X509TrustManager {
        override fun getAcceptedIssuers(): Array<X509Certificate?> = arrayOf()
        override fun checkClientTrusted(certs: Array<X509Certificate?>?, authType: String?) {}
        override fun checkServerTrusted(certs: Array<X509Certificate?>?, authType: String?) {}
    }
}

完全なサンプルはこちらで確認できます: sockets-client-tls。

データの受信 ​

サーバーからデータを受信するには、ByteReadChannel を返す Socket.openReadChannel 関数を呼び出す必要があります:

kotlin
val receiveChannel = socket.openReadChannel()

ByteReadChannel はデータを非同期に読み取るためのAPIを提供します。 たとえば、ByteReadChannel.readUTF8Line を使用してUTF-8文字列の1行を読み取ることができます:

kotlin
val greeting = receiveChannel.readLine()

データの送信 ​

サーバーにデータを送信するには、ByteWriteChannel を返す Socket.openWriteChannel 関数を呼び出します:

kotlin
val sendChannel = socket.openWriteChannel(autoFlush = true)

ByteWriteChannel はバイトシーケンスを非同期に書き込むためのAPIを提供します。 たとえば、ByteWriteChannel.writeStringUtf8 を使用してUTF-8文字列の1行を書き込むことができます:

kotlin
val myMessage = readln()
sendChannel.writeStringUtf8("$myMessage\n")

接続のクローズ ​

接続済みソケットに関連付けられたリソースを解放するには、Socket.close と SelectorManager.close を呼び出します:

kotlin
socket.close()
selectorManager.close()

例 ​

以下のコードサンプルは、クライアント側でソケットを使用する方法を示しています:

kotlin
package com.example

import io.ktor.network.selector.*
import io.ktor.network.sockets.*
import io.ktor.utils.io.*
import kotlinx.coroutines.*
import kotlin.system.*

fun main(args: Array<String>) {
    runBlocking {
        val selectorManager = SelectorManager(Dispatchers.IO)
        val socket = aSocket(selectorManager).tcp().connect("127.0.0.1", 9002)

        val receiveChannel = socket.openReadChannel()
        val sendChannel = socket.openWriteChannel(autoFlush = true)

        launch(Dispatchers.IO) {
            while (true) {
                val greeting = receiveChannel.readLine()
                if (greeting != null) {
                    println(greeting)
                } else {
                    println("Server closed a connection")
                    socket.close()
                    selectorManager.close()
                    exitProcess(0)
                }
            }
        }

        while (true) {
            val myMessage = readln()
            sendChannel.writeStringUtf8("$myMessage\n")
        }
    }
}

完全なサンプルはこちらで確認できます: sockets-client。