Crea e implementa una función de HTTP de Cloud Functions con 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 es la 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
- 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.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.
-
Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run y Cloud Logging APIs.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.
-
Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run y Cloud Logging APIs.
- Instala y luego inicializa el SDK de Google Cloud.
- Instala y actualiza los componentes de
gcloud
con el siguiente comando.gcloud components update
- Prepara tu entorno de desarrollo.
Crea tu función
En esta sección, se describe cómo crear una función.
Maven
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
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
Agrega el siguiente contenido al archivo
HelloWorld.java
:Esta función de ejemplo genera el saludo "Hello World!"
Gradle
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
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
Agrega el siguiente contenido al archivo
HelloWorld.java
: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
.
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.
Consulta helloworld-gradle para obtener una muestra completa basada en Gradle.
Compila y prueba la función de forma 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í.Inicia tu función con el siguiente comando:
mvn function:run
Para probar tu función, visita
http://localhost:8080
en un navegador o ejecutacurl localhost:8080
desde otra ventana.Consulta Envía solicitudes a funciones locales para obtener más detalles.
Gradle
Para confirmar que tu función se compile, ejecuta el siguiente comando:
gradle build
Inicia tu función con el siguiente comando:
gradle runFunction -Prun.functionTarget=functions.HelloWorld
Para probar tu función, visita
http://localhost:8080
en un navegador o ejecutacurl 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.
Prueba la función implementada
Después de que se implementa la función, toma nota de la propiedad
uri
del resultado del comandogcloud 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
).Visita esta URL en tu navegador. La función muestra un mensaje "Hello World!".
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
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 Functions, haz clic en el nombre de tu función en la lista y, luego, en la pestaña Registros.