Docker Compose
在本主题中,我们将向你展示如何在 Docker Compose 下运行服务端 Ktor 应用程序。我们将使用在 集成数据库了解使用 Exposed SQL 库将 Ktor 服务连接到数据库仓库的过程。 教程中创建的项目,该项目使用 Exposed 连接到 PostgreSQL 数据库,其中数据库和 Web 应用程序分别独立运行。
准备应用程序
提取数据库设置
在 集成数据库 教程中创建的项目使用硬编码的属性来建立数据库连接。
让我们将 PostgreSQL 数据库的连接设置提取到一个 自定义配置组了解如何在配置文件中配置各种服务器参数。 中。
打开 src/main/resources 中的 application.yaml 文件,并在
ktor组之外添加storage组,如下所示:yamlktor: application: modules: - com.example.ApplicationKt.module deployment: port: 8080 storage: driverClassName: "org.postgresql.Driver" jdbcURL: "jdbc:postgresql://localhost:5432/ktor_tutorial_db" user: "postgres" password: "password"这些设置稍后将在 compose.yml 文件中进行配置。
打开 src/main/kotlin/com/example/plugins/ 中的 Databases.kt 文件,并更新
configureDatabases()函数以从配置文件加载存储设置:kotlinfun Application.configureDatabases(config: ApplicationConfig) { val url = config.property("storage.jdbcURL").getString() val user = config.property("storage.user").getString() val password = config.property("storage.password").getString() Database.connect( url, user = user, password = password ) }configureDatabases()函数现在接受ApplicationConfig并使用config.property加载自定义设置。打开 src/main/kotlin/com/example/ 中的 Application.kt 文件,并将
environment.config传递给configureDatabases(),以便在应用程序启动时加载连接设置:kotlinfun Application.module() { val repository = PostgresTaskRepository() configureSerialization(repository) configureDatabases(environment.config) configureRouting() }
配置 Ktor 插件
为了在 Docker 上运行,应用程序需要将所有必需的文件部署到容器中。根据你使用的构建系统, 可以使用不同的插件来实现此目的:
- 使用 Ktor Gradle 插件创建 fat JAR了解如何使用 Ktor Gradle 插件创建并运行可执行的 fat JAR。
- 使用 Maven Assembly 插件创建 fat JAR示例项目:tutorial-server-get-started-maven
在我们的示例中,Ktor 插件已在 build.gradle.kts 文件中应用。
plugins {
application
alias(libs.plugins.kotlin.jvm)
alias(ktorLibs.plugins.ktor)
alias(libs.plugins.kotlin.serialization)
}配置 Docker
准备 Docker 镜像
要将应用程序容器化,请在项目的根目录下创建一个新的 Dockerfile 并插入以下内容:
# Stage 1: Cache Gradle dependencies
FROM gradle:latest AS cache
RUN mkdir -p /home/gradle/cache_home
ENV GRADLE_USER_HOME=/home/gradle/cache_home
COPY build.gradle.* gradle.properties /home/gradle/app/
COPY gradle /home/gradle/app/gradle
WORKDIR /home/gradle/app
RUN gradle dependencies --no-daemon
# Stage 2: Build Application
FROM gradle:latest AS build
COPY --from=cache /home/gradle/cache_home /home/gradle/.gradle
COPY --chown=gradle:gradle . /home/gradle/src
WORKDIR /home/gradle/src
# Build the fat JAR, Gradle also supports shadow
# and boot JAR by default.
RUN gradle buildFatJar --no-daemon
# Stage 3: Create the Runtime Image
FROM amazoncorretto:22 AS runtime
EXPOSE 8080
RUN mkdir /app
COPY --from=build /home/gradle/src/build/libs/*.jar /app/ktor-docker-sample.jar
ENTRYPOINT ["java","-jar","/app/ktor-docker-sample.jar"]本示例使用的是 Amazon Corretto Docker 镜像,但你也可以将其替换为任何其他合适的替代方案,例如:
配置 Docker Compose
在项目的根目录下,创建一个新的 compose.yml 文件并添加以下内容:
services:
web:
build: .
ports:
- "8080:8080"
depends_on:
db:
condition: service_healthy
db:
image: postgres
volumes:
- ./tmp/db:/var/lib/postgresql/data
environment:
POSTGRES_DB: ktor_tutorial_db
POSTGRES_HOST_AUTH_METHOD: trust
ports:
- "5432:5432"
healthcheck:
test: [ "CMD-SHELL", "pg_isready -U postgres" ]
interval: 1sweb服务用于运行打包在镜像内的 Ktor 应用程序。db服务使用postgres镜像来创建用于存储任务的ktor_tutorial_db数据库。
构建并运行服务
运行以下命令以创建包含你的 Ktor 应用程序的 fat JAR:
bash./gradlew :tutorial-server-docker-compose:buildFatJar使用
docker compose up命令构建镜像并启动容器:bashdocker compose --project-directory snippets/tutorial-server-docker-compose up- 等待 Docker Compose 完成镜像构建。
导航至 http://localhost:8080/static/index.html 以打开 Web 应用程序。你应该会看到任务管理器客户端页面,其中显示用于筛选和添加新任务的三个表单,以及一个任务表格。

