Skip to content

WAR ​

Ktorアプリケーションは、TomcatやJettyなどのサーブレットコンテナ内で実行できます。これを行うには、アプリケーションを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のバージョンとそのプラグインエイリアスを定義します。

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")
}

アプリケーションの実行 ​

設定したGrettyプラグインを使用して、run タスクでサーブレットアプリケーションを実行できます。例えば、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 を参照してください。