Scrivere funzioni basate su eventi

In Cloud Functions, puoi utilizzare le funzioni basate su eventi quando vuoi che una funzione venga richiamata automaticamente in risposta a un evento che si verifica nel tuo ambiente cloud.

Funzioni CloudEvent

Puoi usare le funzioni CloudEvent per richiamare la tua funzione.

Le funzioni CloudEvent si basano su CloudEvents, una specifica standard di settore per descrivere i dati degli eventi in modo comune. Puoi scoprire di più sulla specifica CloudEvents nel repository GitHub di CloudEvents. Il progetto CloudEvents fornisce anche un set di SDK CloudEvents per aiutarti a lavorare con gli oggetti CloudEvents nel codice.

L'esempio seguente mostra un file di origine della funzione CloudEvent di base per ogni runtime. Consulta Struttura della directory di origine per informazioni su dove trovare il codice sorgente.

Node.js 

const functions = require('@google-cloud/functions-framework');

// Register a CloudEvent function with the Functions Framework
functions.cloudEvent('myCloudEventFunction', cloudEvent => {
  // Your code here
  // Access the CloudEvent data payload via cloudEvent.data
});

In Node.js, registri una funzione di gestore CloudEvent con il framework delle funzioni per Node.js. La tua funzione gestore deve accettare un oggetto CloudEvent come argomento.

Il punto di ingresso della funzione è il nome con cui il gestore è registrato nel framework di Functions. In questo esempio, il punto di ingresso è myCloudEventFunction.

Python 

import functions_framework

# Register a CloudEvent function with the Functions Framework
@functions_framework.cloud_event
def my_cloudevent_function(cloud_event):
  # Your code here
  # Access the CloudEvent data payload via cloud_event.data

In Python, registri una funzione gestore CloudEvent con il framework delle funzioni per Python. La tua funzione gestore deve accettare un oggetto CloudEvent come argomento.

Il punto di ingresso della funzione è il nome della funzione gestore registrata nel framework di Functions. In questo esempio, il punto di ingresso è my_cloudevent_function.

Go 

package mycloudeventfunction

import (
    "context"

    "github.com/GoogleCloudPlatform/functions-framework-go/functions"
    "github.com/cloudevents/sdk-go/v2/event"
)

func init() {
    // Register a CloudEvent function with the Functions Framework
    functions.CloudEvent("MyCloudEventFunction", myCloudEventFunction)
}

// Function myCloudEventFunction accepts and handles a CloudEvent object
func myCloudEventFunction(ctx context.Context, e event.Event) error {
    // Your code here
    // Access the CloudEvent data payload via e.Data() or e.DataAs(...)

    // Return nil if no error occurred
    return nil
}

In Go, registri una funzione gestore CloudEvent con il framework delle funzioni per Go. La tua funzione gestore deve accettare un oggetto CloudEvents event.Event come argomento.

Il punto di ingresso della funzione è il nome con cui il gestore è registrato nel framework di Functions. In questo esempio, il punto di ingresso è MyCloudEventFunction.

Java 

package mycloudeventfunction;

import com.google.cloud.functions.CloudEventsFunction;
import io.cloudevents.CloudEvent;

// Define a class that implements the CloudEventsFunction interface
public class MyCloudEventFunction implements CloudEventsFunction {
  // Implement the accept() method to handle CloudEvents
  @Override
  public void accept(CloudEvent event) {
    // Your code here
    // Access the CloudEvent data payload via event.getData()
    // To get the data payload as a JSON string, use:
    // new String(event.getData().toBytes())
  }
}

In Java, si utilizza l'API Java del framework Functions per implementare una classe di gestore CloudEvent con l'interfaccia CloudEventsFunction. Il metodo accept() deve accettare un oggetto CloudEvent come argomento ed eseguire qualsiasi elaborazione sull'evento.

Il punto di ingresso della funzione è il nome completo della classe di gestore CloudEvent, incluso il nome del pacchetto. In questo esempio, il punto di ingresso è mycloudeventfunction.MyCloudEventFunction.

