Per iniziare: scrivi, testa ed esegui il deployment delle tue prime funzioni

Per iniziare a utilizzare Cloud Functions, prova a seguire questo tutorial, che inizia con le attività di configurazione richieste e prosegue con la creazione, il test e l'implementazione di due funzioni correlate:

• Una funzione "Aggiungi messaggio" che espone un URL che accetta un valore di testo e lo scrive in Cloud Firestore.
• Una funzione "in maiuscolo" che si attiva su una scrittura Cloud Firestore e trasforma il testo in maiuscolo.

Di seguito è riportato il codice di esempio completo contenente le funzioni:

// The Cloud Functions for Firebase SDK to create Cloud Functions and triggers.
const {logger} = require("firebase-functions");
const {onRequest} = require("firebase-functions/v2/https");
const {onDocumentCreated} = require("firebase-functions/v2/firestore");

// The Firebase Admin SDK to access Firestore.
const {initializeApp} = require("firebase-admin/app");
const {getFirestore} = require("firebase-admin/firestore");

initializeApp();

// Take the text parameter passed to this HTTP endpoint and insert it into
// Firestore under the path /messages/:documentId/original
exports.addmessage = onRequest(async (req, res) => {
  // Grab the text parameter.
  const original = req.query.text;
  // Push the new message into Firestore using the Firebase Admin SDK.
  const writeResult = await getFirestore()
      .collection("messages")
      .add({original: original});
  // Send back a message that we've successfully written the message
  res.json({result: `Message with ID: ${writeResult.id} added.`});
});

// Listens for new messages added to /messages/:documentId/original
// and saves an uppercased version of the message
// to /messages/:documentId/uppercase
exports.makeuppercase = onDocumentCreated("/messages/{documentId}", (event) => {
  // Grab the current value of what was written to Firestore.
  const original = event.data.data().original;

  // Access the parameter `{documentId}` with `event.params`
  logger.log("Uppercasing", event.params.documentId, original);

  const uppercase = original.toUpperCase();

  // You must return a Promise when performing
  // asynchronous tasks inside a function
  // such as writing to Firestore.
  // Setting an 'uppercase' field in Firestore document returns a Promise.
  return event.data.ref.set({uppercase}, {merge: true});
});
index.js

# The Cloud Functions for Firebase SDK to create Cloud Functions and set up triggers.
from firebase_functions import firestore_fn, https_fn

# The Firebase Admin SDK to access Cloud Firestore.
from firebase_admin import initialize_app, firestore
import google.cloud.firestore

app = initialize_app()


@https_fn.on_request()
def addmessage(req: https_fn.Request) -> https_fn.Response:
    """Take the text parameter passed to this HTTP endpoint and insert it into
    a new document in the messages collection."""
    # Grab the text parameter.
    original = req.args.get("text")
    if original is None:
        return https_fn.Response("No text parameter provided", status=400)

    firestore_client: google.cloud.firestore.Client = firestore.client()

    # Push the new message into Cloud Firestore using the Firebase Admin SDK.
    _, doc_ref = firestore_client.collection("messages").add({"original": original})

    # Send back a message that we've successfully written the message
    return https_fn.Response(f"Message with ID {doc_ref.id} added.")


@firestore_fn.on_document_created(document="messages/{pushId}")
def makeuppercase(event: firestore_fn.Event[firestore_fn.DocumentSnapshot | None]) -> None:
    """Listens for new documents to be added to /messages. If the document has
    an "original" field, creates an "uppercase" field containg the contents of
    "original" in upper case."""

    # Get the value of "original" if it exists.
    if event.data is None:
        return
    try:
        original = event.data.get("original")
    except KeyError:
        # No "original" field, so do nothing.
        return

    # Set the "uppercase" field.
    print(f"Uppercasing {event.params['pushId']}: {original}")
    upper = original.upper()
    event.data.reference.update({"uppercase": upper})
main.py

Informazioni su questo tutorial

Abbiamo scelto Cloud Firestore e le funzioni attivate tramite HTTP per questo esempio in parte perché questi attivatori in background possono essere testati in modo approfondito tramite Firebase Local Emulator Suite. Questo set di strumenti supporta anche gli trigger chiamabili Realtime Database, Cloud Storage, PubSub, Auth e HTTP. Altri tipi di attivatori in background, come gli attivatori Remote Config e TestLab, possono essere testati in modo interattivo utilizzando set di strumenti non descritti in questa pagina.

Le sezioni seguenti di questo tutorial descrivono in dettaglio i passaggi necessari per compilare, testare e implementare il sample.

Creare un progetto Firebase

1. Nella console Firebase, fai clic su Aggiungi progetto.

   • Per aggiungere risorse Firebase a un progetto Google Cloud esistente, inserisci il nome del progetto o selezionalo dal menu a discesa.

   • Per creare un nuovo progetto, inserisci il nome desiderato. Se vuoi, puoi anche modificare l'ID progetto visualizzato sotto il nome del progetto.

