Crea e implementa una función HTTP de Cloud Run Functions con Java

Nota: Este contenido se aplica solo a las funciones de Cloud Run, antes Cloud Functions (2nd gen).

Para obtener la versión de 1ª gen. de este documento, consulta Crea e implementa una función de HTTP de Cloud Run Functions con Java (1ª gen.).

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

• Una función de HTTP que se invoca a partir de solicitudes HTTP estándar.
• Una función controlada por eventos que se activa mediante eventos en la infraestructura de tu nube, como mensajes en un tema de Cloud Pub/Sub o cambios en un bucket de Cloud Storage.

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

Para obtener más detalles, consulta Escribir funciones HTTP y Escribir funciones controladas por eventos.

Antes de comenzar

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 Functions, Cloud Build, Artifact Registry, Cloud Run, and Cloud Logging APIs.

   Enable the APIs

5. 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

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

7. Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run, and Cloud Logging APIs.

   Enable the APIs

8. Instala y luego inicializa el SDK de Google Cloud.
   Nota: ¿Necesitas un símbolo del sistema? Puedes usar Cloud Shell. Google Cloud Shell es un entorno de línea de comandos que ya incluye Google Cloud CLI, por lo que no es necesario que lo instales. Google Cloud CLI también viene preinstalado en las máquinas virtuales de Google Compute Engine.
9. Instala y actualiza los componentes de gcloud con el siguiente comando.

   gcloud components update

10. Prepara tu entorno de desarrollo.

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

Crea tu 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 Mac OS X

    mkdir ~/helloworld
    cd ~/helloworld
   

   Windows:

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

2. Crea la estructura del proyecto a fin de que contenga el directorio fuente y el archivo de origen.

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

3. Agrega el siguiente contenido 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 Mac OS X

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

   Windows:

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

2. Crea la estructura del proyecto a fin de que contenga el directorio fuente y el archivo de origen.

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

3. Agrega el siguiente contenido 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!"

Especificar dependencias

En el siguiente paso, se deben configurar 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 de forma 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 de forma local

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

Maven

1. 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í.

2. Inicia la función con el siguiente comando:

   mvn function:run
   

3. Para probar tu función, visita http://localhost:8080 en un navegador o ejecuta curl localhost:8080 desde otra ventana.

   Consulta Envía solicitudes a funciones locales para obtener más detalles.

Gradle

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

   gradle build
   

2. Inicia la función con el siguiente comando:

   gradle runFunction -Prun.functionTarget=functions.HelloWorld
   

3. Para probar tu función, visita http://localhost:8080 en un navegador o ejecuta curl localhost:8080 desde otra ventana.

   Consulta Envía solicitudes a funciones locales para obtener más detalles.

Implemente su función

Para implementar tu función, ejecuta el siguiente comando en el directorio helloworld (si usas maven) o en el directorio helloworld-gradle (para Gradle):

  gcloud functions deploy java-http-function \
    --gen2 \
    --entry-point=functions.HelloWorld \
    --runtime=java17 \
    --region=REGION \
    --source=. \
    --trigger-http \
    --allow-unauthenticated

Reemplaza REGION por el nombre de la región de Google Cloud en la que deseas implementar tu función (por ejemplo, us-west1).

La marca opcional --allow-unauthenticated te permite acceder a tu función sin autenticación.

java-http-function es el nombre registrado mediante el que se identifica tu función en la consola de Google Cloud y --entry-point especifica el nombre de la clase completamente calificada (FQN) de tu función.

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

Prueba la función implementada

1. Después de que se implementa la función, toma nota de la propiedad uri del resultado del comando gcloud functions deploy o recupérala con el siguiente comando:

   gcloud functions describe java-http-function \
     --region=REGION
   

   Reemplaza REGION por el nombre de la región de Google Cloud en la que implementaste tu función (por ejemplo, us-west1).

2. Visita esta URL en tu navegador. La función muestra un mensaje "Hello World!".

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

Visualiza los registros de tu función

Visualiza registros con la herramienta de línea de comandos

Puedes revisar los registros de tu función con la IU de Cloud Logging o a través de Google Cloud CLI.

Para ver los registros de tu función con gcloud CLI, usa el comando logs read:

    gcloud functions logs read \
      --gen2 \
      --limit=10 \
      --region=REGION \
      java-http-function

Reemplaza REGION por el nombre de la región de Google Cloud en la que implementaste tu función (por ejemplo, us-west1).

El resultado se ve de la manera siguiente:

LEVEL: I
NAME: my-first-function
TIME_UTC: 2023-05-29 23:09:57.708
LOG:

LEVEL: I
NAME: my-first-function
TIME_UTC: 2023-05-29 23:05:53.257
LOG: Default STARTUP TCP probe succeeded after 1 attempt for container "my--first--function-1" on port 8080.

LEVEL:
NAME: my-first-function
TIME_UTC: 2023-05-29 23:05:53.248
LOG: 2023-05-29 23:05:53.248:INFO:oejs.Server:main: Started @892ms

Nota: Puede haber una pequeña demora antes de que aparezcan las entradas de registro en Cloud Logging.

Visualiza registros con el panel de registros

Para ver los registros de tu función con el panel de registro, abre el Página de descripción general de Cloud Run Functions, haz clic en el nombre de tu función en la lista y, luego, en la pestaña Registros.

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