Skip to content

WAR ​

Tomcat이나 Jetty와 같은 서블릿 컨테이너 내에서 Ktor 애플리케이션을 실행할 수 있습니다. 이를 위해서는 애플리케이션을 WAR 아카이브로 패키징하고 WAR 배포를 지원하는 서버나 클라우드 서비스에 배포해야 합니다.

이 문서에서는 다음 내용을 다룹니다:

서블릿 애플리케이션에서 Ktor 구성 ​

Ktor를 사용하면 애플리케이션에서 직접 특정 엔진(Netty, Jetty, Tomcat 등)을 사용하여 서버를 생성하고 시작할 수 있습니다. 이 설정에서는 애플리케이션이 엔진 구성, 연결, SSL 설정을 제어합니다.

서블릿 컨테이너에 배포할 때는 컨테이너가 애플리케이션 라이프사이클과 연결 구성을 제어합니다. 이를 위해 Ktor는 애플리케이션 제어권을 서블릿 컨테이너에 위임하는 ServletApplicationEngine 엔진을 제공합니다.

서블릿 컨테이너 내에서 실행할 때는 구성 파일에 정의된 Ktor 연결 및 SSL 설정이 적용되지 않습니다.

Tomcat에서 SSL을 구성하는 방법은 tomcat-war-ssl 예제를 참고하세요.

의존성 추가 ​

서블릿 애플리케이션에서 Ktor를 사용하려면 빌드 스크립트에 ktor-server-servlet-jakarta 아티팩트를 추가하세요:

kotlin
implementation(ktorLibs.server.servlet)
위 코드 스니펫은 Ktor 의존성을 지정하기 위해 Ktor 버전 카탈로그를 사용합니다.
groovy
implementation ktorLibs.server.servlet
위 코드 스니펫은 Ktor 의존성을 지정하기 위해 Ktor 버전 카탈로그를 사용합니다.
xml
<dependency>
    <groupId>io.ktor</groupId>
    <artifactId>ktor-server-servlet-jakarta-jvm</artifactId>
    <version>${ktor_version}</version>
</dependency>

서블릿 컨테이너에 배포할 때는 별도의 Jetty 또는 Tomcat 엔진 의존성을 추가할 필요가 없습니다.

서블릿 구성 ​

애플리케이션에 Ktor 서블릿을 등록하려면 WEB-INF/web.xml 파일을 열고 servlet-class 속성에 ServletApplicationEngine을 지정합니다:

xml
<servlet>
    <display-name>KtorServlet</display-name>
    <servlet-name>KtorServlet</servlet-name>
    <servlet-class>io.ktor.server.servlet.jakarta.ServletApplicationEngine</servlet-class>
    <init-param>
        <param-name>io.ktor.ktor.config</param-name>
        <param-value>application.conf</param-value>
    </init-param>
    <async-supported>true</async-supported>
</servlet>
xml
<servlet>
    <display-name>KtorServlet</display-name>
    <servlet-name>KtorServlet</servlet-name>
    <servlet-class>io.ktor.server.servlet.ServletApplicationEngine</servlet-class>
    <init-param>
        <param-name>io.ktor.ktor.config</param-name>
        <param-value>application.conf</param-value>
    </init-param>
    <async-supported>true</async-supported>
</servlet>

그런 다음, 이 서블릿에 대한 URL 패턴을 구성합니다:

xml
<servlet-mapping>
    <servlet-name>KtorServlet</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>

Gretty 플러그인 구성 ​

Gretty 플러그인을 사용하면 Jetty 및 Tomcat에서 서블릿 애플리케이션을 실행할 수 있습니다.

먼저, gradle/libs.versions.toml 파일을 열고 Gretty 버전과 해당 플러그인 별칭(alias)을 정의합니다:

toml
[versions]
gretty = "5.0.1"

[plugins]
gretty = { id = "org.gretty", version.ref = "gretty" }

build.gradle.kts 파일에서 plugins {} 블록에 다음 항목을 추가합니다:

groovy
plugins {
    alias(libs.plugins.gretty)
}

그런 다음 gretty {} 블록에서 Gretty를 구성할 수 있습니다:

groovy
gretty {
    servletContainer = "jetty12"
    contextPath = "/"
}
groovy
gretty {
    servletContainer = "tomcat10"
    contextPath = "/"
}

마지막으로 run 태스크를 구성합니다:

groovy
afterEvaluate {
    tasks.getByName("run") {
        dependsOn("appRun")
    }
}

War 플러그인 구성 ​

War 플러그인을 사용하면 서블릿 컨테이너에 배포할 WAR 아카이브를 생성할 수 있습니다.

플러그인을 적용하려면 build.gradle.kts 파일을 열고 plugins {} 블록에 다음 항목을 추가합니다:

groovy
plugins {
    id("war")
}

애플리케이션 실행 ​

run 태스크를 사용하여 Gretty 플러그인이 구성된 서블릿 애플리케이션을 실행할 수 있습니다. 예를 들어, jetty-war 샘플 프로젝트를 실행하려면 다음 명령을 실행합니다:

Bash
./gradlew :jetty-war:run

WAR 아카이브 생성 및 배포 ​

War 플러그인을 사용하여 WAR 아카이브를 생성하려면 war 태스크를 실행합니다. jetty-war 샘플 프로젝트의 경우 명령어는 다음과 같습니다:

Bash
./gradlew :jetty-war:war

태스크가 완료되면 해당 모듈의 build/libs 디렉터리에서 jetty-war.war 파일을 확인할 수 있습니다.

생성된 아카이브를 배포하려면 서블릿 컨테이너의 jetty/webapps 디렉터리에 파일을 복사합니다.

다음 Dockerfile 예제는 Jetty 또는 Tomcat 서블릿 컨테이너 내에서 생성된 WAR 파일을 실행하는 방법을 보여줍니다:

Docker
FROM jetty:12.0.29
EXPOSE 8080:8080
COPY ./build/libs/jetty-war.war/ /var/lib/jetty/webapps
WORKDIR /var/lib/jetty
CMD ["java","-jar","/usr/local/jetty/start.jar"]
Docker
FROM tomcat:10.1.50
EXPOSE 8080:8080
COPY ./build/libs/tomcat-war.war/ /usr/local/tomcat/webapps
WORKDIR /usr/local/tomcat
CMD ["catalina.sh", "run"]

전체 코드 예제는 jetty-war 및 tomcat-war를 참고하세요.