2. Se richiesto, leggi e accetta i Termini di Firebase.

3. Fai clic su Continua.

4. (Facoltativo) Configura Google Analytics per il tuo progetto, in modo da poter usufruire di un'esperienza ottimale con uno dei seguenti prodotti Firebase:

   Firebase Crashlytics Firebase Cloud Messaging

   Firebase In-App Messaging Firebase Remote Config

   Remote Config Personalizzazione Firebase A/B Testing

   Seleziona un account Google Analytics esistente o creane uno nuovo.

   Se crei un nuovo account, seleziona la Analytics località dei report, quindi accetta le impostazioni di condivisione dei dati e i termini di Google Analytics per il tuo progetto.

5. Fai clic su Crea progetto (o Aggiungi Firebase, se utilizzi un progetto Google Cloud esistente).

Firebase esegue automaticamente il provisioning delle risorse per il tuo progetto Firebase. Al termine della procedura, nella console Firebase verrà visualizzata la pagina Panoramica del progetto Firebase.

Configura l'ambiente e l'interfaccia a riga di comando di Firebase

Inizializza il progetto

Quando inizili l'SDK Firebase per Cloud Functions, crei un progetto vuoto contenente dipendenze e un codice di esempio minimo. Se utilizzi Node.js, puoi scegliere tra TypeScript o JavaScript per comporre le funzioni. Ai fini di questo tutorial, dovrai anche inizializzare Cloud Firestore.

Per inizializzare il progetto:

1. Esegui firebase login per accedere tramite il browser e autenticare l'interfaccia a riga di comando Firebase.
2. Vai alla directory del progetto Firebase.
3. Esegui firebase init firestore. Per questo tutorial, puoi accettare i valori predefiniti quando ti viene chiesto di specificare le regole e i file di indicizzazione di Firestore. Se non hai ancora utilizzato Cloud Firestore in questo progetto, dovrai anche selezionare una modalità di avvio e una posizione per Firestore come descritto in Iniziare a utilizzare Cloud Firestore.
4. Esegui firebase init functions. La CLI ti chiede di scegliere un codebase esistente o di inizializzarne e nominarne uno nuovo. Quando stai appena iniziando, una singola base di codice nella posizione predefinita è sufficiente; in seguito, man mano che l'implementazione si espande, potresti voler organizzare le funzioni nelle basi di codice.

5. La CLI offre le seguenti opzioni per il supporto della lingua:

   • JavaScript
   • TypeScript
   • Python

   Per questo tutorial, seleziona JavaScript o Python. Per la creazione di script in TypeScript, consulta Scrivere funzioni con TypeScript.

6. La CLI offre un'opzione per installare le dipendenze. Puoi rifiutare in tutta sicurezza se vuoi gestire le dipendenze in un altro modo.

Una volta completati questi comandi, la struttura del progetto sarà simile a questa:

myproject
+- .firebaserc    # Hidden file that helps you quickly switch between
|                 # projects with `firebase use`
|
+- firebase.json  # Describes properties for your project
|
+- functions/     # Directory containing all your functions code
      |
      +- .eslintrc.json  # Optional file containing rules for JavaScript linting.
      |
      +- package.json  # npm package file describing your Cloud Functions code
      |
      +- index.js      # Main source file for your Cloud Functions code
      |
      +- node_modules/ # Directory where your dependencies (declared in
                        # package.json) are installed

myproject
+- .firebaserc    # Hidden file that helps you quickly switch between
|                 # projects with `firebase use`
|
+- firebase.json  # Describes properties for your project
|
+- functions/     # Directory containing all your functions code
      |
      +- main.py      # Main source file for your Cloud Functions code
      |
      +- requirements.txt  #  List of the project's modules and packages 
      |
      +- venv/ # Directory where your dependencies are installed

Importa i moduli richiesti e inizializza un'app

Dopo aver completato le attività di configurazione, puoi aprire la directory di origine e iniziare ad aggiungere codice come descritto nelle sezioni seguenti. Per questo esempio, il progetto deve importare i moduli Cloud Functions e SDK Admin. Aggiungi righe come la seguente al file di origine:

// The Cloud Functions for Firebase SDK to create Cloud Functions and triggers.
const {logger} = require("firebase-functions");
const {onRequest} = require("firebase-functions/v2/https");
const {onDocumentCreated} = require("firebase-functions/v2/firestore");

// The Firebase Admin SDK to access Firestore.
const {initializeApp} = require("firebase-admin/app");
const {getFirestore} = require("firebase-admin/firestore");

initializeApp();
index.js

