App Engine フレキシブル環境で Node.js を使用するためのクイックスタート

このクイックスタートでは、短いメッセージを表示する小さな App Engine アプリケーションを作成する方法について説明します。

始める前に

このサンプルを実行してデプロイする前に、次の手順を行います。

  1. GCP Console を使用して新しい GCP プロジェクトを作成し、App Engine アプリケーションを作成して課金を有効にします。
    App Engine に移動

    プロンプトが表示されたら、App Engine アプリケーションを配置するリージョンを選択し、課金を有効にします。

  2. 次の前提条件をローカルにインストールします。
    1. git をダウンロードしてインストールします
    2. Node.js 開発用に環境を準備します
    3. Google Cloud SDK をダウンロードし、インストールしてから、gcloud ツールを初期化します。
      SDK をダウンロード
  3. 別の方法: git と Cloud SDK がインストールされていれば Google Cloud Shell もインストールされており、これを言語サポートやコードエディタなどの他の多くの機能と組み合わせて使用できます。

    Google Cloud Shell が起動されたら、このチュートリアルの残りの部分に進んで、Cloud Shell 内でコマンドを実行することができます。

App Engine のロケーション

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

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

App Engine は次のリージョンで利用できます。

  • northamerica-northeast1(モントリオール)
  • us-central(アイオワ)
  • us-east1(サウスカロライナ)
  • us-east4(バージニア北部)
  • southamerica-east1(サンパウロ)*
  • europe-west(ベルギー)
  • europe-west2(ロンドン)
  • europe-west3(フランクフルト)
  • asia-northeast1(東京)
  • asia-south1(ムンバイ)
  • australia-southeast1(シドニー)

* サンパウロ リージョンをご利用のお客様には、すべてのリージョナル プロダクト SLA が引き続き有効です。ただし、北米と南米を対象とするマルチリージョン機能およびクロスリージョン機能は、可用性またはパフォーマンスが一時的に低下する可能性があります。

アプリのリージョンを設定した後で変更することはできません。

App Engine アプリケーションをすでに作成している場合は、gcloud app describe コマンドを実行するか GCP Console の App Engine ダッシュボードを開くことで、リージョンを表示できます。App Engine アプリケーションのリージョンは http://[YOUR_PROJECT_ID].appspot.com に表示されます。

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

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

Node.js 用のシンプルな Hello World アプリが用意されています。これを使用することで、App Engine フレキシブル環境へのアプリのデプロイをすぐに試すことができます。次の手順で、コマンドラインから Hello World アプリをローカルマシンにダウンロードします。

サンプルアプリをダウンロードし、アプリのディレクトリに移動するには:

  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 ツールでデフォルトとして初期設定したものに代わる GCP プロジェクト ID を指定するには、--project フラグを含めます。例: --project [YOUR_PROJECT_ID]

    例:

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

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

  2. 次のコマンドを実行してブラウザを起動し、http://YOUR_PROJECT_ID.appspot.com でアプリを表示します。
    gcloud app browse
今回の Hello World メッセージが表示されるページは、App Engine インスタンスで実行されているウェブサーバーから配信されます。

これで完了です。 最初の Node.js アプリが App Engine フレキシブル環境にデプロイされました。

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

クリーンアップ

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

  1. GCP Console で [プロジェクト] ページに移動します。

    プロジェクト ページに移動

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

次のステップ

これで、Hello World が完了しました。次のサンプルアプリとして Bookshelf アプリについて詳しく見ていきましょう。Bookshelf アプリも基礎的な Node.js ウェブアプリですが、もう少し複雑で、データ ストレージ、認証、ロギング、Pub/Sub など複数の Cloud Platform 機能を使用します。

Bookshelf アプリのチュートリアルを開始

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 = 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 ファイルには、アプリケーションのデプロイ構成が記述されています。

runtime: nodejs
env: flex

# 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

app.yaml では、このアプリで使用するランタイムを指定します。また、env: flex を設定することで、このアプリがフレキシブル環境を使用することを指定します。

package.json

package.json は、アプリケーションの依存関係、ノードのバージョン、アプリケーションの起動を指定するために使用します。

{
  "name": "appengine-hello-world",
  "description": "Simple Hello World Node.js sample for Google App Engine Flexible Environment.",
  "version": "0.0.1",
  "private": true,
  "license": "Apache-2.0",
  "author": "Google Inc.",
  "repository": {
    "type": "git",
    "url": "https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git"
  },
  "engines": {
    "node": ">=4.3.2"
  },
  "scripts": {
    "deploy": "gcloud app deploy",
    "start": "node app.js",
    "lint": "repo-tools lint",
    "pretest": "npm run lint",
    "system-test": "repo-tools test app",
    "test": "npm run system-test",
    "e2e-test": "repo-tools test deploy"
  },
  "dependencies": {
    "express": "4.16.2"
  },
  "devDependencies": {
    "@google-cloud/nodejs-repo-tools": "2.2.1"
  },
  "cloud-repo-tools": {
    "test": {
      "app": {
        "msg": "Hello, world!"
      }
    },
    "requiresKeyFile": true,
    "requiresProjectId": true
  }
}

この package.json では、アプリケーションが Node.js v4.3.2 以降を使用すること、express に依存すること、node app.js を使用してアプリケーションを起動することを指定します。ユーザーアプリのインストール方法や実行方法については、Node.js ランタイム ドキュメントをご覧ください。

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...