Migrazione al plug-in Gradle basato sullgcloud CLI

Se in precedenza utilizzavi il plug-in basato su Java App Engine SDK (com.google.appengine.appengine-gradle) e vuoi passare al nuovo Google Cloud CLI, esegui la migrazione al plug-in basato su gcloud CLI (com.google.cloud.tools.appengine-gradle).

Vantaggi del plug-in basato sullgcloud CLI

L'upgrade al nuovo plug-in offre i seguenti vantaggi:

  • Utilizza le stesse credenziali di autenticazione di tutti gli altri comandi basati su gcloud CLI, che vengono generati dal flusso gcloud auth login standard.

  • Supporta l'ambiente flessibile di App Engine.

  • Aggiorna automaticamente il server di sviluppo locale nell'ambito del flusso di aggiornamento standard gcloud CLI.

  • Supporta il deployment delle configurazioni del servizio App Engine (cron, code di attesa, dos, invio), indipendentemente dal servizio.

Differenze significative

Prima di eseguire la migrazione, tieni presente queste differenze significative:

dipendenza dellgcloud CLI
Il vecchio plug-in viene eseguito senza dipendenze specifiche dell'ambiente locale, oltre a Java, ma il nuovo plug-in richiede l'installazione dell'interfaccia alla gcloud CLI
Nessuna generazione di documenti di rilevamento di Endpoints
Il nuovo plug-in non genera documenti di rilevamento degli endpoint, una funzionalità disponibile in un plug-in separato. L'esecuzione del backend di Endpoints non richiede più la generazione di questo file in un passaggio di compilazione, poiché ora il server lo genera in fase di esecuzione. Devi utilizzare il nuovo plug-in solo se devi generare librerie client, ad esempio per iOS o Android. Scopri di più sui nuovi plug-in consultando la guida Eseguire la migrazione ai framework Endpoints per App Engine.
Il formato file EAR non è più supportato
Il nuovo plug-in non supporta più il formato file EAR per l'esecuzione e il deployment di più servizi contemporaneamente.
Nuovo comando di deployment
Il vecchio plug-in chiama il comando appcfg per eseguire il deployment delle applicazioni, mentre il nuovo esegue il deployment utilizzando la nuova interfaccia a riga di comando gcloud.
Il miglioramento Datanucleus JPA/JDO deve essere configurato manualmente
Se il tuo progetto utilizza il miglioramento JPA/JDO Datanucleus di gradle-appengine-plugin, devi configurare manualmente il miglioramento Datanucleus dopo il passaggio al plug-in basato sulla gcloud CLI. Guarda un esempio di Stackoverflow.
Android Studio non è supportato
Puoi impostare il progetto Android Studio in modo che utilizzi il nuovo plug-in, ma il supporto per il server di sviluppo e il deployment di App Engine di Android Studio non funziona con questo nuovo plug-in. Per eseguire ed eseguire il deployment dell'app, devi invocare direttamente Gradle.

L'utilizzo di file di configurazione XML è supportato, ma non YAML.

Migrazione al nuovo plug-in

  1. Rimuovi la vecchia configurazione e le importazioni gradle-appengine-plugin dal file build.gradle.

  2. Aggiungi il nuovo plug-in alla sezione buildscript del file build.gradle:classpath

    buildscript {
        repositories {
            mavenCentral()
        }
    
        dependencies {
            classpath 'com.google.cloud.tools:appengine-gradle-plugin:2.0.1'
        }
    }
    
  3. Nella directory principale del servizio, esegui il seguente comando per verificare di poter eseguire l'app localmente:

    gradle appengineRun
    
  4. Nella sezione buildscript del file build.gradle, configura il deployment specificando l'ID progetto e la versione:

    appengine {
        deploy {
            version = 'v1'
            project = "your GCP project ID"
        }
    }
    

    I nuovi strumenti ignorano gli elementi di applicazione e versione nel file appengine-web.xml.

  5. Nella directory principale del servizio, esegui il seguente comando per verificare di poter eseguire il deployment dell'applicazione:

    gradle appengineDeploy
    

Migrazione di configurazioni multiservizio basate su EAR

Il nuovo plug-in non supporta il packaging EAR. Supporta invece l'esecuzione di più servizi localmente senza alcuna procedura di imballaggio speciale.

Per eseguire la migrazione del progetto Gradle basato su EAR:

  1. Scegli un servizio principale che sarà responsabile dell'esecuzione del resto dei servizi. Devi selezionare il servizio predefinito, ma può essere qualsiasi servizio eseguito insieme.

  2. Nella configurazione appengine, modifica la voce run.services in modo da includere tutti i servizi che devono essere eseguiti dal server di sviluppo locale.

    Un esempio di struttura di progetto:

    ../{projectRoot}/
      build.gradle
      settings.gradle (includes default-service & secondary-service)
           {your-default-service}/build.gradle {includes appengine-gradle-plugin}
              .
           {your-default-service}/src/main/webapp/WEB-INF/appengine-web.xml
           {your-secondary-service}build.gradle {includes appengine-gradle-plugin}
              .
           {your-secondary-service}/src/main/webapp/WEB-INF/appengine-web.xml
    

    Un buildscript build.gradle di esempio:

    appengine {
        run {
            // configure the app to point to the right service directories
            services = [
                    projectAsService(project),
                    projectAsService(":another-module")
            ]
        }
    }
    
    // helper method to obtain correct directory and set up dependencies
    def getExplodedAppDir(Project serverProject) {
        // if not 'this' module, then do some setup.
        if (serverProject != project) {
            // make sure we evaluate other modules first so we get the right value
            evaluationDependsOn(serverProject.path)
            // make sure we build "run" depends on the other modules exploding wars
            project.tasks.appengineRun.dependsOn serverProject.tasks.explodeWar
        }
        return serverProject.tasks.explodeWar.explodedAppDirectory
    }
    

Comandi Gradle basati su SDK App Engine e comandi Gradle basati sull&#gcloud CLI

La tabella seguente mostra i diversi modi per richiamare il plug-in Gradle, a seconda che tu utilizzi il plug-in Gradle basato sull'SDK App Engine o il plug-in Gradle basato sulla CLI gcloud.

Azione Basato sull'SDK di App Engine Basato sull'interfaccia a riga di comando gcloud CLI
Esegui l'app localmente appengine:devserver appengineRun
Esegui il deployment di una nuova app, versione o servizio. appengine:update appengineDeploy
Imposta la versione dell'applicazione predefinita. appengine:set_default_version gcloud app services set-traffic o gcloud app versions migrate
Aggiorna i cron job dell'applicazione. appengine:update_cron appengineDeployCron
Aggiorna la configurazione di invio dell'applicazione. appengine:update_dispatch appengineDeployDispatch
Aggiorna la configurazione della protezione DoS dell'applicazione. appengine:update_dos appengineDeployDos
Aggiorna le definizioni della coda di attività dell'applicazione. appengine:update_queues appengineDeployQueue
Aggiorna gli indici Datastore. appengine:update_indexes appengineDeployIndex
Elimina gli indici inutilizzati dall'applicazione. appengine:vacuum_indexes gcloud datastore indexes cleanup
Avvia la versione del modulo specificata. appengine:start_module_version gcloud app versions start
Interrompi la versione del modulo specificata. appengine:stop_module_version gcloud app versions stop
Esegui il rollback di un aggiornamento in corso. appengine:rollback gcloud app versions start, gcloud app versions stop

Passaggi successivi

  • Ora che hai eseguito correttamente la migrazione al nuovo plug-in, puoi testare e deploy la tua applicazione.