Tutorial Cloud Pub/Sub (2a generazione)

Questo semplice tutorial illustra come scrivere, eseguire il deployment e attivare una funzione Cloud basata su eventi con un trigger Cloud Pub/Sub.

Se è la prima volta che utilizzi Pub/Sub e vuoi saperne di più, consulta la documentazione di Pub/Sub, in particolare la gestione di argomenti e sottoscrizioni. Per una panoramica sull'utilizzo degli argomenti e delle sottoscrizioni Pub/Sub in Cloud Functions, consulta l'articolo sui trigger di Google Cloud Pub/Sub.

Se stai cercando esempi di codice per utilizzare Pub/Sub, visita il browser di esempio Google Cloud.

Obiettivi

Scrivere ed eseguire il deployment di una funzione Cloud basata su eventi.
Attiva la funzione pubblicando un messaggio in un argomento Pub/Sub.

Costi

Questo tutorial utilizza i seguenti componenti fatturabili di Google Cloud:

Cloud Functions
Cloud Build
Pub/Sub
Artifact Registry
Eventarc
Cloud Logging

Per i dettagli, consulta i prezzi di Cloud Functions.

Per generare una stima dei costi in base all'utilizzo previsto, utilizza il Calcolatore prezzi. I nuovi utenti di Google Cloud possono beneficiare di una prova gratuita.

Prima di iniziare

Accedi al tuo account Google Cloud. Se non conosci Google Cloud, crea un account per valutare le prestazioni dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti gratuiti per l'esecuzione, il test e il deployment dei carichi di lavoro.

Nella pagina del selettore dei progetti in Google Cloud Console, seleziona o crea un progetto Google Cloud.

Vai al selettore progetti

Assicurati che la fatturazione sia attivata per il tuo progetto Cloud. Scopri come verificare se la fatturazione è abilitata su un progetto.

Abilita le API Cloud Functions, Cloud Build, Artifact Registry, Eventarc, Logging, and Pub/Sub.

Abilita le API

Installa Google Cloud CLI.

Per inizializzare l'interfaccia a riga di comando gcloud, esegui il comando seguente:

gcloud init

Nella pagina del selettore dei progetti in Google Cloud Console, seleziona o crea un progetto Google Cloud.

Vai al selettore progetti

Assicurati che la fatturazione sia attivata per il tuo progetto Cloud. Scopri come verificare se la fatturazione è abilitata su un progetto.

Abilita le API Cloud Functions, Cloud Build, Artifact Registry, Eventarc, Logging, and Pub/Sub.

Abilita le API

Installa Google Cloud CLI.

Per inizializzare l'interfaccia a riga di comando gcloud, esegui il comando seguente:

gcloud init

Se hai già installato l'interfaccia a riga di comando gcloud, aggiornalo eseguendo questo comando:

gcloud components update

Prepara l'ambiente di sviluppo.

Node.js

Vai alla guida alla configurazione di Node.js

Python

Vai alla guida alla configurazione di Python

Go

Vai alla guida alla configurazione Vai

Java

Vai alla guida alla configurazione di Java

C#

Vai alla guida alla configurazione di .NET

Ruby

Vai alla guida alla configurazione di Ruby

PHP

Vai a Utilizzo di PHP in Google Cloud

Prerequisiti

Crea un argomento Pub/Sub:

gcloud pubsub topics create YOUR_TOPIC_NAME

Questo è un passaggio obbligatorio prima di poter eseguire il deployment della funzione. In Cloud Functions (2nd gen), gli argomenti Pub/Sub non vengono creati automaticamente quando esegui il deployment di una funzione.

Preparazione dell'applicazione

Clona il repository dell'app di esempio nella macchina locale:
Node.js
```
git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git
```
In alternativa, puoi scaricare l'esempio come file ZIP ed estrarlo.
Python
```
git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
```
In alternativa, puoi scaricare l'esempio come file ZIP ed estrarlo.
Go
```
git clone https://github.com/GoogleCloudPlatform/golang-samples.git
```
In alternativa, puoi scaricare l'esempio come file ZIP ed estrarlo.
Java
```
git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git
```
In alternativa, puoi scaricare l'esempio come file ZIP ed estrarlo.
C#
```
git clone https://github.com/GoogleCloudPlatform/dotnet-docs-samples.git
```
In alternativa, puoi scaricare l'esempio come file ZIP ed estrarlo.
Ruby
```
git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples.git
```
In alternativa, puoi scaricare l'esempio come file ZIP ed estrarlo.
PHP
```
git clone https://github.com/GoogleCloudPlatform/php-docs-samples.git
```
In alternativa, puoi scaricare l'esempio come file ZIP ed estrarlo.