# The Cloud Functions for Firebase SDK to create Cloud Functions and set up triggers.
from firebase_functions import firestore_fn, https_fn

# The Firebase Admin SDK to access Cloud Firestore.
from firebase_admin import initialize_app, firestore
import google.cloud.firestore

app = initialize_app()
main.py

Queste righe caricano i moduli richiesti e inizializzano un'istanza dell'app admin da cui è possibile apportare modifiche a Cloud Firestore. Ovunque sia disponibile il supporto dell'SDK Admin, come avviene per FCM, Authentication e Firebase Realtime Database, offre un modo efficace per integrare Firebase utilizzando Cloud Functions.

La CLI Firebase installa automaticamente l'SDK Firebase Admin e l'SDK Firebase per i moduli Cloud Functions quando inizializza il progetto. Per ulteriori informazioni sull'aggiunta di librerie di terze parti al progetto, consulta Gestire le dipendenze.

Aggiungi la funzione "Aggiungi messaggio"

Per la funzione "add message", aggiungi queste righe al file di origine:

// Take the text parameter passed to this HTTP endpoint and insert it into
// Firestore under the path /messages/:documentId/original
exports.addmessage = onRequest(async (req, res) => {
  // Grab the text parameter.
  const original = req.query.text;
  // Push the new message into Firestore using the Firebase Admin SDK.
  const writeResult = await getFirestore()
      .collection("messages")
      .add({original: original});
  // Send back a message that we've successfully written the message
  res.json({result: `Message with ID: ${writeResult.id} added.`});
});
index.js

@https_fn.on_request()
def addmessage(req: https_fn.Request) -> https_fn.Response:
    """Take the text parameter passed to this HTTP endpoint and insert it into
    a new document in the messages collection."""
    # Grab the text parameter.
    original = req.args.get("text")
    if original is None:
        return https_fn.Response("No text parameter provided", status=400)

    firestore_client: google.cloud.firestore.Client = firestore.client()

    # Push the new message into Cloud Firestore using the Firebase Admin SDK.
    _, doc_ref = firestore_client.collection("messages").add({"original": original})

    # Send back a message that we've successfully written the message
    return https_fn.Response(f"Message with ID {doc_ref.id} added.")
main.py

La funzione "add message" è un endpoint HTTP. Qualsiasi richiesta all'endpoint genera oggetti di richiesta e risposta passati al gestore delle richieste per la tua piattaforma (onRequest() o on_request).

Le funzioni HTTP sono sincrone (simili alle funzioni richiamabili), quindi devi inviare una risposta il più rapidamente possibile e rimandare il lavoro utilizzando Cloud Firestore. La funzione HTTP "add message" passa un valore di testo all'endpoint HTTP e lo inserisce nel database nel percorso /messages/:documentId/original.

Aggiungi la funzione "Maiuscolo"

Per la funzione "make uppercase", aggiungi queste righe al file sorgente:

// Listens for new messages added to /messages/:documentId/original
// and saves an uppercased version of the message
// to /messages/:documentId/uppercase
exports.makeuppercase = onDocumentCreated("/messages/{documentId}", (event) => {
  // Grab the current value of what was written to Firestore.
  const original = event.data.data().original;

  // Access the parameter `{documentId}` with `event.params`
  logger.log("Uppercasing", event.params.documentId, original);

  const uppercase = original.toUpperCase();

  // You must return a Promise when performing
  // asynchronous tasks inside a function
  // such as writing to Firestore.
  // Setting an 'uppercase' field in Firestore document returns a Promise.
  return event.data.ref.set({uppercase}, {merge: true});
});
index.js

@firestore_fn.on_document_created(document="messages/{pushId}")
def makeuppercase(event: firestore_fn.Event[firestore_fn.DocumentSnapshot | None]) -> None:
    """Listens for new documents to be added to /messages. If the document has
    an "original" field, creates an "uppercase" field containg the contents of
    "original" in upper case."""

    # Get the value of "original" if it exists.
    if event.data is None:
        return
    try:
        original = event.data.get("original")
    except KeyError:
        # No "original" field, so do nothing.
        return

    # Set the "uppercase" field.
    print(f"Uppercasing {event.params['pushId']}: {original}")
    upper = original.upper()
    event.data.reference.update({"uppercase": upper})
main.py

La funzione "make uppercase" viene eseguita quando viene scritto in Cloud Firestore, definendo il documento da ascoltare. Per motivi di rendimento, devi essere il più specifico possibile.

Le parentesi graffe, ad esempio {documentId}, contengono i "parametri", ovvero i caratteri jolly che espongono i dati corrispondenti nel callback. Cloud Firestore attiva il callback ogni volta che vengono aggiunti nuovi messaggi.

