App Engine フレキシブル環境で Node.js アプリを作成する

App Engine フレキシブル環境で Node.js アプリを作成する

リージョン ID

REGION_ID は、アプリの作成時に選択したリージョンに基づいて Google が割り当てる省略形のコードです。一部のリージョン ID は、一般的に使用されている国や州のコードと類似しているように見える場合がありますが、このコードは国または州に対応するものではありません。2020 年 2 月以降に作成されたアプリの場合、REGION_ID.r は App Engine の URL に含まれています。この日付より前に作成されたアプリの場合、URL のリージョン ID は省略可能です。

詳しくは、リージョン ID をご覧ください。

OK

このクイックスタートでは、ショート メッセージを表示するアプリを作成してデプロイする方法を説明します。サンプル アプリケーションでは最新バージョンの Node.js を使用しています。app.yaml でバージョンを指定することで、Node.js 18 以降にも同じコードサンプルを使用できます。

Node.js 16 以前のバージョンのコードサンプルは、GitHub で入手できます。

始める前に

1. Google Cloud アカウントにログインします。Google Cloud を初めて使用する場合は、アカウントを作成して、実際のシナリオでの Google プロダクトのパフォーマンスを評価してください。新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。

2. Google Cloud Console の [プロジェクト セレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

   注: この手順で作成するリソースをそのまま保持する予定でない場合、既存のプロジェクトを選択するのではなく、新しいプロジェクトを作成してください。チュートリアルの終了後にそのプロジェクトを削除すれば、プロジェクトに関連するすべてのリソースを削除できます。

   プロジェクト セレクタに移動

3. Google Cloud プロジェクトで課金が有効になっていることを確認します。

4. Cloud Build API を有効にします。

   API を有効にする

5. Google Cloud CLI をインストールします。

6. gcloud CLI を初期化するには:

   gcloud init

7. Google Cloud Console の [プロジェクト セレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

   注: この手順で作成するリソースをそのまま保持する予定でない場合、既存のプロジェクトを選択するのではなく、新しいプロジェクトを作成してください。チュートリアルの終了後にそのプロジェクトを削除すれば、プロジェクトに関連するすべてのリソースを削除できます。

   プロジェクト セレクタに移動

8. Google Cloud プロジェクトで課金が有効になっていることを確認します。

9. Cloud Build API を有効にします。

   API を有効にする

10. Google Cloud CLI をインストールします。

11. gcloud CLI を初期化するには:

    gcloud init

追加の前提条件

1. プロジェクトで App Engine アプリケーションを初期化し、そのリージョンを選択します。

   gcloud app create --project=[YOUR_PROJECT_ID]
   

   表示された指示に従って、App Engine アプリケーションを配置するリージョンを選択します。

   注: アプリのリージョンは、設定後に変更できません。

2. 次の前提条件をインストールします。

   • Git をダウンロードしてインストールします。
   • Node.js 開発用に環境を準備します。

App Engine のロケーション

App Engine はリージョナルです。つまり、アプリを実行するインフラストラクチャは特定のリージョンに配置され、そのリージョン内のすべてのゾーンで冗長的に利用できるように Google が管理しています。

レイテンシ、可用性、耐久性の要件を満たすことが、アプリを実行するリージョンを選択する際の主な要素になります。一般的には、アプリのユーザーに最も近いリージョンを選択できますが、App Engine が使用可能なロケーションと、アプリが使用するその他の Google Cloud プロダクトおよびサービスのロケーションを考慮する必要があります。使用するサービスが複数のロケーションにまたがっていると、アプリのレイテンシだけでなく、料金にも影響する可能性があります。

設定したアプリのリージョンは変更できません。

注: App Engine コマンドと Google Cloud コンソールで europe-west および us-central と呼ばれる 2 つのロケーションは、Google ドキュメントの他の箇所では、それぞれ europe-west1、us-central1 と呼ばれています。

すでに App Engine アプリケーションを作成している場合は、次のいずれかの方法でそのリージョンを表示できます。

• gcloud app describe コマンドを実行します。

• Google Cloud コンソールの App Engine ダッシュボードを開きます。ページの上部にリージョンが表示されます。

OK

このクイックスタートでは、Express.js フレームワークで作成されたシンプルな Node.js アプリケーションについて具体的に説明します。

重要: Windows での最適な動作を実現するには、npm install -g npm を実行して最新バージョンの Node.js パッケージ マネージャー（npm）にアップグレードしてください。最新の npm では、フラットなディレクトリ構造に依存関係がインストールされます。そのため通常は、インストールによって Windows でのパスの最大長である 255 文字の文字数との競合が生じることはありません。引き続き古いバージョンの npm を使用する場合は、プロジェクトをドライブのルート（例: C:\）に移動することでパスの長さを短くできます。

Hello World アプリをダウンロードする

App Engine 用のシンプルな Hello World アプリが用意されており、Google Cloud へのアプリのデプロイをすぐに試すことができます。

1. Hello World サンプルアプリ リポジトリのクローンをローカルマシンに作成します。

   git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples
   

   または、zip 形式のサンプルをダウンロードして、ファイルを抽出します。

2. サンプルコードが含まれているディレクトリに移動します。

      cd nodejs-docs-samples/appengine/hello-world/flexible/
   

ローカルマシンで Hello World を実行する

1. このプロジェクトの依存関係をインストールします。

   npm install
   

   Yarn を使用している場合は、次のコマンドを入力します。

   yarn install
   

2. 起動スクリプトを実行します。

   npm start
   

   Yarn を使用している場合は、次のコマンドを入力します。

   yarn start
   

3. ウェブブラウザでアプリを表示します。

   • Cloud Shell を使用する場合は、代わりにツールバーのウェブでプレビュー をクリックし、[ポート 8080 上でプレビュー] を選択します。

   • Cloud Shell を使用しない場合は、次のアドレスを入力します。

   http://localhost:8080

サンプルアプリから Hello World というメッセージがページに表示されます。ターミナル ウィンドウで Ctrl+C キーを押してウェブサーバーを終了します。

Hello World を App Engine にデプロイして実行する

App Engine フレキシブル環境にアプリをデプロイするには:

1. hello-world/flexible/ ディレクトリで次のコマンドを実行して、Hello World アプリをデプロイします。

   gcloud app deploy

   オプションのフラグをご覧ください。

   共通の gcloud コマンドフラグ

   • アプリのバージョンを一意に識別する ID を指定するには --version フラグを含めます。このフラグを含めない場合は自動的に生成されます。例: --version [YOUR_VERSION_ID]
   • gcloud ツールでデフォルトとして初期設定したものに代わる Google Cloud プロジェクト ID を指定するには、--project フラグを指定します。例: --project [YOUR_PROJECT_ID]

   例:

   gcloud app deploy --version pre-prod-5 --project my-sample-app

   コマンドラインからアプリをデプロイする方法について詳しくは、アプリのテストとデプロイをご覧ください。すべてのコマンドフラグの一覧については、gcloud app deploy リファレンスをご覧ください。

   OK
   注: デプロイ時には、依存関係をインストールするために npm install をデフォルトで使用します。ただし、yarn.lock ファイルが存在していて、app.yaml ファイルの skip_files セクションにリストされていない場合は、代わりに yarn install --production を使用します。ビルドを npm install にフォールバックするには、yarn.lock ファイルを削除するか、または yarn.lock を app.yaml ファイルの skip_files セクションに追加します。

2. ブラウザを起動し、https://PROJECT_ID.REGION_ID.r.appspot.com にアクセスしてアプリを表示します。

   gcloud app browse

   ここで PROJECT_ID は、Google Cloud プロジェクト ID です。

今回、Hello World メッセージが表示されるページは、App Engine インスタンスで実行されているウェブサーバーから配信されます。

これで完了です。App Engine フレキシブル環境に最初の App Engine アプリケーションをデプロイしました。

アプリケーションのデプロイでエラーが発生した場合は、トラブルシューティングのヒントをご覧ください。

クリーンアップの詳細については、以下の説明をご覧ください。また、活用できる次のステップへのリンクも併せてご確認ください。

クリーンアップ

課金されないようにするには、Google Cloud プロジェクトを削除してプロジェクト内のすべてのリソースへの課金を停止します。

注意
: プロジェクトを削除すると、次のような影響があります。
• プロジェクト内のすべてのものが削除されます。このドキュメントのタスクで既存のプロジェクトを使用した場合、それを削除すると、そのプロジェクトで行った他の作業もすべて削除されます。
• カスタム プロジェクト ID が失われます。このプロジェクトを作成したときに、将来使用するカスタム プロジェクト ID を作成した可能性があります。そのプロジェクト ID を使用した URL（たとえば、appspot.com）を保持するには、プロジェクト全体ではなくプロジェクト内の選択したリソースだけを削除します。
1. Google Cloud コンソールで、[リソースの管理] ページに移動します。

   [リソースの管理] に移動

2. プロジェクト リストで、削除するプロジェクトを選択し、[削除] をクリックします。
3. ダイアログでプロジェクト ID を入力し、[シャットダウン] をクリックしてプロジェクトを削除します。

次のステップ

プラットフォーム全体について学習する

App Engine アプリの開発とデプロイについて概要を理解した後は、Google Cloud の残りの部分についても確認します。すでに Google Cloud CLI がインストールされているため、Cloud SQL、Cloud Storage、Firestore などのプロダクトを操作するツールを使用できます。

App Engine フレキシブル環境について学習する

App Engine についてさらに理解を深めるためのトピックをご紹介します。

• App Engine の概要
• リクエストのルーティング
• リクエスト処理
• インスタンスの管理

Hello World コードレビュー

Hello World は、サービスが 1 つだけ含まれ、バージョンも 1 つだけで、すべてのコードがアプリケーションのルート ディレクトリにあるという、最もシンプルな App Engine アプリケーションです。このセクションでは、このアプリの各ファイルを詳しく説明します。

app.js

app.js ファイルには、サーバーの起動やリクエストへの応答を行う JavaScript コードが含まれています。

次のコードは、ウェブ クライアントからのリクエストに応答して、ポート 8080 で動作するサーバーを介して「Hello World」というメッセージを表示します。

const express = require('express');

const app = express();

app.get('/', (req, res) => {
  res.status(200).send('Hello, world!').end();
});

// Start the server
const PORT = parseInt(process.env.PORT) || 8080;
app.listen(PORT, () => {
  console.log(`App listening on port ${PORT}`);
  console.log('Press Ctrl+C to quit.');
});

app.yaml

app.yaml ファイルには、アプリの次の構成が記述されます。

• env: flex の設定。アプリで App Engine フレキシブル環境が使用されることが示されます。

• アプリで使用するランタイムを指定します。

  runtime: nodejs
  env: flex
  runtime_config:
    operating_system: ubuntu22
  # This sample incurs costs to run on the App Engine flexible environment.
  # The settings below are to reduce costs during testing and are not appropriate
  # for production use. For more information, see:
  # https://cloud.google.com/appengine/docs/flexible/nodejs/configuring-your-app-with-app-yaml
  manual_scaling:
    instances: 1
  resources:
    cpu: 1
    memory_gb: 0.5
    disk_size_gb: 10
  

  • Node.js ランタイムの動作について詳しくは、Node.js ランタイムをご覧ください。

  • バージョンとサービスを利用するアプリの作成方法について詳しくは、App Engine の概要をご覧ください。

  • App Engine の構成の詳細については、app.yaml によるアプリの構成をご覧ください。

  package.json

  package.json を使用して、アプリの依存関係、ノードのバージョン、アプリの起動を指定します。

  {
    "name": "appengine-hello-world",
    "description": "Simple Hello World Node.js sample for Google App Engine Flexible Environment.",
    "version": "0.0.2",
    "private": true,
    "license": "Apache-2.0",
    "author": "Google Inc.",
    "repository": {
      "type": "git",
      "url": "https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git"
    },
    "engines": {
      "node": ">=16.0.0"
    },
    "scripts": {
      "start": "node app.js",
      "test": "c8 mocha -p -j 2 --exit test/*.test.js"
    },
    "dependencies": {
      "express": "^4.17.1"
    },
    "devDependencies": {
      "c8": "^8.0.0",
      "mocha": "^10.0.0",
      "supertest": "^6.0.0"
    }
  }
  

  上記の例の package.json ファイルは、アプリで Node.js バージョン 18 以降を使用することと、アプリが express に依存することを指定します。アプリをインストールして実行する方法の詳細については、Node.js ランタイム ドキュメントをご覧ください。