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 원시 소켓(raw socket)을 지원합니다. 내부적으로 java.nio를 사용하는 중단(suspending) API를 제공합니다.

소켓은 향후 업데이트에서 호환성을 깨뜨리는 변경(breaking changes)과 함께 발전할 수 있는 실험적 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 문자 한 줄을 읽을 수 있습니다:

kotlin
val name = receiveChannel.readLine()

데이터 전송 ​

클라이언트로 데이터를 전송하려면 ByteWriteChannel을 반환하는 Socket.openWriteChannel 함수를 호출합니다:

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.

데이터 수신 ​

서버로부터 데이터를 수신하려면 ByteReadChannel을 반환하는 Socket.openReadChannel 함수를 호출해야 합니다:

kotlin
val receiveChannel = socket.openReadChannel()

ByteReadChannel은 비동기 데이터 읽기를 위한 API를 제공합니다. 예를 들어, ByteReadChannel.readUTF8Line을 사용하여 UTF-8 문자 한 줄을 읽을 수 있습니다:

kotlin
val greeting = receiveChannel.readLine()

데이터 전송 ​

서버로 데이터를 전송하려면 ByteWriteChannel을 반환하는 Socket.openWriteChannel 함수를 호출합니다:

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.