Utiliser Gradle et le plug-in App Engine

Gradle est un outil Open Source d'automatisation de la compilation axé sur la flexibilité et les performances. App Engine fournit un plug-in Gradle que vous pouvez utiliser pour créer et déployer votre application sur App Engine.

Avant de commencer

  1. Installer Java

  2. Installer Gradle

  3. Installer git

  4. Si vous ne l'avez pas déjà fait, suivez la procédure de ce guide pour télécharger gcloud CLI, créer votre projet Google Cloud et initialiser votre application App Engine.

  5. Installez le composant gcloud CLI app-engine-java :

    gcloud components install app-engine-java

Créer un projet Gradle

Vous pouvez créer entièrement un projet Gradle à l'aide de l'interface système. Pour essayer le plug-in, vous pouvez également télécharger, exécuter en local et déployer le projet hello world.

Pour créer un projet :

  1. Créez un nouveau répertoire et accédez à celui-ci.

  2. Pour initialiser un nouveau projet :

    1. Exécutez gradle init :

      gradle init --type java-application

      Vous devrez répondre aux questions suivantes :

      • Saisissez la version Java cible (min : 7, par défaut : 21) : 21
      • Sélectionnez la structure de l'application : 1 pour un projet d'application unique
      • Sélectionnez le DSL du script de compilation : 2 (pour Groovy)
      • Sélectionnez le framework de test : 1 (pour JUnit 4)
      • Générez une compilation à l'aide de nouvelles API et de nouveaux comportements : non

    2. Créez le dossier WEB-INF :

      mkdir -p app/src/main/webapp/WEB-INF

    3. Créez le dossier appengine :

      mkdir -p app/src/main/appengine

  3. Supprimez les fichiers de simulation générés par gradle init :

    rm ./app/src/main/java/org/example/App.java ./app/src/test/java/org/example/AppTest.java

  4. Insérez les lignes suivantes dans le fichier app/build.gradle afin d'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 : 

    apply plugin: 'java'
apply plugin: 'war'

buildscript {
    repositories {
        // gretty plugin is in Maven Central
        mavenCentral()
    }
    dependencies {
        classpath 'com.google.cloud.tools:appengine-gradle-plugin:2.8.1'
        classpath 'org.gretty:gretty:4.1.5'
    }
}
apply plugin: 'org.gretty'
apply plugin: 'com.google.cloud.tools.appengine'

repositories {
    mavenCentral()
}

appengine {
    deploy {   // deploy configuration
        stopPreviousVersion = true  // default - stop the current version
        promote = true              // default - & make this the current version
        projectId = 'GCLOUD_CONFIG'
        version = 'GCLOUD_CONFIG'
    }
}

sourceSets {
    // In Gradle 8, the default location is app/src/java, which does not match
    // Maven's directory structure.
    main.java.srcDirs = ['src/main/java']
    main.resources.srcDirs = ['src/main/resources', 'src/main/webapp']
    test.java.srcDirs = ['src/test/java']
}

dependencies {
    implementation 'com.google.appengine:appengine-api-1.0-sdk:2.0.30'
    implementation 'jakarta.servlet:jakarta.servlet-api:6.1.0'

    // Test Dependencies
    testImplementation 'com.google.appengine:appengine-testing:2.0.30'
    testImplementation 'com.google.appengine:appengine-api-stubs:2.0.30'
    testImplementation 'com.google.appengine:appengine-tools-sdk:2.0.30'

    testImplementation 'com.google.truth:truth:1.1.5'
    testImplementation 'junit:junit:4.13.2'
    testImplementation 'org.mockito:mockito-core:4.11.0'
}

  5. Vous devez également ajouter les fichiers suivants à votre projet, à l'aide d'un éditeur de texte ou d'un environnement de développement intégré (IDE) :

Pour découvrir une présentation du projet Java App Engine, consultez la page Configurer votre environnement de développement.

Tester votre application avec un serveur de développement

  1. Pour accéder aux ressources Google de votre projet lors de l'exécution en local, définissez les identifiants par défaut de l'application en exécutant la commande suivante :

    gcloud auth application-default login

  2. Accédez à la racine du répertoire de votre application.

  3. À tout moment pendant la phase de développement, vous pouvez exécuter et tester votre application sur le serveur de développement en appelant Gradle, à l'aide de la commande suivante :

    gradle jettyRun

    Vous pouvez également exécuter Gradle sans l’installer à l’aide du wrapper Gradle.

  4. Attendez que le serveur démarre. Une fois le serveur démarré et votre application en cours d'exécution, un message semblable à celui-ci s'affiche :

    :prepareInplaceWebAppFolder
:createInplaceWebAppFolder
:compileJava
:processResources UP-TO-DATE
:classes
:prepareInplaceWebAppClasses
:prepareInplaceWebApp
:jettyRun
17:40:05 INFO  Jetty 9.2.15.v20160210 started and listening on port 8080
17:40:05 INFO   runs at:
17:40:05 INFO    http://localhost:8080/

  5. Accédez à l'adresse http://localhost:8080 pour visualiser l'exécution de votre application.

Pour en savoir plus sur le plug-in Gretty, consultez les sections Gretty Configuration (Configuration Gretty) et Gretty tasks (Tâches Gretty).

Déployer votre application

Pour déployer votre application, procédez comme suit :

gradle appengineDeploy

La tâche appengineDeploy et toutes les autres tâches Gradle sont associées à des propriétés que vous pouvez utiliser. Pour obtenir la liste complète des tâches et des propriétés disponibles, consultez la page Tâches et propriétés Gradle pour App Engine.

Utiliser le wrapper Gradle

Gradle fournit un mécanisme permettant de télécharger et exécuter la version requise de Gradle sans l'installer :

Linux/macOS

  1. Accédez au répertoire de l'exemple de code :

  2. Exécutez gradlew :

    ./gradlew jettyRun

Windows

  1. Accédez au répertoire de l'exemple de code :

  2. Exécutez gradlew :

    ./gradlew.bat jettyRun

Pour en savoir plus sur Gradle, consultez la section Tâches et propriétés Gradle pour App Engine.

Étapes suivantes