Passa alla directory che contiene il codice campione Cloud Functions per accedere a Pub/Sub:

Node.js

cd nodejs-docs-samples/functions/v2/helloPubSub/

Python

cd python-docs-samples/functions/v2/pubsub/

Go

cd golang-samples/functions/functionsv2/hellopubsub/

Java

cd java-docs-samples/functions/v2/pubsub/

C#

cd dotnet-docs-samples/functions/helloworld/HelloPubSub/

Ruby

cd ruby-docs-samples/functions/helloworld/pubsub/

PHP

cd php-docs-samples/functions/helloworld_pubsub/

Dai un'occhiata al codice campione:

Node.js

function/v2/helloPubSub/index.js

Visualizza su GitHub

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

// Register a CloudEvent callback with the Functions Framework that will
// be executed when the Pub/Sub trigger topic receives a message.
functions.cloudEvent('helloPubSub', cloudEvent => {
  // The Pub/Sub message is passed as the CloudEvent's data payload.
  const base64name = cloudEvent.data.message.data;

  const name = base64name
    ? Buffer.from(base64name, 'base64').toString()
    : 'World';

  console.log(`Hello, ${name}!`);
});

Python

function/v2/pubsub/main.py

Visualizza su GitHub

import base64

import functions_framework

# Triggered from a message on a Cloud Pub/Sub topic.
@functions_framework.cloud_event
def subscribe(cloud_event):
    # Print out the data from Pub/Sub, to prove that it worked
    print("Hello, " + base64.b64decode(cloud_event.data["message"]["data"]).decode() + "!")

Go

function/functionsv2/hellopubsub/hello_pubsub.go

Visualizza su GitHub


// Package helloworld provides a set of Cloud Functions samples.
package helloworld

