서버 엔진

Ktor 서버 애플리케이션을 실행하려면 먼저 서버를 생성하고 설정해야 합니다. 서버 설정에는 다음과 같은 다양한 설정이 포함됩니다:

• 네트워크 요청 처리를 위한 엔진.
• 서버 접속에 사용되는 호스트와 포트 값.
• SSL 설정.

지원되는 플랫폼

아래 표는 각 엔진에서 지원하는 플랫폼을 나열합니다:

엔진	플랫폼	HTTP/2
Netty	JVM	✅
Jetty	JVM	✅
Tomcat	JVM	✅
CIO (코루틴 기반 I/O)	JVM, Native, GraalVM, JavaScript, WasmJs	✖️
ServletApplicationEngine	JVM	✅

의존성 추가

원하는 엔진을 사용하기 전에, 빌드 스크립트에 해당 의존성을 추가해야 합니다:

• ktor-server-netty
• ktor-server-jetty-jakarta
• ktor-server-tomcat-jakarta
• ktor-server-cio

아래는 Netty에 대한 의존성을 추가하는 예시입니다:

Gradle (Kotlin)Gradle (Groovy)Maven

서버 생성 방법 선택

Ktor 서버 애플리케이션은 두 가지 방법으로 생성 및 실행할 수 있습니다:

• embeddedServer를 사용하여 코드 내에서 서버 파라미터를 신속하게 전달하는 방법
• EngineMain을 사용하여 외부 application.conf 또는 application.yaml 파일에서 설정을 로드하는 방법

embeddedServer

embeddedServer() 함수는 특정 타입의 엔진을 생성하는 데 사용되는 엔진 팩토리를 인자로 받습니다. 아래 예시에서는 Netty 팩토리를 전달하여 Netty 엔진으로 서버를 실행하고 8080 포트에서 리스닝합니다:

import io.ktor.server.response.*
import io.ktor.server.routing.*
import io.ktor.server.engine.*
import io.ktor.server.netty.*

fun main(args: Array<String>) {
    embeddedServer(Netty, port = 8080) {
        routing {
            get("/") {
                call.respondText("Hello, world!")
            }
        }
    }.start(wait = true)
}

EngineMain

EngineMain은 서버 실행을 위한 엔진을 나타냅니다. 다음 엔진들을 사용할 수 있습니다:

• io.ktor.server.netty.EngineMain
• io.ktor.server.jetty.jakarta.EngineMain
• io.ktor.server.tomcat.jakarta.EngineMain
• io.ktor.server.cio.EngineMain

서버 생성 및 시작

EngineMain.main() 함수는 선택한 엔진으로 서버를 시작하고 외부 설정 파일에 지정된 애플리케이션 모듈을 로드하는 데 사용됩니다. 아래 예시에서 애플리케이션의 main 함수는 서버를 시작합니다:

Application.ktapplication.confapplication.yaml

package com.example

import io.ktor.server.application.*
import io.ktor.server.response.*
import io.ktor.server.routing.*

fun main(args: Array<String>): Unit = io.ktor.server.netty.EngineMain.main(args)

fun Application.module() {
    routing {
        get("/") {
            call.respondText("Hello, world!")
        }
    }
}

ktor {
    deployment {
        port = 8080
    }
    application {
        modules = [ com.example.ApplicationKt.module ]
    }
}

ktor:
    deployment:
        port: 8080
    application:
        modules:
            - com.example.ApplicationKt.module

빌드 시스템 태스크를 사용하여 서버를 시작해야 하는 경우, 필요한 EngineMain을 메인 클래스로 설정해야 합니다:

Gradle (Kotlin)Gradle (Groovy)Maven

application {
    mainClass.set("io.ktor.server.netty.EngineMain")
}

mainClassName = "io.ktor.server.netty.EngineMain"

<properties>
    <main.class>io.ktor.server.netty.EngineMain</main.class>
</properties>

시작하지 않고 서버 인스턴스 생성하기

EngineMain.main()을 직접 호출하여 서버를 즉시 시작하는 것 외에도, 서버를 시작하지 않고 EmbeddedServer 인스턴스를 반환하는 EngineMain.createServer()를 대신 호출할 수 있습니다.

이 방식은 요청을 수락하기 전에 .start(), .stop()을 호출하거나 서버에서 추가적인 작업을 수행하는 시점을 제어할 수 있게 해줍니다.

// Netty를 사용하는 예시
val server = io.ktor.server.netty.EngineMain.createServer(args)
// 추가 초기화, 로깅, 계측(instrumentation) 등을 수행합니다.
server.start(wait = true)

엔진 설정

이 섹션에서는 다양한 엔진별 옵션을 지정하는 방법을 살펴봅니다.

코드에서 설정

embeddedServer 함수를 사용하면 configure 파라미터를 통해 엔진별 옵션을 전달할 수 있습니다. 이 파라미터에는 모든 엔진에 공통적인 옵션이 포함되어 있으며, ApplicationEngine.Configuration 클래스에 의해 노출됩니다.

아래 예시는 Netty 엔진을 사용하여 서버를 설정하는 방법을 보여줍니다. configure 블록 내에서 호스트와 포트를 지정하기 위해 connector를 정의하고 다양한 서버 파라미터를 커스터마이징합니다:

connectors.add() 메서드는 지정된 호스트(127.0.0.1) 및 포트(8080)로 커넥터를 정의합니다.

이러한 옵션 외에도 다른 엔진별 속성을 설정할 수 있습니다.

Netty

Netty 전용 옵션은 NettyApplicationEngine.Configuration 클래스에 의해 노출됩니다.

Jetty

Jetty 전용 옵션은 JettyApplicationEngineBase.Configuration 클래스에 의해 노출됩니다.

Jetty 서버는 configureServer 블록 내부에서 설정할 수 있으며, 이 블록은 Server 인스턴스에 대한 접근을 제공합니다.

idleTimeout 속성을 사용하여 연결이 닫히기 전까지 유휴 상태로 있을 수 있는 시간을 지정합니다.

CIO

CIO 전용 옵션은 CIOApplicationEngine.Configuration 클래스에 의해 노출됩니다.

Tomcat

Tomcat을 엔진으로 사용하는 경우, configureTomcat 속성을 사용하여 설정할 수 있으며, 이 속성은 Tomcat 인스턴스에 대한 접근을 제공합니다.

설정 파일에서 설정

EngineMain을 사용하는 경우, ktor.deployment 그룹 내에서 모든 엔진에 공통적인 옵션을 지정할 수 있습니다.

application.confapplication.yaml

Netty

설정 파일의 ktor.deployment 그룹 내에서 Netty 전용 옵션을 설정할 수도 있습니다:

application.confapplication.yaml