Crea e implementa una función de HTTP de Cloud Functions con .NET

Crea e implementa una función de HTTP de Cloud Functions con .NET

En esta guía, se explica el proceso de escribir una función de Cloud Functions mediante el lenguaje C# del entorno de ejecución de .NET. 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.
• La otra es 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.

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

Antes de comenzar

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. 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. Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.

4. Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run y 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. Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.

7. Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run y 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 Google 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 .NET

Crea tu función

En esta sección, se describe cómo crear una función de .NET de forma manual. También, puedes usar las plantillas de Functions Framework para crear la función.

Para crear una función, sigue estos pasos:

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

   Windows

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

   Linux o MacOS X

   mkdir ~/helloworld
   cd ~/helloworld
   

2. Crea un archivo llamado Function.cs en el directorio helloworld con el siguiente contenido:

   using Google.Cloud.Functions.Framework;
   using Microsoft.AspNetCore.Http;
   using System.Threading.Tasks;
   
   namespace HelloWorld;
   
   public class Function : IHttpFunction
   {
       public async Task HandleAsync(HttpContext context)
       {
           await context.Response.WriteAsync("Hello World!");
       }
   }

Especificar dependencias

Las funciones de Cloud Functions necesitan un conjunto de bibliotecas que se llama Functions Framework. Para Functions Framework esté disponible para tu compilación, sigue estos pasos:

1. Cambia el directorio al directorio helloworld que acabas de crear:

    cd ~/helloworld
   

2. Crea un archivo llamado HelloWorld.csproj en el directorio helloworld con el siguiente contenido:

   <Project Sdk="Microsoft.NET.Sdk">
     <PropertyGroup>
       <OutputType>Exe</OutputType>
       <TargetFramework>net6.0</TargetFramework>
     </PropertyGroup>
   
     <ItemGroup>
       <PackageReference Include="Google.Cloud.Functions.Hosting" Version="2.2.0" />
     </ItemGroup>
   </Project>

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

Para aprender a hacer que otras bibliotecas estén disponibles para tu compilación, ya sea a través de archivos de proyectos o dentro del código mediante la inserción de dependencias, consulta Personalización a través de las clases de inicio de Functions.

Compila y prueba la función de forma local

1. Compila y ejecuta la función de forma local con el siguiente comando:

   dotnet run
   

2. Para probar tu función, visita http://localhost:8080 en un navegador o ejecuta curl localhost:8080 desde otra ventana. Si usas Cloud Shell, haz clic en el ícono y selecciona Vista previa en el puerto 8080 para ver el resultado de la función.

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

Implemente su función

Para implementar tu función, ejecuta el comando helloworld en el directorio:

  gcloud functions deploy csharp-http-function \
    --gen2 \
    --entry-point=HelloWorld.Function \
    --runtime=dotnet6 \
    --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).

csharp-http-function es el nombre registrado mediante el que se identificará 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.

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

Más información: Para obtener más detalles, lee acerca de la implementación de funciones de Cloud 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 csharp-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. 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.

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 la CLI de gcloud, usa el comando logs read:

  gcloud functions logs read \
    --gen2 \
    --limit=10 \
    --region=REGION \
    csharp-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-06-01 12:47:42.221
LOG: Request finished HTTP/1.1 GET http://my-first-function-l5vqvupfzq-uw.a.run.app/favicon.ico - - - 404 0 - 0.9393ms

LEVEL: I
NAME: my-first-function
TIME_UTC: 2023-06-01 12:47:42.220
LOG: Request starting HTTP/1.1 GET http://my-first-function-l5vqvupfzq-uw.a.run.app/favicon.ico - -

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 Functions, haz clic en el nombre de tu función en la lista y, luego, en la pestaña Registros.

Crea una función con el paquete de plantillas

Estas instrucciones te ayudaron a crear una función simple. En la práctica, es probable que prefieras usar las plantillas de Functions Framework para crear tus funciones.

Si deseas usar las plantillas de Functions Framework para crear, compilar y probar una función, haz lo siguiente:

1. Instala el SDK de .NET. Puedes omitir este paso si usas Cloud Shell.

2. Instala el paquete de plantillas:

   dotnet new install Google.Cloud.Functions.Templates
   

   Nota: Las versiones del SDK de .NET anteriores a .NET 7 usan dotnet new -i en lugar de dotnet new install.

3. Crea un directorio para tu proyecto y una función de HTTP vacía:

   mkdir HelloFunctions
   cd HelloFunctions
   dotnet new gcf-http
   

   Esto crea HelloFunctions.csproj y Function.cs en el directorio actual. Abre Function.cs para revisar el código y proporciona un mensaje personalizado si lo deseas.

   Nota: A fin de aprender a usar las plantillas para crear funciones de F# y Visual Basic, consulta Lenguajes de .NET.

4. También puedes seguir las instrucciones anteriores para compilar y probar tu función de forma local.

5. Ejecuta el siguiente comando de gcloud deploy para implementar tu función:

   gcloud functions deploy HelloFunctions.Function \
     --gen2 \
     --entry-point=HelloWorld.Function \
     --runtime=dotnet6 \
     --region=REGION \
     --source=. \
     --trigger-http \
     --allow-unauthenticated
   

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

Para obtener más información sobre el framework de Functions consulta la documentación de Functions Framework.