Premiers pas : Configurer votre environnement de développement

Découvrez comment configurer votre environnement de compilation pour le développement et le déploiement d'applications à l'aide de l'environnement standard Google App Engine. Les environnements de développement et de compilation Java pris en charge sont IntelliJ IDEA, Eclipse, Apache Maven et Gradle.

Ce guide vous expliquera comment :

  • installer l'outil de ligne de commande du SDK Google Cloud ;
  • installer et configurer les plug-ins App Engine pour Eclipse, IntelliJ, Gradle et Maven ;
  • créer un projet App Engine.
  • accorder à Cloud Build l'autorisation de compiler et de déployer votre application.

Installer les SDK requis

  1. Si vous n'avez pas encore installé le SDK Java SE 8, installez le kit de développement Java SE 8 (JDK).

  2. Installez la dernière version du SDK Google Cloud.

    Installer le SDK Google Cloud

  3. Installez le composant Java App Engine :

    gcloud components install app-engine-java
    
  4. Autorisez votre compte utilisateur :

    gcloud auth application-default login
    
  5. Vous pouvez également créer un compte de service en exécutant la commande gcloud auth activate-service-account --key-file=your_key.json. Pour plus d'informations, consultez la page Autoriser les outils du SDK Cloud.

Configurer l'environnement de développement

Eclipse

Avant de commencer :

  1. Installez la version 4.7 ou une version ultérieure d'Eclipse IDE for Java EE Developers :

    Télécharger Eclipse

  2. Si vous avez installé le plug-in Google pour Eclipse, suivez les procédures pour effectuer une migration à partir du plug-in Google pour Eclipse.

Installez le plug-in :

  1. Faites glisser le bouton d'installation vers votre espace de travail Eclipse en cours d'exécution :

    Faites-le glisser vers votre espace de travail Eclipse en cours d'exécution.

    Dans Eclipse, sélectionnez Help (Aide) > Eclipse Marketplace..., puis recherchez Google Cloud Tools for Eclipse.

  2. Redémarrez Eclipse lorsque vous y êtes invité.

IntelliJ

Avant de commencer :

  1. Connectez-vous à votre compte Google.

    Si vous n'en possédez pas déjà un, vous devez en créer un.

  2. Dans Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Cloud.

    Accéder à la page de sélection du projet

  3. Vérifiez que la facturation est activée pour votre projet Google Cloud. Découvrez comment vérifier que la facturation est activée pour votre projet.

  4. Assurez-vous que les logiciels suivants sont installés sur votre système local :

Installez le plug-in :

  1. Ouvrez IntelliJ IDEA (ou tout IDE JetBrains compatible).
  2. Sur la place de marché de plug-ins (File > Settings > Plugins (Fichier > Paramètres > Plug-ins) ou, pour macOS X, IntelliJ IDEA > Preferences > Plugins (IntelliJ IDEA > Préférences > Plug-ins)), recherchez le plug-in "Cloud Code" et installez-le.

    Vous serez peut-être invité à redémarrer votre IDE pour activer le plug-in.

  3. Configurez le JDK du projet :

    1. Cliquez sur File (Fichier) > Project Structure (Structure du projet).
    2. Sélectionnez Project Settings (Paramètres du projet) > Project (Projet).
    3. Si le JDK du projet ne s'affiche pas, cliquez sur New... (Nouveau), puis sélectionnez-en un.

Gradle

  1. Installez Gradle v3.4.1 ou version ultérieure.

  2. Installer git

Maven

  1. Téléchargez Maven 3.5 depuis le site Web Maven.

  2. Installez Maven 3.5 sur votre ordinateur local.

Créer un projet App Engine

