Crea una app de Java en el entorno flexible de App Engine

Crea una app de Java en el entorno flexible de App Engine

ID de región

REGION_ID es un código abreviado que Google asigna en función de la región que eliges cuando creas la app. El código no corresponde a un país ni a una provincia, aunque algunos ID de región puedan parecer similares a los códigos de país y provincia que se suelen usar. En el caso de las apps creadas después de febrero de 2020, REGION_ID.r se incluye en las URL de App Engine. En el caso de las apps existentes creadas antes de esta fecha, el ID de región es opcional en la URL.

Obtén más información acerca de los ID de región.

Aceptar

En esta guía de inicio rápido, se muestra cómo crear e implementar una app que muestra un mensaje corto. La aplicación de muestra usa la versión 17 de Java.

Las muestras de código para la versión 8 y la versión 11 de Java están disponibles en GitHub.

Antes de comenzar

En esta guía de inicio rápido, se supone que instalaste el kit de desarrollo de Java SE 17 (JDK) en tu máquina local.

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Cloud Build API.

   Enable the API

5. Install the Google Cloud CLI.

6. To initialize the gcloud CLI, run the following command:

   gcloud init

7. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

8. Make sure that billing is enabled for your Google Cloud project.

9. Enable the Cloud Build API.

   Enable the API

10. Install the Google Cloud CLI.

11. To initialize the gcloud CLI, run the following command:

    gcloud init

Requisitos previos adicionales

1. Inicializa tu app de App Engine con el proyecto y selecciona su región:

   gcloud app create --project=[YOUR_PROJECT_ID]
   

   Cuando se te solicite, selecciona la región en la que deseas ubicar tu aplicación de App Engine.

   Precaución: No podrás cambiar la región de una aplicación una vez configurada.

2. Instala los siguientes requisitos:

   • Descarga e instala Git.
   • Descarga e instala Maven 3.5 o versiones posteriores. En esta guía de inicio rápido, se usa la versión 3.5 o versiones posteriores de Apache Maven para compilar y ejecutar la app de muestra en tu computadora.

Ubicaciones de App Engine

App Engine es regional, lo que significa que la infraestructura que ejecuta las apps se encuentra en una región específica, y Google la administra para que esté disponible de forma redundante en todas las zonas dentro de esa región.

El cumplimiento de tus requisitos de latencia, disponibilidad o durabilidad debe ser un factor principal para seleccionar la región en la que se ejecutan las apps. Por lo general, puedes seleccionar la región más cercana a la de los usuarios de la app, pero debes considerar las ubicaciones en las que App Engine está disponible y las ubicaciones de los otros productos y servicios de Google Cloud que usa la app. Usar servicios en varias ubicaciones puede afectar la latencia de la app y sus precios.

No puedes cambiar la región de una app una vez configurada.

Nota: Dos ubicaciones, que se llaman europe-west y us-central en los comandos de App Engine y en la consola de Google Cloud, se denominan europe-west1 y us-central1, respectivamente, en otra documentación de Google.

Si ya creaste una aplicación de App Engine, puedes ver su región mediante una de las siguientes opciones:

• Ejecuta el comando gcloud app describe.

• Abre el Panel de App Engine en la consola de Google Cloud. La región aparece cerca de la parte superior de la página.

Aceptar

Descarga la app de Hello World

Creamos una app de Hello World simple para App Engine a fin de que puedas familiarizarte con rapidez con la implementación de una app en Google Cloud.

1. Clona el repositorio de la app Hello World de muestra al equipo local.

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

   De manera opcional, puedes descargar la muestra como un archivo ZIP y extraerla.

2. Cambia al directorio que contiene el código de muestra.

      cd java-docs-samples/flexible/java-17/micronaut-helloworld
   

Ejecuta Hello World en tu máquina local

Para ejecutar la app de Hello World en la computadora local, haz lo siguiente:

1. Ejecuta el comando siguiente:

   java -jar target/micronaut-helloworld-0.1.jar

2. En el navegador web, ingresa la siguiente dirección:

   http://localhost:8080

   Si usas Cloud Shell, en la barra de herramientas, haz clic en Vista previa en la Web y selecciona Vista previa en el puerto 8080 en su lugar.

El mensaje de Hello World de la aplicación de muestra se ve en la página. En la ventana de la terminal, presiona Ctrl + C para salir del servidor web.

Implemente y ejecute Hello World en App Engine

Para implementar la app en el entorno flexible de App Engine, haz lo siguiente:

1. Implementa la app de Hello World mediante la ejecución del siguiente comando desde el directorio java-17/micronaut-helloworld:

   mvn clean package appengine:deploy

