Guía de inicio rápido: 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 función activada por HTTP, que se invoca a partir de solicitudes HTTP estándar.
  • Una función controlada por eventos que se usa para manejar los eventos de la infraestructura de nube, como mensajes en un tema de Cloud Pub/Sub o cambios en un bucket de Cloud Storage.

Estructura de la guía

  1. Crea un proyecto de GCP mediante la CLI de gcloud
  2. Crea una función
  3. Especifica dependencias
  4. Implementa la función
  5. Prueba la función implementada
  6. Visualiza registros
  7. Usa Functions Framework

Crea un proyecto de GCP mediante la CLI de gcloud

  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 proyectos

  3. Asegúrate de que la facturación esté habilitada para tu proyecto de Cloud. Obtén información sobre cómo verificar si la facturación está habilitada en un proyecto.

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

    Habilita las API

    5.

  5. En la página del selector de proyectos de Google Cloud Console, selecciona o crea un proyecto de Google Cloud.

    Ir al selector de proyectos

  6. Asegúrate de que la facturación esté habilitada para tu proyecto de Cloud. Obtén información sobre cómo verificar si la facturación está habilitada en un proyecto.

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

    Habilita las API

    8.
  8. Instala e inicializa la CLI de gcloud.
  9. Instala y actualiza componentes de gcloud: 
    gcloud components update
  10. Prepara tu entorno de desarrollo.

    Ir a la guía de configuración de .NET

Crea una función

En esta sección, se describe cómo crear una función de forma manual desde cero. Como alternativa, puedes usar las plantillas que proporciona el paquete de plantillas.

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 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!");
        }
    }
}

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

Especifica dependencias

En el siguiente paso, se deben configurar dependencias. Existen dos tipos de dependencias diferentes que puedes configurar en Cloud Functions para C#:

  • Haz que Functions Framework esté disponible. Eso es lo que harás en esta sección.
  • Puedes poner a disposición otras bibliotecas, en términos de archivos de proyectos y dentro del código mediante la inserción de dependencias. Para obtener más información, consulta Customization through Functions Startup classes (Personalización a través de las clases de inicio de Functions).

Cambia el directorio al directorio helloworld que creaste antes para que Functions Framework esté disponible:

     cd ~/helloworld

Luego, crea un archivo llamado HelloWorld.csproj con el siguiente contenido:

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>netcoreapp3.1</TargetFramework>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Google.Cloud.Functions.Hosting" Version="1.0.0" />
  </ItemGroup>
</Project>

Implementa la función

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 HelloWorld.Function --runtime dotnet3 --trigger-http --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 de la clase completamente calificada (FQN) de tu 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 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 a través de Google Cloud CLI.

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

Usa el paquete de plantillas

En las secciones anteriores, se explica cómo crear una función de forma manual desde cero. En el futuro, es probable que uses las plantillas para crear funciones nuevas.

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

  1. Instala .NET Core SDK 3.1.

  2. Instala el paquete de plantillas:

    dotnet new -i Google.Cloud.Functions.Templates

  3. A continuación, crea un directorio para el proyecto y usa dotnet new a fin de crear una nueva función de HTTP:

    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.

  4. Compila tu función de forma local, como se indica a continuación:

    dotnet run

  5. Una vez que el servidor esté en ejecución, navega a http://localhost:8080 para invocar la función. Presiona Ctrl + C en la consola para detener el servidor.

    Esta función muestra el mensaje “Hello Functions Framework”.

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

curl localhost:8080
# Output: Hello Functions Framework