Tu primera función: Java

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

  • Una función de HTTP que se invoca a partir de solicitudes HTTP estándar.
  • Una función en segundo plano que se usa para controlar eventos de la infraestructura de 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.

Estructura de la guía

  1. Crea un proyecto de GCP mediante el SDK de Cloud
  2. Crea una función
  3. Especifica dependencias
  4. Compila y prueba a nivel local
  5. Implementa la función
  6. Prueba la función implementada
  7. Visualiza registros

Crea un proyecto de GCP mediante el SDK de Cloud

  1. Accede a tu cuenta de Google Cloud. Si eres nuevo en Google Cloud, crea una cuenta para evaluar el rendimiento de nuestros productos en situaciones reales. Los clientes nuevos también obtienen $300 en créditos gratuitos para ejecutar, probar y, además, implementar cargas de trabajo.
  2. En la página del selector de proyectos de Google Cloud Console, selecciona o crea un proyecto de Google Cloud.

    Ir al selector de proyecto

  3. Comprueba que la facturación esté habilitada en tu proyecto.

    Descubre cómo puedes habilitar la facturación

  4. Habilita las API de Cloud Functions and Cloud Build.

    Habilita las API

  5. Instala e inicializa el SDK de Cloud.
  6. Instala y actualiza componentes de gcloud:
    gcloud components update
  7. 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 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!"

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 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!"

Especifica 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.cloud.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.0.4</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.9.7</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.0.1'

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

  // These dependencies are only used by the tests.
  testImplementation 'com.google.cloud.functions:functions-framework-api:1.0.1'
  testImplementation 'junit:junit:4.12'
  testImplementation 'com.google.truth:truth:1.0.1'
  testImplementation 'org.mockito:mockito-core:3.4.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.

Compila y prueba a nivel local

Antes de implementar la función, puedes compilarla y probarla de forma 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 la terminal:

curl localhost:8080
# Output: Hello World!

Implementa la función

Maven

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

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

en el que my-first-function es el nombre registrado mediante el que se identificará tu función en Cloud Console y --entry-point especifica el nombre de la clase completamente calificada (FQN) de tu función.

Gradle

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

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

En el comando anterior, my-first-function es el nombre registrado mediante el que se identificará tu función en Cloud Console, y --entry-point especifica el nombre completamente calificado de la clase (FQN) de la función.

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 siguiente comando:

    gcloud functions describe my-first-function
    

    Se verá de la siguiente manera:

    https://GCP_REGION-PROJECT_ID.cloudfunctions.net/my-first-function
  2. Visita esta URL en tu navegador. Deberías ver un mensaje de Hello World!.

Visualiza registros

Usa la herramienta de línea de comandos

Los registros de Cloud Functions se pueden ver en la IU de Cloud Logging y mediante la herramienta de línea de comandos de gcloud.

Para visualizar los registros de tu función con la herramienta de gcloud, 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
...

Usa el panel de Logging

También puedes ver los registros de Cloud Functions desde Cloud Console.