Exécuter et déboguer une application standard App Engine localement dans Cloud Code pour IntelliJ

Avant de déployer votre application sur App Engine, vous pouvez exécuter et déboguer votre application standard App Engine localement. Ce document explique comment configurer l'IDE pour une exécution locale et un débogage à partir d'IntelliJ IDEA.

Remarque:Les IDE suivants sont compatibles avec cette fonctionnalité :

• IntelliJ IDEA - Ultimate
• IntelliJ IDEA - Community

Remarque :Pour l'environnement standard App Engine, seules les applications Java utilisant l'environnement d'exécution Java 8 sont compatibles avec Cloud Code.

Avant de commencer

• Vérifiez que votre application est un projet pour l'environnement standard App Engine contenant un fichier appengine-web.xml.

• Pour accéder localement aux bibliothèques clientes Cloud, suivez les procédures Ajouter des bibliothèques clientes Cloud à vos projets Maven.

Remarque : Les configurations d'exécution pour l'exécution et le débogage en local ne sont disponibles que dans IntelliJ Ultimate Edition. Si vous utilisez Community Edition, vous pouvez suivre les instructions sur le débogage en local dans Community Edition. Elles expliquent comment utiliser le plug-in Maven ou le plug-in Gradle pour exécuter une application en local.

Exécuter votre application en local

Si vous utilisez IntelliJ IDEA Ultimate Edition, vous pouvez exécuter une application App Engine en local en procédant comme suit :

1. Sélectionnez File > Open (Fichier > Ouvrir) pour ouvrir le projet à exécuter.

2. Accédez au répertoire contenant votre projet.

3. Sélectionnez Tools > Cloud Code > App Engine > Run on a local App Engine Standard dev server (Outils > Cloud Code > App Engine > Exécuter sur un serveur de développement App Engine standard local).

La compilation du projet peut prendre un moment.

Modifier la configuration d'exécution

Configurer le serveur

Vous pouvez modifier la configuration d'exécution de votre serveur local :

1. Sélectionnez Run > Edit Configurations (Exécuter > Modifier les configurations).

