Como usar o Gradle e o plug-in do App Engine

O Gradle é uma ferramenta de automação de criação de código aberto focada em flexibilidade e desempenho. O App Engine fornece um plug-in do Gradle para criar e implantar o aplicativo nessa plataforma. Os exemplos de código neste guia usam o Gradle versão 8.

O exemplo de código demonstra como configurar o arquivo build.gradle para adicionar tarefas do Gradle do App Engine, repositórios Maven, o plug-in do Gradle do App Engine e dependências para Java 8. Para o Java versão 11 e mais recentes, consulte Ambiente de execução do Java para mais informações sobre como usar versões mais recentes.

Antes de começar

  1. Instale o Java

  2. Instalar o Gradle

  3. Instale o Git

  4. Se ainda não tiver feito isso, siga as etapas neste guia para fazer o download da CLI gcloud, criar seu projeto do Google Cloud e inicializar seu aplicativo do App Engine.

  5. Instale o componente app-engine-java da CLI gcloud:

    gcloud components install app-engine-java

Crie um novo projeto do Gradle

É possível criar um novo projeto do Gradle do zero usando o shell. Como alternativa, para testar o plug-in, é possível fazer o download, executar localmente e implantar o projeto "Hello, World".

Para criar um novo projeto:

  1. Crie um novo diretório e navegue até ele.

  2. Para inicializar um novo projeto:

    1. Execute gradle init:

      gradle init --type java-application

      Você vai precisar responder a perguntas:

      • Insira a versão do Java de destino (mínima: 7, padrão: 21): 21
      • Selecione a estrutura do aplicativo: 1 para projeto de aplicativo único
      • Selecione a DSL do script de build: 2 (para Groovy)
      • Selecione a estrutura de teste: 1 (para o JUnit 4)
      • Gerar build usando novas APIs e comportamento: não

    2. Crie a pasta WEB-INF:

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

    3. Crie a pasta appengine:

      mkdir -p app/src/main/appengine

  3. Remova os arquivos de stub gerados por gradle init:

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

  4. Adicione os seguintes elementos ao seu arquivo app/build.gradle para adicionar tarefas do Gradle do App Engine, repositórios Maven, o plug-in do Gradle do App Engine, dependências e a configuração de tarefas: 

    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.5.0'
    classpath 'org.akhikhl.gretty:gretty:+'
  }
}

repositories {   // repositories for Jar's you access in your code
  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 {
    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
    }
  }

group = 'com.example.appengine'   // Generated output GroupId
version = '1.0-SNAPSHOT'          // Version in generated output

sourceCompatibility = 1.8
targetCompatibility = 1.8

  5. Você também precisa adicionar ao projeto os arquivos abaixo, usando um editor de texto ou um ambiente de desenvolvimento integrado (IDE, na sigla em inglês):

Consulte Configurar o ambiente de desenvolvimento para ter uma visão geral de um projeto Java do App Engine.

faça o download do app Hello World

  1. Clone o repositório do app de amostra Hello World na máquina local:

    git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git

    Também é possível fazer o download da amostra como um arquivo zip e extraí-lo.

  2. Acesse o diretório que contém o código de amostra:

    cd java-docs-samples/flexible/java-8/helloworld

Como testar o aplicativo com o servidor de desenvolvimento

  1. Em seu projeto, para acessar os recursos do Google durante a execução local, configure as credenciais padrão do aplicativo executando:

    gcloud auth application-default login

  2. Mude para a raiz do diretório do aplicativo.

  3. Durante a fase de desenvolvimento, é possível executar e testar o aplicativo a qualquer momento no servidor de desenvolvimento invocando o Gradle:

    gradle jettyRun

    Você também pode executar o Gradle sem instalá-lo, basta usar o wrapper do Gradle.

  4. Aguarde a inicialização do servidor. O servidor é iniciado com o aplicativo em execução, quando você vê uma mensagem semelhante a esta:

    :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. Veja o app em execução em http://localhost:8080.

Para saber mais sobre o plug-in do Gretty, consulte as configuração do Gretty e as tarefas do Gretty.

Implantar aplicativo

Para implantar o aplicativo:

gradle appengineDeploy

A tarefa appengineDeploy e todas as outras tarefas do Gradle têm propriedades associadas que podem ser usadas. Para uma lista completa de tarefas e propriedades, consulte as tarefas e propriedades do Gradle do App Engine.

Usar o wrapper do Gradle

O Gradle oferece um mecanismo para download e execução da versão obrigatória dele sem instalação:

Linux/macOS

  1. Mude para o diretório do código de amostra.

  2. Execute gradlew:

    ./gradlew jettyRun

Windows

  1. Mude para o diretório do código de amostra.

  2. Execute gradlew:

    ./gradlew.bat jettyRun

Informações extras sobre o Gradle podem ser encontradas em tarefas e propriedades do Gradle do App Engine.

A seguir