ローカル開発サーバーの使用

ローカル開発サーバーの使用

Cloud SDK と Python 2 用 App Engine SDK には、本番環境の App Engine で動作するアプリケーションをシミュレートするために、ローカルで実行できるローカル開発用サーバー（dev_appserver.py）が同梱されています。シミュレートされた環境ではサンドボックスに制限があります。たとえば、システム関数や Python 2 モジュールによるインポート機能が制限されています。また、リクエストのタイムアウトや割り当ても設定されています。

App Engine 用 SDK のライブラリによって提供される Datastore、Memcache、タスクキューなどのサービスを、ローカル開発用サーバーでローカルに実行してシミュレートすることもできます。アプリケーションが開発用サーバーで動作している場合でも、Google API の HTTP エンドポイントを使用して、本番環境のインフラストラクチャに対するリモート API 呼び出しを実行できます。

ローカル開発サーバーの実行

アプリの app.yaml 構成ファイルを作成した後、dev_appserver.py コマンドを使用してローカル開発用サーバーを起動し、アプリをローカルで実行できます。

ローカル開発用サーバーを起動するには:

ローカル開発用サーバー（`dev_appserver.py`）の実行

ローカル開発用サーバーを実行するには、ディレクトリをフルパスで指定して dev_appserver.py を実行するか、PATH 環境変数に dev_appserver.py を追加します。

App Engine SDK をインストールした場合、ツールは [PATH_TO_APP_ENGINE_SDK]/dev_appserver.py にあります。
Google Cloud SDK をインストールした場合、ツールは [PATH_TO_CLOUD_SDK]/google-cloud-sdk/bin/dev_appserver.py にあります。

ヒント: Google Cloud SDK ツールを PATH に追加し、bash シェルでコマンドの補完を有効にするには、次のコマンドを実行します。
```
[PATH_TO_CLOUD_SDK]/google-cloud-sdk/install.sh
```

アプリケーションの dev_appserver.py 構成ファイルが格納されているディレクトリから、次のように app.yaml コマンドを実行します。
アプリケーションへのディレクトリパスを指定します。たとえば次のようにします。
```
dev_appserver.py [PATH_TO_YOUR_APP]
```
また、特定のサービスの構成ファイルを指定することもできます。たとえば次のようにします。
```
dev_appserver.py app.yaml
```
ポートを変更する場合は、--port オプションを含めます。
```
dev_appserver.py --port=9999 [PATH_TO_YOUR_APP]
```
dev_appserver.py が機能しない場合

dev_appserver.py コマンドオプションの詳細については、ローカル開発用サーバーのオプションをご覧ください。
ローカル開発用サーバーが起動し、リクエストを待機します。ウェブブラウザで http://localhost:8080/ にアクセスすると、アプリの動作を確認できます。
--port オプションでカスタムポートを指定した場合は、そのポートにブラウザを開くようにしてください。

ローカルサーバーをコマンドラインから停止するには、次のキーを押します。

macOS または Linux: Control-C
Windows: Ctrl-Break

アプリケーション ID の指定

メールアドレスのなりすましなどのために、ローカルサーバーでアプリ ID を使用する必要がある場合は、get_application_id() 関数を使用します。動作中のアプリのホスト名を取得するには、get_default_version_hostname() 関数を使用します。

アプリケーションのランタイム環境の検出

コードが本番環境で実行されているか、ローカル開発用サーバーで実行されているかを確認するには、SERVER_SOFTWARE 環境変数を確認します。

if os.getenv('SERVER_SOFTWARE', '').startswith('Google App Engine/'):
  # Production
else:
  # Local development server

ローカル Datastore の使用

ローカル開発用サーバーは、ローカルサーバーの呼び出し間で持続するローカルファイルを使用して App Engine データストアをシミュレートします。

インデックスと index.yaml の詳細については、Datastore インデックスページと Datastore インデックスの構成ページをご覧ください。

ローカル Datastore の参照

ローカル開発用サーバーを使用してアプリがローカル Datastore にデータを書き込んでいる場合は、ローカル開発コンソールでそのデータを参照できます。

ローカル Datastore を参照するには:

開発用サーバーを起動します。
ローカル開発コンソールで Datastore Viewer にアクセスします（URL は http://localhost:8000/datastore です）。
ローカル Datastore のコンテンツを参照します。

ID 割り当てポリシーの指定

本番環境の App Engine の場合、エンティティ ID を自動的に生成するように Datastore を設定できます。

本番環境用サーバーの自動 ID 割り当てポリシーは、開発用サーバーで使用されるポリシーとは完全に異なりますが、ローカルサーバー用に自動 ID 割り当てポリシーを設定することもできます。

自動 ID 割り当てポリシーを指定するには、--auto_id_policy オプションを使用します。

