Cloud Code for IntelliJ で App Engine 標準アプリをローカルで実行してデバッグする

注意: 2024 年 1 月 31 日をもって、App Engine の Java 8 のサポートは終了し、2026 年 1 月 31 日に非推奨になります。そのため、Cloud Code では App Engine がデフォルトで無効になっています。IDE で App Engine を有効にするには、[Settings] > [Google Cloud Code] > [App Engine] に移動します。App Engine はまもなく非推奨となるため、新しい App Engine プロジェクトの作成はおすすめしません。App Engine の非推奨について詳しくは、機能の非推奨をご覧ください。App Engine のランタイム サポート スケジュールの詳細については、ランタイム サポート スケジュールをご覧ください。

アプリケーションを App Engine にデプロイする前に、App Engine スタンダード アプリケーションをローカルで実行してデバッグできます。このドキュメントでは、IntelliJ IDEA 内からローカルで実行しデバッグできるように IDE を構成する方法について説明します。

注: 以下の IDE でこの機能がサポートされます。

• IntelliJ IDEA - Ultimate
• IntelliJ IDEA - Community

注: App Engine スタンダード環境では、Java 8 ランタイムを使用している Java アプリケーションだけが Cloud Code でサポートされています。

始める前に

• アプリケーションが、appengine-web.xml ファイルを含む App Engine スタンダード プロジェクトであることを確認します

• Cloud クライアント ライブラリにローカルでアクセスするには、Maven プロジェクトへの Cloud クライアント ライブラリの追加の手順を実行します。

注: ローカルでの実行とデバッグ用の実行構成は、IntelliJ Ultimate Edition でのみ使用できます。Community Edition を使用している場合は、Community Edition のローカルでアプリケーションをデバッグするの手順で Maven または Gradle プラグインをローカル実行に使用できます。

アプリケーションをローカルで実行する

IntelliJ IDEA Ultimate Edition を使用している場合は、次の手順で App Engine アプリケーションをローカルで実行できます。

1. [File] > [Open] の順に選択して、実行するプロジェクトを開きます。

2. プロジェクトを含むディレクトリを参照します。

3. [Tools] > [Cloud Code] > [App Engine Run on a local App Engine Standard dev server] を選択します。

プロジェクトのビルドには時間がかかります。

実行構成の編集

サーバーを構成する

ローカル サーバーの実行構成を編集できます。

1. [Run] > [Edit Configurations] の順に選択します。

2. [Run/Debug Configurations] ダイアログで、必要に応じて構成設定を更新します。一般的な設定としては次のものがあります。

   • デプロイするアーティファクト
   • App Engine ホスト
   • App Engine ポート

環境変数を追加する

必要に応じて、環境変数を構成に追加します。

1. [Startup/Connection] タブを選択します。

2. [Run] を選択します。

3. [Pass environment variables] チェックボックスをオンにします。

4. 必要な変数を追加します。

5. [Debug] を選択します。

6. [Pass environment variables] チェックボックスをオンにします。

7. 必要な変数を追加します。

   

8. 完了したら、[OK] をクリックします。

サーバーの停止

開発用アプリサーバーを停止するには、[Run] > [Stop 'Google App Engine Standard Local Server'] を選択します。

アプリケーションのデバッグ

以前に作成した実行構成を使用してアプリケーションをデバッグモードで実行するには、次のようにします。

1. [Run] > [Debug] の順に選択します。

2. ダイアログで、[Google App Engine Standard Local Server] をクリックします。

3. プロジェクトがビルドされたら、アプリをデバッグするブレークポイントを設定できます。

Community Edition のローカルでアプリケーションを実行する

IntelliJ Community Edition には、ローカル Java サーブレット ベースのアプリケーションを実行するためのサポートが組み込まれていません。IntelliJ Community Edition を使用してアプリケーションをローカルでデバッグするには、Maven または Gradle プラグインを使用するようにプロジェクトを構成します。

Maven

Maven プラグインを使用してプロジェクトを構成するには:

1. プロジェクトの pom.xml ファイルに App Engine Maven プラグインを追加します。

2. 開発用サーバーでデバッグを構成します。

3. Maven の実行 / デバッグ用の構成を作成します。

   

   1. [Run] > [Edit Configurations] の順に選択します。

   2. [+ Add New Configuration] をクリックします。

   3. Maven を選択します。

   4. [Command line] フィールドに「appengine:run」と入力します。

   5. [OK] をクリックします。

4. リモート デバッグの構成を作成します。

   

   1. [Run] > [Edit Configurations] の順に選択します。

   2. [+ Add New Configuration] をクリックします。

   3. [Remote] を選択します。

   4. ポート番号が、Maven App Engine プラグインで構成したポートと同じであることを確認します。デフォルトのポートは 5005 です。

   5. [Before launch] セクションで、[+ Add] をクリックします。

   6. [Run Another Configuration] を選択します。

   7. Maven プロジェクトの構成を実行します。

   8. [OK] をクリックします。

5. アプリケーションをローカルでデバッグするには:

   1. [Run] > [Debug] の順に選択します。

   2. リモート デバッグの構成を選択します。

      

      これで、アプリケーションをローカルでデバッグできるようになりました。

Gradle

Gradle プラグインをでプロジェクトを構成するには:

1. 新しい Gradle プロジェクトを作成します。

2. 開発用サーバーでデバッグを構成します。

3. Gradle の実行 / デバッグ構成を作成します。

   

   1. [Run] > [Edit Configurations] の順に選択します。

   2. [+ Add New Configuration] をクリックします。

   3. [Gradle] を選択します。

   4. [Gradle project] フィールドで、appengine-gradle-plugin プラグインを構成したモジュールを選択します。

   5. [Tasks] フィールドに「appengineRun」と入力します。

   6. [OK] をクリックします。

4. リモート デバッグの構成を作成します。

   

   1. [Run] > [Edit Configurations] の順に選択します。

   2. [+ Add New Configuration] をクリックします。

   3. [Remote] を選択します。

   4. ポート番号が Gradle App Engine プラグインで構成したポートと同じであることを確認します。デフォルトのポートは 5005 です。

   5. [Before launch] セクションで、[+ Add] をクリックします。

   6. [Run Another Configuration] を選択します。

   7. Gradle プロジェクトの構成を実行します。

   8. [OK] をクリックします。

5. アプリケーションをローカルでデバッグするには:

   1. [Run] > [Debug] の順に選択します。

   2. リモート デバッグの構成を選択します。

      

      これで、アプリケーションをローカルでデバッグできるようになりました。

   3. コンソールログに [Attach Debugger] リンクが表示されている場合は、そのリンクをクリックします。

      注: 選択したポートがブロックされている場合は、Gradle App Engine プラグイン構成で別のポート番号（5009 など）を構成し、リモート構成のポート番号を同じポート番号に更新します。

次のステップ

• 次に、App Engine スタンダード環境にアプリをデプロイできます。

サポートを受ける

IntelliJ IDE でフィードバックを送信するか、問題を報告するには、[Tools] > [Cloud Code] > [Help / About] > [Submit feedback or report an issue] を選択して、GitHub で問題を報告します。