Crea e implementa funciones de Cloud Run de HTTP con Java (1ª gen.)

En esta guía, se explica el proceso para escribir una función de Cloud Run a través del entorno de ejecución de Java. Existen dos tipos de funciones de Cloud Run:

• El primero, una función de HTTP, que se invoca a partir de solicitudes HTTP estándar.
• El segundo, una función basada en eventos, la cual se usa para controlar eventos de la infraestructura de nube, como mensajes en un tema de Pub/Sub o cambios en un bucket de Cloud Storage.

En el documento, se muestra cómo se debe crear una función de HTTP simple y cómo compilarla con Maven o Gradle.

Más información: Para obtener más detalles, lee sobre las funciones de HTTP y las funciones basadas en eventos.

Antes de comenzar

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.

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

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Functions and Cloud Build APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

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

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Functions and Cloud Build APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

1. Instala y, luego, inicializa el SDK de Google Cloud.
2. Instala y actualiza los componentes de gcloud:

   gcloud components update

Nota: ¿Necesitas un símbolo del sistema? Puedes usar Google Cloud Shell. Se trata de un entorno de línea de comandos que ya incluye el SDK de Google Cloud, por lo que no es necesario que lo instales. El SDK de Google Cloud también viene preinstalado en las máquinas virtuales de Google Compute Engine.
3. Prepara tu entorno de desarrollo.

   Ir a la guía de configuración de Java

Crea una función

En esta sección, se describe cómo crear una función.

Maven

1. Crea un directorio en tu sistema local para el código de función:

   Linux o MacOS X

    mkdir ~/helloworld
    cd ~/helloworld
   

   Windows:

    mkdir %HOMEPATH%\helloworld
    cd %HOMEPATH%\helloworld
   

2. Crea la estructura del proyecto para que contenga el directorio del código fuente y el archivo de origen.

   mkdir -p src/main/java/functions
   touch src/main/java/functions/HelloWorld.java
   

3. Agrega el contenido siguiente al archivo HelloWorld.java:

   
   package functions;
   
   import com.google.cloud.functions.HttpFunction;
   import com.google.cloud.functions.HttpRequest;
   import com.google.cloud.functions.HttpResponse;
   import java.io.BufferedWriter;
   import java.io.IOException;
   
   public class HelloWorld implements HttpFunction {
     // Simple function to return "Hello World"
     @Override
     public void service(HttpRequest request, HttpResponse response)
         throws IOException {
       BufferedWriter writer = response.getWriter();
       writer.write("Hello World!");
     }
   }

   Esta función de ejemplo genera el saludo “Hello World!”

Gradle

1. Crea un directorio en tu sistema local para el código de función:

   Linux o MacOS X

    mkdir ~/helloworld-gradle
    cd ~/helloworld-gradle
   

   Windows:

    mkdir %HOMEPATH%\helloworld-gradle
    cd %HOMEPATH%\helloworld-gradle
   

2. Crea la estructura del proyecto para que contenga el directorio del código fuente y el archivo de origen.

    mkdir -p src/main/java/functions
    touch src/main/java/functions/HelloWorld.java
   

3. Agrega el contenido siguiente al archivo HelloWorld.java:

   
   package functions;
   
   import com.google.cloud.functions.HttpFunction;
   import com.google.cloud.functions.HttpRequest;
   import com.google.cloud.functions.HttpResponse;
   import java.io.BufferedWriter;
   import java.io.IOException;
   
   public class HelloWorld implements HttpFunction {
     // Simple function to return "Hello World"
     @Override
     public void service(HttpRequest request, HttpResponse response)
         throws IOException {
       BufferedWriter writer = response.getWriter();
       writer.write("Hello World!");
     }
   }

   Esta función de ejemplo genera el saludo “Hello World!”

Especifica las dependencias

En el paso siguiente, se deben configurar las dependencias:

Maven

Cambia el directorio al directorio helloworld que creaste antes y crea un archivo pom.xml:

 cd ~/helloworld
 touch pom.xml

Para administrar las dependencias mediante Maven, especifícalas en la sección <dependencies> dentro del archivo pom.xml de tu proyecto. Para este ejercicio, copia el siguiente contenido en el archivo pom.xml.

<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.functions</groupId>
  <artifactId>functions-hello-world</artifactId>
  <version>1.0.0-SNAPSHOT</version>
  <properties>
    <maven.compiler.target>11</maven.compiler.target>
    <maven.compiler.source>11</maven.compiler.source>
  </properties>

  <dependencies>
    <!-- Required for Function primitives -->
    <dependency>
      <groupId>com.google.cloud.functions</groupId>
      <artifactId>functions-framework-api</artifactId>
      <version>1.1.0</version>
      <scope>provided</scope>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <!--
          Google Cloud Functions Framework Maven plugin

          This plugin allows you to run Cloud Functions Java code
          locally. Use the following terminal command to run a
          given function locally:

          mvn function:run -Drun.functionTarget=your.package.yourFunction
        -->
        <groupId>com.google.cloud.functions</groupId>
        <artifactId>function-maven-plugin</artifactId>
        <version>0.11.0</version>
        <configuration>
          <functionTarget>functions.HelloWorld</functionTarget>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

Consulta helloworld para obtener una muestra completa basada en Maven.

Gradle

Cambia el directorio al directorio helloworld-gradle que creaste antes y crea un archivo build.gradle:

 cd ~/helloworld-gradle
 touch build.gradle

