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.

Esistono due modi per implementare le funzioni basate su eventi. La modalità di utilizzo dipende dal runtime del linguaggio che hai scelto:

Funzioni CloudEvent

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.

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.

Funzioni in background

Le funzioni basate su eventi nei runtime Node.js, Python, Go e Java prevedono argomenti diversi dalle funzioni CloudEvent. Questo vecchio stile di funzione basata su eventi è chiamato funzione in background.

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

Node.js 

// Define and export an event handler
exports.myBackgroundFunction = (eventData, context, callback) => {
  // Your code here
  // The eventData argument represents the event data payload

  // Optionally signal function completion:
  callback();
};

In Node.js, definisci ed esporti una funzione che gestisce i dati degli eventi. Cloud Functions passa i seguenti argomenti alla funzione gestore:

  • eventData: un oggetto che rappresenta il payload dei dati sugli eventi. Il suo formato dipende dal tipo di evento.
  • context: un oggetto contenente i metadati relativi all'evento.
  • callback: una funzione facoltativa che puoi richiamare per segnalare il completamento. Il primo argomento di questo callback è interpretato come segnalazione di un errore. Non trasmettere alcun argomento o un primo argomento null per segnalare l'esito positivo.

Il punto di ingresso della funzione è il nome del gestore di eventi esportati. In questo esempio, il punto di ingresso è myBackgroundFunction.

Python 

# Define an event handler
def my_background_function(event_data, context):
  # Your code here
  # The event_data argument represents the event data payload

In Python, definisci una funzione che gestisce i dati degli eventi. Cloud Functions passa i seguenti argomenti alla funzione gestore:

  • event_data: un dizionario che rappresenta il payload dei dati sugli eventi. Il suo formato dipende dal tipo di evento.
  • context: un oggetto contenente i metadati relativi all'evento.

Il punto di ingresso della funzione è il nome della funzione gestore. In questo esempio, il punto di ingresso è my_background_function.

Go 

package mybackgroundfunction

import (
    "context"
)

// Function MyBackgroundFunction accepts and handles event data
func MyBackgroundFunction(ctx context.Context, e EventDataType) error {
    // Your code here
    // The argument e represents the event data payload

    // Return nil if no error occurred
    return nil
}

In Go, definisci una funzione esportata che gestisce i dati sugli eventi. Cloud Functions passa i seguenti argomenti alla funzione gestore:

  • ctx: un oggetto context.Context contenente i metadati relativi all'evento. Puoi recuperare i metadati utilizzando il pacchetto cloud.google.com/go/functions/metadata.
  • e: un oggetto che rappresenta il payload dei dati sugli eventi. Il suo tipo, mostrato nell'esempio precedente come EventDataType, deve essere uno struct corrispondente al tipo di evento gestito dalla funzione. Il payload dei dati degli eventi viene disomogeneo nello struct utilizzando json.Unmarshal().

Il punto di ingresso della funzione è il nome del gestore di eventi esportati. In questo esempio, il punto di ingresso è MyBackgroundFunction.

Java 

package mybackgroundfunction;

import com.google.cloud.functions.BackgroundFunction;
import com.google.cloud.functions.Context;

// Define a class that implements the BackgroundFunction<T> interface
public class MyBackgroundFunction implements BackgroundFunction<EventDataType> {
  // Implement the accept() method to handle events
  @Override
  public void accept(EventDataType eventData, Context context) {
    // Your code here
    // The eventData argument represents the event data payload
  }
}

In Java, puoi utilizzare l'API Java del framework Functions per implementare una classe di gestori di eventi con l'interfaccia BackgroundFunction<T>. Il metodo accept() accetta come argomenti il payload dei dati sugli eventi e un oggetto Context contenente i metadati relativi all'evento.

Il tipo di argomento payload dei dati evento, mostrato nell'esempio precedente come EventDataType, deve corrispondere al tipo di evento gestito dalla funzione. Il payload dei dati sugli eventi viene deserializzato in un'istanza di questa classe utilizzando Gson.fromJson().

Il punto di ingresso della funzione è il nome completo della classe del gestore di eventi, incluso il nome del pacchetto. In questo esempio, il punto di ingresso è mybackgroundfunction.MyBackgroundFunction.

Per le funzioni in background, il payload dei dati degli eventi viene passato direttamente alla funzione in un formato corrispondente al tipo di evento che attiva la funzione. Consulta Trigger supportati in Cloud Functions (1ª generazione.) per informazioni sui trigger, i tipi di eventi e i formati di dati degli eventi associati.

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