Node.js によるウェブサービスの作成

このガイドでは、App Engine スタンダード環境で実行する Node.js ウェブサービスの作成方法を説明します。Node.js ランタイムとそのしくみの詳細については、Node.js ランタイム環境をご覧ください。

始める前に

要点

  • 依存関係を package.json ファイル内にリストすることで、依存関係を使用できます。詳細については、依存関係の指定をご覧ください。
  • App Engine は npm start を実行してアプリケーションを起動します。
  • サーバーは、process.env.PORT 環境変数で指定されたポートをリッスンする必要があります。
  • サービスを App Engine にデプロイするには、app.yaml ファイルが必要です。

HTTP リクエストをリッスンするサーバーの作成

ウェブサービスの中核となるのが HTTP サーバーです。このガイドのサンプルコードでは、Express.js フレームワークを使用して HTTP リクエストを処理していますが、任意のウェブ フレームワークを自由に使用できます。

  1. Node.js サービス用に my-nodejs-service という新しいフォルダを作成します。

  2. ターミナルでこのフォルダに移動し、npm init を実行して package.json というファイルを作成します。

  3. 次のコマンドを実行して、Express を依存関係として追加します。

    npm install express
    

    package.json ファイルの dependencies フィールドに Express が表示されていることを確認します。次に例を示します。

    {
      ...
      "dependencies": {
        "express": "^4.16.3"
      }
      ...
    }
    
  4. package.json ファイルに start スクリプトを追加します。

    "scripts": {
      "start": "node server.js"
    }
    
  5. 同じフォルダに server.js というファイルを作成し、次のコードを追加します。

    const express = require('express');
    const app = express();
    
    app.get('/', (req, res) => {
      res.send('Hello from App Engine!');
    });
    
    // Listen to the App Engine-specified port, or 8080 otherwise
    const PORT = process.env.PORT || 8080;
    app.listen(PORT, () => {
      console.log(`Server listening on port ${PORT}...`);
    });

これは非常に基本的なウェブサーバーです。ルートパス('/')に対するすべての GET リクエストに "Hello from App Engine!" というテキストによるレスポンスを返します。最後の 4 行では、App Engine ランタイムで設定された環境変数 process.env.PORT によって指定されたポートをリッスンするようにサーバーを設定しています。このポートをリッスンするように設定されていない場合、サーバーはリクエストを受信しません。

process.env.PORT が設定されていない場合は、ポート 8080 がデフォルトで使用されます。これは、アプリをローカルでテストする場合に必要です。process.env.PORT はローカルでの実行中には設定されず、アプリが App Engine で実行されている場合にのみ設定されるためです。テストではどちらのポートでも使用できますが、このガイドでは 8080 を使用しています。

サーバーのローカルでの実行

サーバーをローカルで実行するには:

  1. ターミナルで npm start を実行します。これにより、server.js ファイルが実行されます。

  2. ウェブブラウザで http://localhost:8080 にアクセスします。

"Hello from App Engine!" というテキストが記されたページが表示されます。

app.yaml ファイルの作成

app.yaml ファイルでは、App Engine サービスのランタイム環境の設定を指定します。このファイルがないと、サービスはデプロイされません。

  1. my-nodejs-service フォルダに app.yaml というファイルを作成します。

  2. このファイル内に次の内容を追加します。

    runtime: nodejs10

    これは、App Engine に対して Node.js ランタイムのバージョンを示す最小限の構成ファイルです。この app.yaml ファイルでは、ネットワーク設定、スケーリング設定などを指定することもできます。詳細については、app.yaml リファレンスをご覧ください。

現時点で、ファイル構造は次のようになっているはずです。

my-nodejs-service/
  app.yaml
  package.json
  server.js

次のステップ

これで、適切なポートをリッスンする簡単な Node.js ウェブサーバーの作成と、app.yaml ファイルでのランタイムの指定が済み、サービスを App Engine にデプロイする準備が整いました。

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

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

Node.js 用 App Engine スタンダード環境に関するドキュメント