Para administrar las dependencias mediante Gradle, especifica las dependencias en el archivo build.gradle de tu proyecto. Para este ejercicio, copia el siguiente contenido en el archivo build.gradle. Ten en cuenta que, en este archivo build.gradle, se incluye una tarea personalizada para ayudarte a ejecutar funciones a nivel local.

apply plugin: 'java'

repositories {
  jcenter()
  mavenCentral()
}
configurations {
    invoker
}

dependencies {
  // Every function needs this dependency to get the Functions Framework API.
  compileOnly 'com.google.cloud.functions:functions-framework-api:1.1.0'

  // To run function locally using Functions Framework's local invoker
  invoker 'com.google.cloud.functions.invoker:java-function-invoker:1.3.1'

  // These dependencies are only used by the tests.
  testImplementation 'com.google.cloud.functions:functions-framework-api:1.1.0'
  testImplementation 'junit:junit:4.13.2'
  testImplementation 'com.google.truth:truth:1.4.0'
  testImplementation 'org.mockito:mockito-core:5.10.0'

}

// Register a "runFunction" task to run the function locally
tasks.register("runFunction", JavaExec) {
  main = 'com.google.cloud.functions.invoker.runner.Invoker'
  classpath(configurations.invoker)
  inputs.files(configurations.runtimeClasspath, sourceSets.main.output)
  args(
    '--target', project.findProperty('run.functionTarget') ?: '',
    '--port', project.findProperty('run.port') ?: 8080
  )
  doFirst {
    args('--classpath', files(configurations.runtimeClasspath, sourceSets.main.output).asPath)
  }
}

Consulta helloworld-gradle para obtener una muestra completa basada en Gradle.

Más información: Para obtener más detalles, lee acerca de la especificación de dependencias.

Compila y prueba la función a nivel local

Antes de implementar la función, puedes compilarla y probarla a nivel local:

Maven

Para confirmar que tu función se compile, ejecuta el siguiente comando:

mvn compile

Otra opción es usar el comando mvn package para compilar tu código de Java, ejecutar pruebas y empaquetar el código en un archivo JAR dentro del directorio de destino. Puedes obtener más información sobre el ciclo de vida de compilación de Maven aquí.

Para probar la función, ejecuta el siguiente comando:

mvn function:run

Gradle

Para confirmar que tu función se compile, ejecuta el siguiente comando:

gradle build

Para probar la función, ejecuta el siguiente comando:

gradle runFunction -Prun.functionTarget=functions.HelloWorld

Si las pruebas se completan de forma correcta, se muestra la URL que puedes visitar en tu navegador web para ver la función en acción: http://localhost:8080/. Deberías ver un mensaje Hello World!.

Como alternativa, puedes enviar solicitudes a esta función con curl desde otra ventana de terminal:

curl localhost:8080
# Output: Hello World!

Implementa la función

Maven

Ejecuta el comando siguiente en el directorio helloworld para implementar la función con un activador HTTP:

gcloud functions deploy my-first-function --no-gen2 --entry-point functions.HelloWorld --runtime java17 --trigger-http --memory 512MB --allow-unauthenticated

En el comando anterior, my-first-function es el nombre registrado a través del cual se identificará la función en la consola de Google Cloud , y --entry-point especifica el nombre completamente calificado de la clase (FQN) de la función.

Gradle

Ejecuta el comando siguiente en el directorio helloworld-gradle para implementar la función con un activador HTTP:

gcloud functions deploy my-first-function --no-gen2 --entry-point functions.HelloWorld --runtime java17 --trigger-http --memory 512MB --allow-unauthenticated

En el comando anterior, my-first-function es el nombre registrado a través del cual se identificará la función en la consola de Google Cloud , y --entry-point especifica el nombre completamente calificado de la clase (FQN) de la función.

Más información: Para obtener más detalles, lee acerca de la implementación de Cloud Run Functions.

Prueba la función implementada

1. Cuando la función termine de implementarse, toma nota de la propiedad httpsTrigger.url o búscala con el comando siguiente:

   gcloud functions describe my-first-function

   Debería tener el aspecto siguiente:

   https://GCP_REGION-PROJECT_ID.cloudfunctions.net/my-first-function

2. Accede a esta URL a través del navegador. Deberías ver un mensaje Hello World!.

Nota: También puedes encontrar esta URL en la consola de Google Cloud . Accede a la página Resumen de Cloud Run Functions y haz clic en el nombre de la función para abrir la página de detalles. Abre la pestaña ACTIVADOR para ver la URL de la función.

Visualiza registros

Los registros de Cloud Run Functions se pueden consultar a través de la Google Cloud CLI y en la IU de Cloud Logging.

Usa la herramienta de línea de comandos

Para visualizar los registros de la función con la gcloud CLI, usa el comando logs read seguido del nombre de la función:

gcloud functions logs read my-first-function

El resultado debe parecerse al siguiente:

LEVEL  NAME               EXECUTION_ID  TIME_UTC                 LOG
D      my-first-function  k2bqgroszo4u  2020-07-24 18:18:01.791  Function execution started
D      my-first-function  k2bqgroszo4u  2020-07-24 18:18:01.958  Function execution took 168 ms, finished with status code: 200
...

Nota: Por lo general, hay una demora ligera entre el momento en que se crean las entradas de registro y el momento en que se muestran en Cloud Logging.

Usa el panel de Logging

También puedes ver los registros de Cloud Run Functions desde la consola deGoogle Cloud .

Más información: Para obtener más detalles, lea acerca de cómo escribir y visualizar registros, además de responder a ellos.