2. Dans la boîte de dialogue Run/Debug Configurations (Configurations d'exécution/de débogage), mettez à jour les paramètres de configuration si nécessaire. Voici quelques paramètres courants à vérifier :

   • Artifact to deploy (Artefact à déployer)
   • App Engine Settings (Paramètres App Engine) - Host (Hôte)
   • App Engine Settings (Paramètres App Engine) - Port.

Ajouter des variables d'environnement

Si nécessaire, ajoutez des variables d'environnement à votre configuration.

1. Sélectionnez l'onglet Startup/Connection (Démarrage/Connexion).

2. Sélectionnez Run (Exécuter).

3. Cochez la case Pass environment variables (Passer les variables d’environnement).

4. Ajoutez les variables nécessaires.

5. Sélectionnez Debug (Déboguer).

6. Cochez la case Pass environment variables (Passer les variables d’environnement).

7. Ajoutez les variables nécessaires.

   

8. Lorsque vous avez terminé, cliquez sur OK.

Arrêter le serveur

Pour arrêter le serveur de développement d'applications, choisissez Run > Stop 'Google App Engine Standard Local Server' (Exécuter > Arrêter 'Google App Engine Standard Local Server').

Déboguer l'application

Vous pouvez utiliser la configuration d'exécution que vous avez précédemment créée pour exécuter votre application en mode débogage comme suit :

1. Sélectionnez Run > Debug (Exécuter > Déboguer).

2. Dans la boîte de dialogue, cliquez sur Google App Engine Standard Local Server (Serveur local en environnement standard Google App Engine).

3. Une fois le projet créé, vous pouvez définir des points d'arrêt pour déboguer votre application.

Déboguer votre application localement dans Community Edition

IntelliJ Community Edition ne propose aucune compatibilité native pour l'exécution d'applications locales basées sur des servlets Java. Pour déboguer votre application localement à l'aide d'IntelliJ Community Edition, configurez votre projet afin d'utiliser le plug-in Maven ou le plug-in Gradle.

Maven

Configurer votre projet en utilisant le plug-in Maven

1. Ajoutez le plug-in Maven pour App Engine dans le fichier pom.xml de votre projet.

2. Configurez le débogage sur un serveur de développement.

3. Créez une configuration d'exécution/de débogage pour Maven.

   

   1. Sélectionnez Run > Edit Configurations (Exécuter > Modifier les configurations).

   2. Cliquez sur + Add New Configuration (Ajouter une configuration).

   3. Sélectionnez Maven.

   4. Dans le champ Command line (Ligne de commande), saisissez appengine:run.

   5. Cliquez sur OK.

4. Créez une configuration de débogage à distance.

   

   1. Sélectionnez Run > Edit Configurations (Exécuter > Modifier les configurations).

   2. Cliquez sur + Add New Configuration (Ajouter une configuration).

   3. Sélectionnez Remote (Distante).

   4. Assurez-vous que le numéro de port est identique à celui que vous avez configuré dans la configuration du plug-in Gradle pour App Engine. Le port 5005 est le port par défaut.

   5. Dans la section Before launch (Avant le lancement), cliquez sur le signe plus (+).

   6. Sélectionnez Run Another Configuration (Exécuter une autre configuration).

   7. Sélectionnez la configuration d'exécution pour votre projet Gradle.

   8. Cliquez sur OK.

5. Pour déboguer votre application localement :

   1. Sélectionnez Run > Debug (Exécuter > Déboguer).

   2. Sélectionnez votre configuration de débogage distante.

      

      Vous pouvez maintenant déboguer votre application localement.

Gradle

Configurer votre projet en utilisant le plug-in Gradle

1. Créez un projet Gradle.

2. Configurez le débogage sur un serveur de développement.

3. Créez une configuration d'exécution/de débogage pour Gradle.

   

   1. Sélectionnez Run > Edit Configurations (Exécuter > Modifier les configurations).

   2. Cliquez sur + Add New Configuration (Ajouter une configuration).

   3. Sélectionnez Gradle.

   4. Dans le champ Gradle project (Projet Gradle), sélectionnez le module dans lequel vous avez configuré le plug-in appengine-gradle-plugin.

   5. Dans le champ Tasks (Tâches), saisissez appengineRun.

   6. Cliquez sur OK.

4. Créez une configuration de débogage à distance.

   

   1. Sélectionnez Run > Edit Configurations (Exécuter > Modifier les configurations).

   2. Cliquez sur + Add New Configuration (Ajouter une configuration).

   3. Sélectionnez Remote (Distante).

   4. Assurez-vous que le numéro de port est identique à celui que vous avez configuré dans la configuration du plug-in Gradle pour App Engine. Le port 5005 est le port par défaut.

   5. Dans la section Before launch (Avant le lancement), cliquez sur le signe plus (+).

   6. Sélectionnez Run Another Configuration (Exécuter une autre configuration).

   7. Sélectionnez la configuration d'exécution pour votre projet Gradle.

   8. Cliquez sur OK.

5. Pour déboguer votre application localement :

   1. Sélectionnez Run > Debug (Exécuter > Déboguer).

   2. Sélectionnez votre configuration de débogage distante.

      

      Vous pouvez maintenant déboguer votre application localement.

   3. Si le lien Attach Debugger (Associer le débogueur) apparaît dans le journal de la console, cliquez dessus.

      Remarque : Si le port que vous avez choisi est bloqué, configurez un numéro de port différent (par exemple, 5009) dans la configuration de Gradle App Engine Plugin et mettez à jour le numéro de port dans la configuration distante sur le même numéro de port.

Étapes suivantes

• Vous pouvez ensuite déployer votre application dans l'environnement standard App Engine.

Obtenir de l'aide

Pour envoyer des commentaires ou signaler un problème dans votre IDE IntelliJ, accédez à Outils > Cloud Code > Aide / À propos > Envoyer des commentaires ou signaler un problème pour signaler un problème sur GitHub, ou posez une question sur Stack Overflow.