C# 

using CloudNative.CloudEvents;
using Google.Cloud.Functions.Framework;
using System.Threading;
using System.Threading.Tasks;

namespace MyProject
{
    // Define a class that implements the ICloudEventFunction<T> interface
    public class MyCloudEventFunction : ICloudEventFunction<CloudEventDataType>
    {
        // Implement the HandleAsync() method to handle CloudEvents
        public Task HandleAsync(CloudEvent cloudEvent, CloudEventDataType data, CancellationToken cancellationToken)
        {
            // Your code here
            // The data argument represents the CloudEvent data payload

            // Signal function completion
            return Task.CompletedTask;
        }
    }
}

Nei runtime .NET, puoi utilizzare Functions Framework per .NET per implementare una classe di gestore CloudEvent con l'interfaccia ICloudEventFunction<T>. Il metodo HandleAsync() accetta un oggetto CloudEvent e il payload dei dati CloudEvent associato come argomenti.

Il tipo di argomento payload dei dati CloudEvent, mostrato nell'esempio precedente come CloudEventDataType, deve corrispondere al tipo di evento gestito dalla funzione. La libreria .NET di Google CloudEvents fornisce tipi di dati per i vari eventi supportati da Google.

Il punto di ingresso della funzione è il nome completo della classe di gestore CloudEvent, incluso lo spazio dei nomi. In questo esempio, il punto di ingresso è MyProject.MyCloudEventFunction.

Ruby 

require "functions_framework"

# Register a CloudEvent function with the Functions Framework
FunctionsFramework.cloud_event "my_cloudevent_function" do |cloud_event|
  # Your code here
  # Access the CloudEvent data payload via cloud_event.data
end

In Ruby, registri una funzione di gestore CloudEvent con il framework delle funzioni per Ruby. La tua funzione gestore deve accettare un oggetto CloudEvents Event come argomento.

Il punto di ingresso della funzione è il nome con cui il gestore è registrato nel framework di Functions. In questo esempio, il punto di ingresso è my_cloudevent_function.

PHP 

<?php

use CloudEvents\V1\CloudEventInterface;
use Google\CloudFunctions\FunctionsFramework;

// Register a CloudEvent function with the Functions Framework
FunctionsFramework::cloudEvent('myCloudEventFunction', 'myCloudEventHandler');

// Define your CloudEvent handler
function myCloudEventHandler(CloudEventInterface $event): void
{
    // Your code here
    // Access the CloudEvent data payload via $event->getData()
}

In PHP, registri una funzione gestore CloudEvent con il framework delle funzioni per PHP. La tua funzione gestore deve accettare un argomento conforme all'interfaccia CloudEventInterface.

Il punto di ingresso della funzione è il nome con cui il gestore è registrato nel framework di Functions. In questo esempio, il punto di ingresso è myCloudEventFunction.

Per le funzioni CloudEvent, i dati degli eventi vengono passati alla funzione nel formato CloudEvents, con un payload di dati CloudEvent corrispondente al tipo di evento che attiva la funzione. Consulta Trigger di Cloud Functions per informazioni sui trigger, i tipi di eventi e i formati di dati degli eventi associati.

Il repository Google Eventi contiene le risorse per lavorare con CloudEvents rilasciate da Google.

Terminazione della funzione

Cloud Functions considera l'esecuzione di una funzione basata su eventi completata quando restituisce la funzione. Se la funzione crea attività in background (ad esempio con thread, future, oggetti JavaScript Promise, callback o processi di sistema), devi terminare o risolvere in altro modo queste attività prima di tornare dalla funzione. Tutte le attività non terminate prima della restituzione della funzione potrebbero non essere completate e potrebbero causare un comportamento indefinito.

Nuovi tentativi automatici

Le funzioni basate su eventi possono essere configurate per riprovare automaticamente le chiamate non riuscite. Per ulteriori informazioni, consulta Ripetere le funzioni basate su eventi.

Passaggi successivi