Skip to content

Docker Compose

在本主題中,我們將向您展示如何在 Docker Compose 下執行伺服器端 Ktor 應用程式。我們將使用在整合資料庫了解使用 Exposed SQL 程式庫將 Ktor 服務連接到資料庫存儲庫的過程。教學中建立的專案,該專案使用 Exposed 連接到 PostgreSQL 資料庫,其中資料庫與 Web 應用程式分開執行。

準備好應用程式

擷取資料庫設定

在整合資料庫教學中建立的專案使用硬編碼屬性來建立資料庫連線。

讓我們將 PostgreSQL 資料庫的連線設定擷取到自訂配置群組了解如何在組態檔案中配置各種伺服器參數。中。

  1. 開啟 src/main/resources 中的 application.yaml 檔案,並在 ktor 群組外新增 storage 群組,如下所示:

    yaml
    ktor:
      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 檔案中進行配置。

  2. 開啟 src/main/kotlin/com/example/plugins/ 中的 Databases.kt 檔案,並更新 configureDatabases() 函式以從設定檔載入儲存設定:

    kotlin
    fun 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 來載入自訂設定。

  3. 開啟 src/main/kotlin/com/example/ 中的 Application.kt 檔案,並將 environment.config 傳遞給 configureDatabases(),以便在應用程式啟動時載入連線設定:

    kotlin
    fun Application.module() {
        val repository = PostgresTaskRepository()
    
        configureSerialization(repository)
        configureDatabases(environment.config)
        configureRouting()
    }

配置 Ktor 外掛程式

為了在 Docker 上執行,應用程式需要將所有必要的檔案部署到容器中。視您使用的建構系統而定,有不同的外掛程式可以完成此操作:

在我們的範例中,Ktor 外掛程式已套用於 build.gradle.kts 檔案中。

kotlin
plugins {
    application
    alias(libs.plugins.kotlin.jvm)
    alias(ktorLibs.plugins.ktor)
    alias(libs.plugins.kotlin.serialization)
}

配置 Docker

準備 Docker 映像

若要將應用程式 Docker 化,請在專案的根目錄中建立一個新的 Dockerfile 並插入以下內容:

docker
# 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"]
有關此多階段建構如何運作的詳細資訊,請參閱準備 Docker 映像。

本範例使用 Amazon Corretto Docker 映像,但您也可以替換為任何其他合適的替代方案,例如:

配置 Docker Compose

在專案的根目錄中建立一個新的 compose.yml 檔案並新增以下內容:

yaml
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: 1s
  • web 服務用於執行封裝在映像內的 Ktor 應用程式。
  • db 服務使用 postgres 映像建立用於儲存任務的 ktor_tutorial_db 資料庫。

建置並執行服務

  1. 執行以下指令以建立包含您的 Ktor 應用程式的 fat JAR:

    bash
    ./gradlew :tutorial-server-docker-compose:buildFatJar
  2. 使用 docker compose up 指令建置映像並啟動容器:

    bash
    docker compose --project-directory snippets/tutorial-server-docker-compose up
  3. 等待 Docker Compose 完成映像建置。
  4. 前往 http://localhost:8080/static/index.html 開啟 Web 應用程式。您應該會看到「Task Manager Client」頁面,其中顯示三個用於篩選和新增任務的表單,以及一個任務表格。

    顯示 Task Manager Client 的瀏覽器視窗