Skip to content
Server Plugin

套接字

必需依赖项:io.ktor:ktor-network、io.ktor:ktor-network-tls

代码示例: sockets-server、 sockets-client、 sockets-client-tls

原生服务器Ktor 支持 Kotlin/Native,并允许您在无需额外运行时或虚拟机的情况下运行服务器。支持:✅

除了为服务器和客户端提供 HTTP/WebSocket 处理之外,Ktor 还支持 TCP 和 UDP 原始套接字。 它提供了一套在底层使用 java.nio 的挂起 API。

套接字使用的是实验性 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)

上面的代码段创建了一个 TCP 套接字,它是 ServerSocket 实例。 要创建 UDP 套接字,请使用 SocketBuilder.udp()。

接受传入连接 ​

创建服务器套接字后,需要调用 ServerSocket.accept 函数来接受套接字连接, 并返回已连接的套接字(即 Socket 实例):

kotlin
val socket = serverSocket.accept()

拥有已连接的套接字后,您可以通过对该套接字执行读写操作来接收/发送数据。

接收数据 ​

要接收来自客户端的数据,需要调用 Socket.openReadChannel 函数,它会返回 ByteReadChannel:

kotlin
val receiveChannel = socket.openReadChannel()

ByteReadChannel 提供了用于异步读取数据的 API。 例如,您可以使用 ByteReadChannel.readUTF8Line 读取一行 UTF-8 字符:

kotlin
val name = receiveChannel.readLine()

发送数据 ​

要向客户端发送数据,请调用 Socket.openWriteChannel 函数,它会返回 ByteWriteChannel:

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

ByteWriteChannel 提供了用于异步写入字节序列的 API。 例如,您可以使用 ByteWriteChannel.writeStringUtf8 写入一行 UTF-8 字符:

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。

接收数据 ​

要接收来自服务器的数据,需要调用 Socket.openReadChannel 函数,它会返回 ByteReadChannel:

kotlin
val receiveChannel = socket.openReadChannel()

ByteReadChannel 提供了用于异步读取数据的 API。 例如,您可以使用 ByteReadChannel.readUTF8Line 读取一行 UTF-8 字符:

kotlin
val greeting = receiveChannel.readLine()

发送数据 ​

要向服务器发送数据,请调用 Socket.openWriteChannel 函数,它会返回 ByteWriteChannel:

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

ByteWriteChannel 提供了用于异步写入字节序列的 API。 例如,您可以使用 ByteWriteChannel.writeStringUtf8 写入一行 UTF-8 字符:

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。