Skip to content

將 Ktor 應用程式部署至 AWS Elastic Beanstalk ​

初始專案:embedded-server 或 engine-main

最終專案:aws-elastic-beanstalk

在本教學中,你將學習如何準備並將 Ktor 應用程式部署至 Amazon Web Services (AWS) Elastic Beanstalk。 你可以根據建立 Ktor 伺服器的方式,選擇使用以下初始專案之一:

若要進一步了解如何將 Java 應用程式部署至 AWS Elastic Beanstalk,請參閱 Elastic Beanstalk 文件。

先決條件 ​

在開始本教學之前,你需要建立一個 AWS 帳戶。

複製範例應用程式 ​

若要開啟範例應用程式,請遵循以下步驟:

  1. 複製 Ktor 文件存儲庫並開啟 codeSnippets 專案。
  2. 開啟 embedded-server 或 engine-main 範例。這些範例展示了建立和配置 Ktor 伺服器的不同方法:在程式碼中或透過使用設定檔。部署這些專案的唯一區別在於如何指定用於監聽傳入請求的連接埠。

準備應用程式 ​

步驟 1:配置連接埠 ​

首先,你需要指定用於監聽傳入請求的連接埠。Elastic Beanstalk 會在連接埠 5000 上將請求轉發至你的應用程式。你可以透過設定 PORT 環境變數來覆寫預設連接埠。根據配置 Ktor 伺服器的方式,你可以透過以下其中一種方式配置連接埠:

  • 如果你選擇了在程式碼中指定伺服器配置的 embedded-server 範例,你可以使用 System.getenv 取得環境變數值,或在未指定環境變數時使用預設的 5000 值。開啟位於 src/main/kotlin/com/example 資料夾中的 Application.kt 檔案,並如下所示修改 embeddedServer 函式的 port 參數值:

    kotlin
    fun main() {
       embeddedServer(Netty, port = (System.getenv("PORT")?:"5000").toInt()) {
       // ...
       }.start(wait = true)
    }
  • 如果你選擇了在 application.conf 檔案中指定伺服器配置的 engine-main 範例,你可以使用 ${ENV} 語法將環境變數指派給 port 參數。開啟位於 src/main/resources 中的 application.conf 檔案,並如下所示進行更新:

    ktor {
        deployment {
            port = 5000
            port = ${?PORT}
        }
    }

步驟 2:套用 Ktor 外掛程式 ​

本教學介紹如何使用 fat JAR 將應用程式部署至 AWS Elastic Beanstalk。若要產生 fat JAR,你需要套用 Ktor 外掛程式。

開啟 build.gradle.kts 檔案,並將外掛程式新增至 plugins {} 區塊:

groovy
plugins {
    alias(ktorLibs.plugins.ktor)
}
上述程式碼片段使用 Ktor version catalog 來指定 Ktor 相依性。

然後,確保已配置主要應用程式類別:

kotlin
application {
    mainClass.set("io.ktor.server.netty.EngineMain")
}

建置 Fat JAR ​

若要建置 Fat JAR,請開啟終端並執行由 Ktor 外掛程式提供的 buildFatJar 任務:

./gradlew :aws-elastic-beanstalk:buildFatJar
gradlew.bat :aws-elastic-beanstalk:buildFatJar

建置完成後,你應該會在 build/libs 目錄中看到 aws-elastic-beanstalk-all.jar 檔案。

部署應用程式 ​

若要部署應用程式,請登入 AWS Management Console 並遵循以下步驟:

  1. 在 AWS services 群組中開啟 Elastic Beanstalk 服務。
  2. 在開啟的頁面中,點擊 Create Application。
  3. 指定以下應用程式設定:
    • Application name:指定應用程式名稱(例如 Sample Ktor app)。
    • Platform:從清單中選擇 Java。
    • Platform branch:選擇 Corretto 11 running on 64bit Amazon Linux 2。
    • Application code:選取 Upload your code。
    • Source code origin:選擇 Local file。然後點擊 Choose file 按鈕,並選擇在上一步驟中產生的 Fat JAR。等待檔案上傳完成。
  4. 點擊 Create application 按鈕,並等待數分鐘,直到 Beanstalk 建立環境並發佈應用程式:
    INFO    Instance deployment completed successfully.
    INFO    Application available at Samplektorapp-env.eba-bnye2kpu.us-east-2.elasticbeanstalk.com.
    INFO    Successfully launched environment: Samplektorapp-env