2. Inicia tu navegador para ver la app en https://PROJECT_ID.REGION_ID.r.appspot.com.

   gcloud app browse

   donde PROJECT_ID representa el ID del proyecto de Google Cloud.

Esta vez, la página que muestra el mensaje Hello World se envía mediante un servidor web que se ejecuta en una instancia de App Engine.

¡Felicitaciones! Implementaste la primera aplicación de App Engine en el entorno flexible de App Engine.

Si encontraste algún error cuando implementaste la aplicación, consulta las sugerencias para solucionar problemas.

Consulta las secciones siguientes para obtener información sobre la limpieza y vínculos a los próximos pasos que podrías realizar.

Realiza una limpieza

Para evitar que se apliquen cargos a la cuenta, puedes borrar el proyecto de Google Cloud y detener la facturación de todos los recursos que usa.

Precaución: Borrar un proyecto tiene las siguientes consecuencias:
• Se borra todo en el proyecto. Si usaste un proyecto existente para las tareas de este documento, cuando lo borres, también se borrará cualquier otro trabajo que hayas realizado en el proyecto.
• Se pierden los ID personalizados de proyectos. Cuando creaste este proyecto, es posible que hayas creado un ID del proyecto personalizado que desees utilizar en el futuro. Para conservar las URL que utilizan el ID del proyecto, como una URL appspot.com, borra los recursos seleccionados dentro del proyecto en lugar de borrar todo el proyecto.
1. In the Google Cloud console, go to the Manage resources page.

   Go to Manage resources

2. In the project list, select the project that you want to delete, and then click Delete.
3. In the dialog, type the project ID, and then click Shut down to delete the project.

¿Qué sigue?

Conoce toda la plataforma

Ahora que sabes cómo implementar y desarrollar apps en App Engine, puedes explorar el resto de Google Cloud. Ya instalaste Google Cloud CLI, que te brinda las herramientas para interactuar con productos como Cloud SQL, Cloud Storage, Firestore y muchos otros.

Aprende sobre el entorno flexible de App Engine

Aquí hay algunos temas para ayudarte a continuar tu aprendizaje sobre App Engine.

• Descripción general de App Engine
• Solicita enrutamiento
• Administra solicitudes
• Administra instancias

Revisión del código de Hello World

Hello World es la aplicación de App Engine más simple que pueda existir, dado que solo contiene un servicio, una versión y todo el código se ubica dentro del directorio raíz de la app. En esta sección, se describe en detalle cada archivo de la app.

HelloControllerTest.java

El archivo HelloControllerTest.java especifica un patrón URL que describe dónde la app detectará solicitudes y responde a todas ellas con el mensaje “Hello World”.