import (
	"context"
	"fmt"
	"log"

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

func init() {
	functions.CloudEvent("HelloPubSub", helloPubSub)
}

// MessagePublishedData contains the full Pub/Sub message
// See the documentation for more details:
// https://cloud.google.com/eventarc/docs/cloudevents#pubsub
type MessagePublishedData struct {
	Message PubSubMessage
}

// PubSubMessage is the payload of a Pub/Sub event.
// See the documentation for more details:
// https://cloud.google.com/pubsub/docs/reference/rest/v1/PubsubMessage
type PubSubMessage struct {
	Data []byte `json:"data"`
}

// helloPubSub consumes a CloudEvent message and extracts the Pub/Sub message.
func helloPubSub(ctx context.Context, e event.Event) error {
	var msg MessagePublishedData
	if err := e.DataAs(&msg); err != nil {
		return fmt.Errorf("event.DataAs: %v", err)
	}

	name := string(msg.Message.Data) // Automatically decoded from base64.
	if name == "" {
		name = "World"
	}
	log.Printf("Hello, %s!", name)
	return nil
}

Java

function/v2/pubsub/src/main/java/functions/SubscribeToTopic.java

Visualizza su GitHub

import com.google.cloud.functions.CloudEventsFunction;
import com.google.gson.Gson;
import functions.eventpojos.PubSubBody;
import io.cloudevents.CloudEvent;
import java.nio.charset.StandardCharsets;
import java.util.Base64;
import java.util.logging.Logger;

public class SubscribeToTopic implements CloudEventsFunction {
  private static final Logger logger = Logger.getLogger(SubscribeToTopic.class.getName());

  @Override
  public void accept(CloudEvent event) {
    // The Pub/Sub message is passed as the CloudEvent's data payload.
    if (event.getData() != null) {
      // Extract Cloud Event data and convert to PubSubBody
      String cloudEventData = new String(event.getData().toBytes(), StandardCharsets.UTF_8);
      Gson gson = new Gson();
      PubSubBody body = gson.fromJson(cloudEventData, PubSubBody.class);
      // Retrieve and decode PubSub message data
      String encodedData = body.getMessage().getData();
      String decodedData =
          new String(Base64.getDecoder().decode(encodedData), StandardCharsets.UTF_8);
      logger.info("Hello, " + decodedData + "!");
    }
  }
}

C#

Functions/helloworld/HelloPubSub/Function.cs

Visualizza su GitHub

using CloudNative.CloudEvents;
using Google.Cloud.Functions.Framework;
using Google.Events.Protobuf.Cloud.PubSub.V1;
using Microsoft.Extensions.Logging;
using System.Threading;
using System.Threading.Tasks;

namespace HelloPubSub
{
    public class Function : ICloudEventFunction<MessagePublishedData>
    {
        private readonly ILogger _logger;

        public Function(ILogger<Function> logger) =>
            _logger = logger;

        public Task HandleAsync(CloudEvent cloudEvent, MessagePublishedData data, CancellationToken cancellationToken)
        {
            string nameFromMessage = data.Message?.TextData;
            string name = string.IsNullOrEmpty(nameFromMessage) ? "world" : nameFromMessage;
            _logger.LogInformation("Hello {name}", name);
            return Task.CompletedTask;
        }
    }
}

Ruby

function/helloworld/pubsub/app.rb

Visualizza su GitHub

require "functions_framework"
require "base64"

FunctionsFramework.cloud_event "hello_pubsub" do |event|
  # The event parameter is a CloudEvents::Event::V1 object.
  # See https://cloudevents.github.io/sdk-ruby/latest/CloudEvents/Event/V1.html
  name = Base64.decode64 event.data["message"]["data"] rescue "World"

  # A cloud_event function does not return a response, but you can log messages
  # or cause side effects such as sending additional events.
  logger.info "Hello, #{name}!"
end

PHP

function/helloworld_pubsub/index.php

Visualizza su GitHub


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

// Register the function with Functions Framework.
// This enables omitting the `FUNCTIONS_SIGNATURE_TYPE=cloudevent` environment
// variable when deploying. The `FUNCTION_TARGET` environment variable should
// match the first parameter.
FunctionsFramework::cloudEvent('helloworldPubsub', 'helloworldPubsub');

function helloworldPubsub(CloudEventInterface $event): void
{
    $log = fopen(getenv('LOGGER_OUTPUT') ?: 'php://stderr', 'wb');

    $cloudEventData = $event->getData();
    $pubSubData = base64_decode($cloudEventData['message']['data']);

    $name = $pubSubData ? htmlspecialchars($pubSubData) : 'World';
    fwrite($log, "Hello, $name!" . PHP_EOL);
}

Deployment della funzione

Per il deployment della funzione con un trigger Pub/Sub, esegui questo comando nella directory che contiene il codice di esempio (o, nel caso di Java, il file pom.xml):

Node.js

gcloud functions deploy nodejs-pubsub-function \
--gen2 \
--runtime=nodejs18 \
--region=REGION \
--source=. \
--entry-point=helloPubSub \
--trigger-topic=YOUR_TOPIC_NAME

Puoi utilizzare i seguenti valori per il flag --runtime per specificare la versione di Node.js che preferisci:

nodejs18 (consigliato)
nodejs16
nodejs14
nodejs12
nodejs10

Python

gcloud functions deploy python-pubsub-function \
--gen2 \
--runtime=python310 \
--region=REGION \
--source=. \
--entry-point=subscribe \
--trigger-topic=YOUR_TOPIC_NAME

Puoi utilizzare i seguenti valori per il flag --runtime per specificare la versione di Python che preferisci:

python310 (consigliato)
python311 (anteprima)
python39
python38
python37

Go

gcloud functions deploy go-pubsub-function \
--gen2 \
--runtime=go119 \
--region=REGION \
--source=. \
--entry-point=HelloPubSub \
--trigger-topic=YOUR_TOPIC_NAME

Puoi utilizzare i seguenti valori per il flag --runtime per specificare la tua versione di Go preferita:

go119 (consigliato)
go118
go116
go113

Java

gcloud functions deploy java-pubsub-function \
--gen2 \
--runtime=java17 \
--region=REGION \
--source=. \
--entry-point=functions.SubscribeToTopic \
--memory=512MB \
--trigger-topic=YOUR_TOPIC_NAME

Puoi utilizzare i seguenti valori per il flag --runtime per specificare la versione di Java che preferisci:

java17 (consigliato)
java11

C#

gcloud functions deploy csharp-pubsub-function \
--gen2 \
--runtime=dotnet6 \
--region=REGION \
--source=. \
--entry-point=HelloPubSub.Function \
--trigger-topic=YOUR_TOPIC_NAME

Puoi utilizzare i seguenti valori per il flag --runtime per specificare la versione di .NET che preferisci:

dotnet6 (consigliato)
dotnet3

Ruby

gcloud functions deploy ruby-pubsub-function \
--gen2 \
--runtime=ruby30 \
--region=REGION \
--source=. \
--entry-point=hello_pubsub \
--trigger-topic=YOUR_TOPIC_NAME

Puoi utilizzare i seguenti valori per il flag --runtime per specificare la versione di Ruby che preferisci:

ruby30 (consigliato)
ruby27
ruby26

PHP

gcloud functions deploy php-pubsub-function \
--gen2 \
--runtime=php81 \
--region=REGION \
--source=. \
--entry-point=helloworldPubsub \
--trigger-topic=YOUR_TOPIC_NAME

Puoi utilizzare i seguenti valori per il flag --runtime per specificare la versione di PHP che preferisci:

php81 (consigliato)
php74

dove YOUR_TOPIC_NAME è il nome dell'argomento Pub/Sub a cui verrà eseguita la sottoscrizione alla funzione.

Prima di eseguire il comando deploy, devi creare un argomento utilizzando la console Google Cloud o lo gcloud strumento a riga di comando. A differenza di Cloud Functions (1a generazione), in Cloud Functions (2nd gen) gli argomenti Pub/Sub non vengono creati automaticamente quando esegui il deployment di una funzione con un trigger Pub/Sub.

Attivazione della funzione

Per testare la funzione Pub/Sub:

Pubblica un messaggio nell'argomento:

gcloud pubsub topics publish my-topic --message="Friend"

Leggi i log delle funzioni per visualizzare il risultato, dove FUNCTION_NAME è il nome della funzione:
```
gcloud beta functions logs read FUNCTION_NAME --gen2
```
Dovresti vedere l'output del logging che include il nuovo messaggio "Friend".

Nota: la visualizzazione dei log potrebbe richiedere alcuni istanti. Se non le vedi immediatamente, ricontrolla dopo uno o due minuti.

Esegui la pulizia

Per evitare che al tuo Account Google Cloud vengano addebitati costi relativi alle risorse utilizzate in questo tutorial, elimina il progetto che contiene le risorse oppure mantieni il progetto ed elimina le singole risorse.

Elimina il progetto

Il modo più semplice per eliminare la fatturazione è eliminare il progetto che hai creato per il tutorial.

Per eliminare il progetto:

In Google Cloud Console, vai alla pagina Gestisci risorse.
Vai a Gestisci risorse
Nell'elenco dei progetti, seleziona il progetto che vuoi eliminare, quindi fai clic su Elimina.
Nella finestra di dialogo, digita l'ID del progetto e fai clic su Chiudi per eliminare il progetto.

Eliminazione della funzione Cloud Functions

L'eliminazione di Cloud Functions non comporta la rimozione delle risorse archiviate in Cloud Storage.

Per eliminare la funzione Cloud Functions creata in questo tutorial, esegui questo comando:

Node.js

gcloud functions delete nodejs-pubsub-function --gen2 --region REGION

Python

gcloud functions delete python-pubsub-function --gen2 --region REGION

Go

gcloud functions delete go-pubsub-function --gen2 --region REGION

Java

gcloud functions delete java-pubsub-function --gen2 --region REGION

C#

gcloud functions delete csharp-pubsub-function --gen2 --region REGION

Ruby

gcloud functions delete ruby-pubsub-function --gen2 --region REGION

PHP

gcloud functions delete php-pubsub-function --gen2 --region REGION

Puoi anche eliminare Cloud Functions dalla console Google Cloud.