WAR
代码示例: jetty-war、 tomcat-war、 tomcat-war-ssl
你可以在 Servlet 容器(例如 Tomcat 或 Jetty)中运行 Ktor 应用程序。为此,你需要将应用程序打包为 WAR 归档,并将其部署到支持 WAR 部署的服务器或云服务中。
在本主题中,你将学习如何:
- 配置 Ktor 以在 Servlet 应用程序中使用。
- 应用 Gretty 和 War 插件来运行和打包 WAR 应用程序。
- 在 Servlet 容器中运行 Ktor 应用程序。
- 生成并部署 WAR 归档。
在 Servlet 应用程序中配置 Ktor
Ktor 允许你直接在应用程序中使用特定引擎(例如 Netty、Jetty 或 Tomcat)创建并启动服务器。在这种配置下,你的应用程序将控制引擎配置、连接和 SSL 设置。
部署到 Servlet 容器时,应用程序生命周期和连接配置由容器控制。为此,Ktor 提供了 ServletApplicationEngine 引擎,该引擎将应用程序的控制权委托给 Servlet 容器。
在 Servlet 容器中运行时,在配置文件中定义的 Ktor 连接和 SSL 设置不会生效。
有关在 Tomcat 中配置 SSL 的信息,请参阅 tomcat-war-ssl 示例。
添加依赖项
要在 Servlet 应用程序中使用 Ktor,请将 ktor-server-servlet-jakarta 构件添加到构建脚本中:
implementation(ktorLibs.server.servlet)implementation ktorLibs.server.servlet<dependency>
<groupId>io.ktor</groupId>
<artifactId>ktor-server-servlet-jakarta-jvm</artifactId>
<version>${ktor_version}</version>
</dependency>部署到 Servlet 容器时,无需单独添加 Jetty 或 Tomcat 引擎依赖项。
配置 Servlet
要在应用程序中注册 Ktor Servlet,请打开 WEB-INF/web.xml 文件,并将 ServletApplicationEngine 分配给 servlet-class 属性:
<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><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>然后,为此 Servlet 配置 URL 模式:
<servlet-mapping>
<servlet-name>KtorServlet</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>配置 Gretty 插件
Gretty 插件允许你在 Jetty 和 Tomcat 上运行 Servlet 应用程序。
首先,打开 gradle/libs.versions.toml 文件,定义 Gretty 版本及其插件别名:
[versions]
gretty = "5.0.1"
[plugins]
gretty = { id = "org.gretty", version.ref = "gretty" }在你的 build.gradle.kts 文件中,将以下条目添加到 plugins {} 代码块中:
plugins {
alias(libs.plugins.gretty)
}随后,你可以在 gretty {} 代码块中配置 Gretty:
gretty {
servletContainer = "jetty12"
contextPath = "/"
}gretty {
servletContainer = "tomcat10"
contextPath = "/"
}最后,配置 run 任务:
afterEvaluate {
tasks.getByName("run") {
dependsOn("appRun")
}
}配置 War 插件
War 插件允许你生成用于部署到 Servlet 容器的 WAR 归档。
要应用该插件,请打开你的 build.gradle.kts 文件,并将以下条目添加到 plugins {} 代码块中:
plugins {
id("war")
}运行应用程序
你可以使用 run 任务来运行带有已配置的 Gretty 插件的 Servlet 应用程序。例如,要运行 jetty-war 示例项目,请运行以下命令:
./gradlew :jetty-war:run生成并部署 WAR 归档
要使用 War 插件生成 WAR 归档,请运行 war 任务。对于 jetty-war 示例项目,命令如下所示:
./gradlew :jetty-war:war任务完成后,即可在相应模块的 build/libs 目录中找到 jetty-war.war。
要部署生成的归档,请将该文件复制到 Servlet 容器中的 jetty/webapps 目录。
以下 Dockerfile 示例展示了如何在 Jetty 或 Tomcat Servlet 容器内运行生成的 WAR 文件:
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"]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。