In Node.js, le funzioni basate su eventi come gli eventi Cloud Firestore sono asincrone. La funzione di callback deve restituire un null, un oggetto o una promessa. Se non restituisci nulla, la funzione scade, segnala un errore e viene eseguito nuovamente il tentativo. Consulta Sincronizzazione, asincronia e promesse.

Emulare l'esecuzione delle funzioni

Firebase Local Emulator Suite consente di creare e testare le app sulla tua macchina locale anziché eseguire il deployment in un progetto Firebase. Si consiglia vivamente di eseguire test locali durante lo sviluppo, in parte perché riduce il rischio di errori di programmazione che potrebbero comportare costi in un ambiente di produzione (ad esempio un ciclo infinito).

Per emulare le funzioni:

1. Esegui firebase emulators:start e controlla l'output per l'URL del Emulator Suite UI. L'impostazione predefinita è localhost:4000, ma potrebbe essere ospitata su una porta diversa della tua macchina. Inserisci l'URL nel browser per aprire Emulator Suite UI.

2. Controlla l'output del comando firebase emulators:start per l'URL della funzione HTTP. Sarà simile a http://localhost:5001/MY_PROJECT/us-central1/addMessage, tranne che:

   1. MY_PROJECT verrà sostituito con l'ID del tuo progetto.
   2. La porta potrebbe essere diversa sulla tua macchina locale.

3. Aggiungi la stringa di query ?text=uppercaseme alla fine dell'URL della funzione. Dovrebbe avere un aspetto simile a questo: http://localhost:5001/MY_PROJECT/us-central1/addMessage?text=uppercaseme. Se vuoi, puoi cambiare il messaggio "uppercaseme" con un messaggio personalizzato.

4. Crea un nuovo messaggio aprendo l'URL in una nuova scheda del browser.

5. Visualizza gli effetti delle funzioni in Emulator Suite UI:

   1. Nella scheda Log dovresti vedere nuovi log che indicano che le funzioni HTTP sono state eseguite correttamente:

      i functions: Beginning execution of "addMessage"

      i functions: Beginning execution of "makeUppercase"

   2. Nella scheda Firestore dovresti vedere un documento contenente il messaggio originale e la versione in maiuscolo del messaggio (se inizialmente era "uppercaseme", vedrai "UPPERCASEME").

Esegui il deployment delle funzioni in un ambiente di produzione

Una volta che le funzioni funzionano come previsto nell'emulatore, puoi procedere con il loro deployment, il test e l'esecuzione nell'ambiente di produzione. Tieni presente che per eseguire il deployment in produzione, il progetto deve essere nel piano tariffario Blaze. Consulta i prezzi di Cloud Functions.

Per completare il tutorial, esegui il deployment delle funzioni e poi eseguile.

1. Esegui questo comando per eseguire il deployment delle funzioni:

    firebase deploy --only functions
    

   Dopo aver eseguito questo comando, l'interfaccia a riga di comando Firebase stampa l'URL di eventuali endpoint della funzione HTTP. Nel terminale dovresti vedere una riga simile alla seguente:

   Function URL (addMessage): https://us-central1-MY_PROJECT.cloudfunctions.net/addMessage
   

   L'URL contiene il tuo ID progetto e una regione per la funzione HTTP. Anche se non devi preoccuparti ora, alcune funzioni HTTP di produzione devono specificare una posizione per ridurre al minimo la latenza della rete.

   Se riscontri errori di accesso come "Impossibile autorizzare l'accesso al progetto", prova a controllare l'alias del progetto.

2. Utilizzando l'URL visualizzato dalla CLI, aggiungi un parametro di query di testo e apri l'URL in un browser:

   https://us-central1-MY_PROJECT.cloudfunctions.net/addMessage?text=uppercasemetoo
   

   La funzione viene eseguita e reindirizza il browser alla console Firebase nella posizione del database in cui è archiviata la stringa di testo. Questo evento di scrittura attiva la funzione "make uppercase", che scrive una versione in lettere uppercase della stringa.

Dopo aver eseguito il deployment ed eseguito le funzioni, puoi visualizzare i log nella console Google Cloud. Se devi eliminare funzioni in fase di sviluppo o di produzione, utilizza l'interfaccia a riga di comando Firebase.

In produzione, ti consigliamo di ottimizzare le prestazioni delle funzioni e di controllare i costi impostando il numero minimo e massimo di istanze da eseguire. Per ulteriori informazioni su queste opzioni di runtime, consulta Controllare il comportamento di scalabilità.

Passaggi successivi

In questa documentazione puoi scoprire di più su come gestire le funzioni per Cloud Functions, nonché su come gestire tutti i tipi di eventi supportati da Cloud Functions.

Per scoprire di più su Cloud Functions, puoi anche:

• Scopri di più sui casi d'uso per Cloud Functions.
• Prova il codelab Cloud Functions.
• Rivedi ed esegui esempi di codice su GitHub