/*
 * Copyright 2023 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.example.appengine;

import static org.junit.Assert.assertEquals;

import io.micronaut.context.ApplicationContext;
import io.micronaut.http.HttpRequest;
import io.micronaut.http.client.HttpClient;
import io.micronaut.runtime.server.EmbeddedServer;
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.junit.Test;

public class HelloControllerTest {
  private static EmbeddedServer server;
  private static HttpClient client;

  @BeforeClass
  public static void setupServer() {

    server = ApplicationContext.run(EmbeddedServer.class);

    client = server.getApplicationContext().createBean(HttpClient.class, server.getURL());
  }

  @AfterClass
  public static void stopServer() {
    if (client != null) {
      client.stop();
    }
    if (server != null) {
      server.stop();
    }
  }

  @Test
  public void testHelloWorldResponse() {
    String response = client.toBlocking().retrieve(HttpRequest.GET("/"));
    assertEquals("Hello World!", response);
  }
}

app.yaml

El archivo app.yaml describe la siguiente configuración para tu app:

• Configura env: flex, lo que indica que tu app usa el entorno flexible de App Engine.

• Especifica el entorno de ejecución que usa la app.

  runtime: java
  env: flex
  runtime_config:
    operating_system: ubuntu22
    runtime_version: 17
  handlers:
  - url: /.*
    script: this field is required, but ignored
  
  manual_scaling:
    instances: 1

  • Para obtener más información sobre el funcionamiento del entorno de ejecución de Java, consulta El entorno de ejecución de Java.

  pom.xml

  Hello World también incluye un archivo pom.xml, que contiene información sobre el proyecto, como sus dependencias y el destino de la compilación.

  <?xml version="1.0" encoding="UTF-8"?>
  <!--
    Copyright 2023 Google LLC
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
         http://www.apache.org/licenses/LICENSE-2.0
    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
  -->
  <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example.appengine.flexible</groupId>
    <artifactId>micronaut-helloworld</artifactId>
    <version>0.1</version>
  
    <!--
    The parent pom defines common style checks and testing strategies for our samples.
    Removing or replacing it should not affect the execution of the samples in anyway.
    -->
    <parent>
        <groupId>com.google.cloud.samples</groupId>
        <artifactId>shared-configuration</artifactId>
        <version>1.2.0</version>
    </parent>
  
    <properties>
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      <exec.mainClass>com.example.appengine.Application</exec.mainClass>
      <maven.compiler.target>11</maven.compiler.target>
      <maven.compiler.source>11</maven.compiler.source>
      <micronaut.version>3.10.3</micronaut.version>
    </properties>
  
    <dependencies>
      <dependency>
        <groupId>io.micronaut</groupId>
        <artifactId>micronaut-inject</artifactId>
        <version>${micronaut.version}</version>
        <scope>compile</scope>
      </dependency>
      <dependency>
        <groupId>io.micronaut</groupId>
        <artifactId>micronaut-validation</artifactId>
        <version>${micronaut.version}</version>
        <scope>compile</scope>
      </dependency>
      <dependency>
        <groupId>io.micronaut</groupId>
        <artifactId>micronaut-runtime</artifactId>
        <version>${micronaut.version}</version>
        <scope>compile</scope>
      </dependency>
      <dependency>
        <groupId>io.micronaut</groupId>
        <artifactId>micronaut-http-client</artifactId>
        <version>${micronaut.version}</version>
        <scope>compile</scope>
      </dependency>
      <dependency>
        <groupId>javax.annotation</groupId>
        <artifactId>javax.annotation-api</artifactId>
        <version>1.3.2</version>
        <scope>compile</scope>
      </dependency>
      <dependency>
        <groupId>io.micronaut</groupId>
        <artifactId>micronaut-http-server-netty</artifactId>
        <version>${micronaut.version}</version>
        <scope>compile</scope>
      </dependency>
      <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.13.2</version>
        <scope>test</scope>
      </dependency>
    </dependencies>
  
    <build>
      <plugins>
        <plugin>
          <groupId>com.google.cloud.tools</groupId>
          <artifactId>appengine-maven-plugin</artifactId>
          <version>2.8.0</version>
          <configuration>
            <projectId>GCLOUD_CONFIG</projectId>
            <version>micronaut-helloworld</version>
          </configuration>
        </plugin>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-shade-plugin</artifactId>
          <version>3.5.1</version>
          <executions>
            <execution>
              <phase>package</phase>
              <goals>
                <goal>shade</goal>
              </goals>
              <configuration>
                <transformers>
                  <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                    <mainClass>${exec.mainClass}</mainClass>
                  </transformer>
                  <transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
                </transformers>
              </configuration>
            </execution>
          </executions>
        </plugin>
        <plugin>
          <groupId>org.codehaus.mojo</groupId>
          <artifactId>exec-maven-plugin</artifactId>
          <version>3.1.1</version>
          <configuration>
            <executable>java</executable>
            <arguments>
              <argument>-noverify</argument>
              <argument>-XX:TieredStopAtLevel=1</argument>
              <argument>-Dcom.sun.management.jmxremote</argument>
              <argument>-classpath</argument>
              <classpath/>
              <argument>${exec.mainClass}</argument>
            </arguments>
          </configuration>
        </plugin>
        <plugin>
          <artifactId>maven-surefire-plugin</artifactId>
          <version>3.2.5</version>
        </plugin>
  
          <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.12.1</version>
            <configuration>
              <encoding>UTF-8</encoding>
              <compilerArgs>
                <arg>-parameters</arg>
              </compilerArgs>
              <annotationProcessorPaths>
                <path>
                  <groupId>io.micronaut</groupId>
                  <artifactId>micronaut-inject-java</artifactId>
                  <version>${micronaut.version}</version>
                </path>
                <path>
                  <groupId>io.micronaut</groupId>
                  <artifactId>micronaut-validation</artifactId>
                  <version>${micronaut.version}</version>
                </path>
              </annotationProcessorPaths>
            </configuration>
            <executions>
              <execution>
                <id>test-compile</id>
                <goals>
                  <goal>testCompile</goal>
                </goals>
                <configuration>
                  <compilerArgs>
                    <arg>-parameters</arg>
                  </compilerArgs>
                  <annotationProcessorPaths>
                    <path>
                      <groupId>io.micronaut</groupId>
                      <artifactId>micronaut-inject-java</artifactId>
                      <version>${micronaut.version}</version>
                    </path>
                    <path>
                      <groupId>io.micronaut</groupId>
                      <artifactId>micronaut-validation</artifactId>
                      <version>${micronaut.version}</version>
                    </path>
                  </annotationProcessorPaths>
                </configuration>
              </execution>
            </executions>
          </plugin>
        </plugins>
  
    </build>
  </project>
  

  • Para obtener más información sobre los archivos pom.xml, consulta la documentación de Maven.