Skip to content

将 Ktor 应用部署到 Google App Engine ​

初始项目:engine-main

最终项目:google-appengine-standard

在本教程中,你将学习如何准备 Ktor 项目并将其部署到 Google App Engine 标准环境。 本教程使用 engine-main 示例项目作为起点。

前提条件 ​

在开始本教程之前,请完成以下步骤:

  • 在 Google Cloud Platform 上注册。
  • 安装并初始化 Google Cloud SDK。
  • 使用以下命令安装适用于 Java 的 App Engine 扩展程序:
    Bash
    gcloud components install app-engine-java

克隆示例应用程序 ​

要打开示例应用程序,请按照以下步骤操作:

  1. 克隆 Ktor 文档仓库并打开 codeSnippets 项目。
  2. 打开 engine-main 模块。

    Ktor 提供了两种创建和配置服务器的方法:在代码中配置或在配置文件中配置。在本教程中,这两种方法的部署过程完全相同。

准备应用程序 ​

步骤 1:应用 Shadow 插件 ​

本教程演示如何使用 fat JAR 将应用程序部署到 Google App Engine。要生成 fat JAR,必须应用 Shadow 插件。

首先,打开 gradle/libs.versions.toml 文件并定义 Shadow 插件版本及其别名:

toml
[versions]
shadow = "8.3.10"

[plugins]
shadow = { id = "com.gradleup.shadow", version.ref = "shadow" }

然后,打开 build.gradle.kts 文件并将该插件添加到 plugins 块中:

kotlin
plugins {
    alias(libs.plugins.shadow)
}

步骤 2:配置 App Engine 插件 ​

Google App Engine Gradle 插件提供了用于构建和部署 Google App Engine 应用程序的任务。要使用此插件,请按照以下步骤操作:

  1. 打开 settings.gradle.kt 文件并使用以下代码引用来自 Central Maven 仓库的插件:

    kotlin
    pluginManagement {
        repositories {
            if (!providers.gradleProperty("build_snapshot_train").orNull.isNullOrEmpty()) {
                mavenLocal()
                maven("https://redirector.kotlinlang.org/maven/dev")
            }
            gradlePluginPortal()
            mavenCentral()
            maven("https://redirector.kotlinlang.org/maven/ktor-eap")
        }
        resolutionStrategy {
            eachPlugin {
                if (requested.id.id.startsWith("com.google.cloud.tools.appengine")) {
                    useModule("com.google.cloud.tools:appengine-gradle-plugin:${requested.version}")
  2. 打开 build.gradle.kts 文件并在 plugins 块中应用该插件:

    kotlin
    plugins {
        alias(libs.plugins.appengine)
    }
  3. 在同一个 build.gradle.kts 文件中,添加带有以下设置的 appengine 块:

    kotlin
    import com.google.cloud.tools.gradle.appengine.appyaml.AppEngineAppYamlExtension
    configure<AppEngineAppYamlExtension> {
        stage {
            setArtifact("build/libs/${project.name}-all.jar")
        }
        deploy {
            version = "GCLOUD_CONFIG"
            projectId = "GCLOUD_CONFIG"
        }
    }

步骤 3:配置 App Engine 设置 ​

你在 app.yaml 文件中为应用程序配置 App Engine 设置:

  1. 在 src/main 内创建 appengine 目录。

  2. 在该目录下创建 app.yaml 文件并添加以下内容:

    yaml
    runtime: java21
    entrypoint: 'java -jar google-appengine-standard-all.jar'

    将 google-appengine-standard 替换为你的项目名称。

    entrypoint 选项包含用于运行为该应用程序生成的 fat JAR 的命令。

    有关受支持配置选项的更多信息,请参阅 Google AppEngine 文档。

部署应用程序 ​

要部署应用程序,请打开一个新的终端窗口并按照以下步骤操作:

  1. 首先,创建一个 Google Cloud 项目,它是容纳应用程序资源的顶级容器。例如,以下命令将创建一个名为 ktor-sample-app-engine 的项目:

    Bash
    gcloud projects create ktor-sample-app-engine --set-as-default
  2. 为该 Cloud 项目创建 App Engine 应用程序:

    Bash
    gcloud app create
  3. 要部署应用程序,请运行 appengineDeploy Gradle 任务:

    Bash
    ./gradlew appengineDeploy
  4. 等待 Google Cloud 构建并发布应用程序:

    ...done.
    Deployed service [default] to [https://ktor-sample-app-engine.ew.r.appspot.com]

    如果在构建过程中收到 Cloud Build has not been used in project 错误,请根据错误报告中的说明将其启用。

    有关完整代码示例,请参阅 google-appengine-standard。