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
サンプルアプリケーションのクローン
サンプルアプリケーションを開くには、以下の手順に従います。
- Ktor ドキュメントのリポジトリをクローンし、
codeSnippetsプロジェクトを開きます。 - engine-main モジュールを開きます。
Ktor はサーバーの作成と設定に関して、コード内で行うアプローチと設定ファイルで行うアプローチの2通りを提供しています。このチュートリアルにおけるデプロイ手順は、どちらのアプローチでも同じです。
アプリケーションの準備
ステップ 1: Shadow プラグインの適用
このチュートリアルでは、fat JAR を使用してアプリケーションを Google App Engine にデプロイする方法を説明します。fat JAR を生成するには、Shadow プラグインを適用する必要があります。
まず、gradle/libs.versions.toml ファイルを開き、Shadow プラグインのバージョンとそのエイリアスを定義します。
[versions]
shadow = "8.3.10"
[plugins]
shadow = { id = "com.gradleup.shadow", version.ref = "shadow" }次に、build.gradle.kts ファイルを開き、plugins ブロックにプラグインを追加します。
plugins {
alias(libs.plugins.shadow)
}ステップ 2: App Engine プラグインの設定
Google App Engine Gradle プラグインは、Google App Engine アプリケーションのビルドおよびデプロイを行うタスクを提供します。このプラグインを使用するには、以下の手順に従います。
settings.gradle.kt ファイルを開き、以下のコードを使用して Central Maven リポジトリからプラグインを参照します。
kotlinpluginManagement { 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}")build.gradle.kts ファイルを開き、
pluginsブロックでプラグインを適用します。kotlinplugins { alias(libs.plugins.appengine) }同じ build.gradle.kts ファイル内で、以下の設定を含む
appengineブロックを追加します。kotlinimport 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 Engine の設定は、app.yaml ファイルで行います。
src/main 内に appengine ディレクトリを作成します。
このディレクトリ内に app.yaml ファイルを作成し、次のコンテンツを追加します。
yamlruntime: java21 entrypoint: 'java -jar google-appengine-standard-all.jar'google-appengine-standardをお使いのプロジェクト名に置き換えてください。entrypointオプションには、アプリケーション用に生成された fat JAR を実行するためのコマンドを指定します。サポートされている設定オプションの詳細については、Google App Engine のドキュメントを参照してください。
アプリケーションのデプロイ
アプリケーションをデプロイするには、新しいターミナルウィンドウを開き、以下の手順に従います。
まず、アプリケーションリソースを保持する最上位コンテナである Google Cloud プロジェクトを作成します。例えば、以下のコマンドは
ktor-sample-app-engineという名前のプロジェクトを作成します。Bashgcloud projects create ktor-sample-app-engine --set-as-defaultCloud プロジェクト用の App Engine アプリケーションを作成します。
Bashgcloud app createアプリケーションをデプロイするには、
appengineDeployGradle タスクを実行します。Bash./gradlew appengineDeployGoogle 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 を参照してください。