Eclipse

  1. Dans la barre d'outils Google Cloud Platform, cliquez sur le bouton .

  2. Sélectionnez Create New Project (Créer un projet) > Google App Engine Standard Java Project (Projet Java dans l'environnement standard Google App Engine).

  3. Saisissez le nom du projet dans le champ Project name, et éventuellement un package Java.

  4. Pour créer un projet App Engine basé sur Maven, cochez la case Create as Maven Project (Créer en tant que projet Maven), puis saisissez respectivement l'ID du groupe Maven et l'ID d'artefact dans les champs Group ID et Artifact ID.

  5. Sélectionnez les bibliothèques dont vous avez besoin dans le projet : API App Engine, Google Cloud Endpoints et/ou Objectify.

  6. Cliquez sur Finish (Terminer).

L'assistant génère un projet Eclipse natif, avec un servlet simple que vous pouvez exécuter et déployer à partir de l'environnement de développement intégré (IDE).

IntelliJ

  1. Sélectionnez File (Fichier) > New (Nouveau) > Project (Projet) pour afficher la boîte de dialogue New Project (Nouveau projet).

  2. Dans le panneau de gauche, sélectionnez Java.

  3. Dans la section Additional Libraries and Frameworks (Plus de bibliothèques et de frameworks), cochez la case Google App Engine pour votre environnement.

    Nouveau projet Java avec

  4. Sélectionnez les bibliothèques supplémentaires que vous souhaitez ajouter au chemin d'accès des classes de votre application. L'API Servlet est sélectionnée par défaut.

  5. Cliquez sur Suivant.

  6. Saisissez le nom du projet dans le champ Project name.

  7. Saisissez la zone du projet dans le champ Project location si vous ne souhaitez pas conserver la valeur par défaut.

  8. Mettez à jour les champs de la section More Settings (Plus de paramètres) si vous ne souhaitez pas conserver les valeurs par défaut.

  9. Cliquez sur Terminer.

Gradle

  1. Créez un répertoire.

  2. Initialisez le nouveau projet dans le répertoire créé :

    gradle init --type java-library;
    mkdir -p src/main/webapp/WEB-INF;
    rm src/main/java/Library.java src/test/java/LibraryTest.java
    

    Gradle crée une structure de répertoire squelette avec deux classes vides qui sont supprimées dans la commande rm finale.

  3. Insérez les lignes suivantes dans le fichier build.gradle pour ajouter des tâches Gradle pour App Engine, des dépôts Maven, le plug-in Gradle pour App Engine, des dépendances et la configuration des tâches :

    buildscript {      // Configuration for building
      repositories {
        jcenter()      // Bintray's repository - a fast Maven Central mirror & more
        mavenCentral()
      }
      dependencies {
        classpath 'com.google.cloud.tools:appengine-gradle-plugin:2.2.0' // Latest 1.x.x release
        classpath 'org.akhikhl.gretty:gretty:+'
      }
    }
    
    repositories {   // repositories for JARs you access in your code
      maven {
        url 'https://maven-central.storage.googleapis.com'             // Google's mirror of Maven Central
      }
    
    //maven {
    //  url 'https://oss.sonatype.org/content/repositories/snapshots' // SNAPSHOT repository if needed
    //}
    
      jcenter()
      mavenCentral()
    }
    
    apply plugin: 'java'
    apply plugin: 'war'
    apply plugin: 'org.akhikhl.gretty'
    apply plugin: 'com.google.cloud.tools.appengine'
    
    dependencies {
      providedCompile 'javax.servlet:javax.servlet-api:3.1.0'
      providedCompile 'com.google.appengine:appengine:+'
    // Add your dependencies here.
    
    }
    
    gretty {
        httpPort = 8080
        contextPath = '/'
        servletContainer = 'jetty9'  // What App Engine Flexible uses
    }
    
    appengine {
    
      deploy {   // deploy configuration
        stopPreviousVersion = true  // default - stop the current version
        promote = true              // default - & make this the current version
        projectId = 'GCLOUD_CONFIG' // delegate to project in gcloud config
        version = 'GCLOUD_CONFIG'   // delegate to gcloud to generate a version
      }
    
    }
    
    group = 'com.example.appengine'   // Generated output GroupId
    version = '1.0-SNAPSHOT'          // Version in generated output
    
    sourceCompatibility = 1.8
    targetCompatibility = 1.8

Maven

Pour créer une application App Engine :

  1. Créez un répertoire.

  2. Initialisez le nouveau projet dans le répertoire créé :

     mvn archetype:generate -Dappengine-version=1.9.59 -Djava8=true -DCloudSDK_Tooling=true -Dapplication-id=your-app-id -Dfilter=com.google.appengine.archetypes:
    
    1. Définissez l'option -Dappengine-version sur la version la plus récente du SDK App Engine pour Java, et l'option application-id sur l'ID de votre projet Cloud.

    2. Définissez l'option -Djava8=true pour déployer le projet dans l'environnement d'exécution Java 8.

    3. Définissez l'option -DCloudSDK_Tooling=true pour utiliser les outils du SDK Cloud.

  3. Lorsque vous êtes invité à choisir un archétype, choisissez la valeur 2 pour l'archétype du squelette App Engine. Cela crée un projet vide contenant la structure de répertoire et les fichiers requis.

  4. Lorsque vous êtes invité à indiquer la version, appuyez sur Entrée pour sélectionner la version la plus récente par défaut.

  5. Lorsque l'invite Define value for property 'groupId' s'affiche, indiquez l'espace de noms souhaité pour l'application. par exemple com.mycompany.myapp.

  6. Lorsque l'invite Define value for property 'artifactId' s'affiche, indiquez le nom du projet, par exemple myapp.

  7. Lorsque l'invite Define value for property 'version' s'affiche, acceptez la valeur par défaut.

  8. Lorsque l'invite Define value for property 'package' s'affiche, indiquez le nom du package souhaité (ou acceptez le nom par défaut). Les fichiers Java générés portent le nom du package que vous spécifiez ici.

  9. Lorsque vous êtes invité à confirmer vos choix, acceptez la valeur par défaut (Y).

  10. Attendez la fin de la génération du projet, puis remplacez les répertoires par le nouveau répertoire du projet, par exemple myapp/.

  11. Ajoutez le plug-in basé sur le SDK Cloud au fichier pom.xml de votre projet.

    <build>
        <plugins>
           [...]
              <plugin>
                <groupId>com.google.cloud.tools</groupId>
                <artifactId>appengine-maven-plugin</artifactId>
                <version>1.3.1</version>
                <configuration>
                    <project>your-project-ID-goes-here</project>
                    <version>1</version>
                </configuration>
              </plugin>
           [...]
        </plugins>
    </build>
    
  12. Spécifiez l'ID du projet Google Cloud Platform cible, ainsi que le service et la version dans la configuration du plug-in.

Accorder une autorisation à Cloud Build

Lorsque vous déployez votre application, App Engine utilise Cloud Build pour créer l'application dans un conteneur et déployer ce conteneur dans l'environnement d'exécution. Par défaut, Cloud Build n'est pas autorisé à déployer des applications Java 8. Vous devez donc accorder à Cloud Build l'autorisation de déployer des applications dans votre projet.

Étape suivante

Une fois l'environnement de développement configuré, vous pouvez commencer à développer et déployer des applications Java sur App Engine.