dev_appserver.py --auto_id_policy=sequential

ここで、--auto_id_policy には次のどちらかを指定できます。

scattered:（デフォルト）ID は、ほぼ均一に分布する整数の繰り返しのないシーケンスから割り当てられます。
sequential: ID は、連続する整数のシーケンスから割り当てられます。

ローカル Datastore のクリア

アプリケーション用のローカルデータストアをクリアするには、ローカル開発用サーバーを次のように呼び出します。

dev_appserver.py --clear_datastore=yes app.yaml

ローカル Datastore の場所変更

データストアファイルに使用する場所を変更するには、--datastore_path オプションを使用します。

dev_appserver.py --datastore_path=/tmp/myapp_datastore app.yaml

Users サービスの使用

App Engine には、アプリケーションの認証と承認を簡素化するための Users サービスが用意されています。ローカル開発用サーバーは、独自のログインページとログアウトページで Google アカウントの動作をシミュレートします。ローカル開発サーバーでの動作中は、users.create_login_url 関数はローカルサーバーの /_ah/login の URL を、users.create_logout_url 関数は /_ah/logout の URL を返します。

メールの使用

ローカル開発用サーバーは、SMTP サーバーまたはローカルにインストールされた Sendmail を使用して、呼び出しのメールを App Engine のメールサービスに送信できます。

SMTP の使用

SMTP サーバーを使用してメールサポートを有効にするには、次のようにして dev_appserver.py を呼び出します。

dev_appserver.py --smtp_host=smtp.example.com --smtp_port=25 \
    --smtp_user=ajohnson --smtp_password=k1tt3ns [PATH_TO_YOUR_APP]

ここで、--smtp_host、--smtp_port、--smtp_user、--smtp_password の各オプションには、ご自分の環境の値を指定してください。

Sendmail の使用

Sendmail を使用してメールサポートを有効にするには、次のようにして dev_appserver.py を呼び出します。

dev_appserver.py --enable_sendmail=yes [PATH_TO_YOUR_APP]

ローカルサーバーは sendmail コマンドを使用し、インストールのデフォルト構成に従ってメールのメッセージを送信します。

URL 取得の使用

アプリケーションが URL 取得 API を使用して HTTP リクエストを送信する場合、ローカル開発用サーバーはデベロッパーのコンピュータからリクエストを直接送信します。プロキシサーバーを使用してウェブサイトにアクセスしている場合、ローカルサーバーでの URL 取得の動作は本番環境の App Engine と異なることがあります。

インタラクティブコンソールの使用

インタラクティブコンソールを使用すると、デベロッパーはウェブフォームに任意の Python コードを入力し、アプリの環境内で実行できます。これは、アプリケーション自体の内部にある .py ファイルと同様に、アプリケーションの環境とサービスに対するアクセスを提供します。

インタラクティブコンソールを使用するには:

開発用サーバーを起動します。
ローカル開発コンソールでインタラクティブコンソールにアクセスします（URL は http://localhost:8000/console です）。
テキストボックスに実行する必要のある任意の Python コードを入力し、フォームを送信して実行します。たとえば、次のコードは Hello というテキストコンテンツを持つ Greeting という名前の Datastore エンティティを追加します。
```
  from google.appengine.ext import ndb
  class Greeting(ndb.Model):
    content = ndb.TextProperty()

  e = Greeting(content="Hello")
  e.put()
```

PDB を使用したデバッグ

Python PDB デバッガを使用するには:

コードに次の行を追加します。
```
import pdb; pdb.set_trace();
```
dev_appserver はここで中断し PDB REPL になるため、コマンドラインからコードをデバッグできます。
アプリケーションが pdb.set_trace() を呼び出す複数のリクエストを同時に送信すると、複数のデバッグセッションが同時に開始され、それぞれが STDOUT に対して出力を送信します。これを防ぐには、次のように dev_appserver のマルチスレッドとマルチ処理のサポートを無効にして、リクエストをシリアル化します。
1. 次のマルチスレッドを無効にします。
  - --threadsafe_override=false フラグを使用するすべてのサービス。
  - --threadsafe_override=<SERVICENAME>:false フラグを使用する 1 つのサービス。
  - --threadsafe_override=<SERVICE1NAME>:false,<SERVICE2NAME>:false フラグを使用する複数のサービス。
  1. 次のマルチ処理を無効にします。
    - --max_module_instances=1 フラグを使用するすべてのサービス。
    - --max_module_instances=<SERVICENAME>:1 フラグを使用する 1 つのサービス。
    - --max_module_instances=<SERVICE1NAME>:1,<SERVICE2NAME>:1 フラグを使用する複数のサービス。

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

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

最終更新日: 9月 25, 2019