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.

Abbiamo scelto le funzioni JavaScript Cloud Firestore e 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 attivatori Realtime Database, PubSub, Auth e chiamabili HTTP. Altri tipi di attivatori in background, come Remote Config, TestLab e gli attivatori di Analytics, 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. Se preferisci semplicemente eseguire il codice e ispezionarlo, vai a Esaminare il codice campione completo.

Crea 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:

    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 Node.js e l'interfaccia a riga di comando di Firebase

Per scrivere le funzioni, hai bisogno di un ambiente Node.js e dell'interfaccia a riga di comando Firebase per eseguire il deployment delle funzioni nel runtime Cloud Functions. Per installare Node.js e npm, è consigliato Node Version Manager.

Dopo aver installato Node.js e npm, installa l'interfaccia a riga di comando Firebase tramite il metodo che preferisci. Per installare l'interfaccia a riga di comando tramite npm, utilizza:

npm install -g firebase-tools

Viene installato il comando firebase disponibile a livello globale. Se il comando non va a buon fine, potresti dover modificare le autorizzazioni npm. Per eseguire l'aggiornamento alla versione più recente di firebase-tools, esegui di nuovo lo stesso comando.

Inizializza il progetto

Quando inizili l'SDK Firebase per Cloud Functions, crei un progetto vuoto contenente dipendenze e un codice di esempio minimo e scegli 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 due opzioni per il supporto linguistico:

    Per questo tutorial, seleziona JavaScript.

  6. L'interfaccia a riga di comando ti offre la possibilità di installare le dipendenze con npm. Puoi rifiutare se vuoi gestire le dipendenze in un altro modo, ma se lo fai dovrai eseguire npm install prima di emulare o eseguire il deployment delle funzioni.

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

Il file package.json creato durante l'inizializzazione contiene una chiave importante: "engines": {"node": "16"}. Specifica la versione di Node.js per scrivere ed eseguire il deployment delle funzioni. Puoi selezionare altre versioni supportate.

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 utilizzando le istruzioni Node require. Aggiungi righe come la seguente al file index.js:

// The Cloud Functions for Firebase SDK to create Cloud Functions and set up triggers.
const functions = require('firebase-functions/v1');

// The Firebase Admin SDK to access Firestore.
const admin = require("firebase-admin");
admin.initializeApp();
index.js

Queste righe caricano i moduli firebase-functions e firebase-admin 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.

L'interfaccia a riga di comando Firebase installa automaticamente gli SDK Firebase e Firebase per i moduli Node Cloud Functions quando inizili il progetto. Per aggiungere librerie di terze parti al tuo progetto, puoi modificare package.json ed eseguire npm install. Per ulteriori informazioni, consulta Gestire le dipendenze.

Aggiungi la funzione addMessage()

Per la funzione addMessage(), aggiungi queste righe a index.js:

// Take the text parameter passed to this HTTP endpoint and insert it into
// Firestore under the path /messages/:documentId/original
exports.addMessage = functions.https.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 admin
    .firestore()
    .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

La funzione addMessage() è un endpoint HTTP. Qualsiasi richiesta all'endpoint genera oggetti Request e Response in stile ExpressJS passati al callback onRequest().

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 addMessage() passa un valore di testo all'endpoint HTTP e lo inserisce nel database nel percorso /messages/:documentId/original.

Aggiungi la funzione makeUppercase()

Per la funzione makeUppercase(), aggiungi queste righe a index.js:

// Listens for new messages added to /messages/:documentId/original and creates an
// uppercase version of the message to /messages/:documentId/uppercase
exports.makeUppercase = functions.firestore
  .document("/messages/{documentId}")
  .onCreate((snap, context) => {
    // Grab the current value of what was written to Firestore.
    const original = snap.data().original;

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

    const uppercase = original.toUpperCase();

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

La funzione makeUppercase() viene eseguita quando viene scritta in Cloud Firestore. La funzione ref.set definisce il documento su cui 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 onCreate() ogni volta che vengono aggiunti nuovi messaggi.

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 app sulla tua macchina locale anziché eseguire il deployment in un progetto Firebase. Si consiglia vivamente di eseguire test locali durante lo sviluppo, anche perché riducono 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 addMessage(). 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 addMessage() e makeUppercase() sono state eseguite:

      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 nell'ambiente di runtime Node.js 14 consigliato, il tuo progetto deve essere attivo sul piano tariffario Blaze. Consulta i prezzi di Cloud Functions.

Per completare il tutorial, esegui il deployment delle funzioni ed esegui addMessage() per attivare makeUppercase().

  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 addMessage() 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 makeUppercase(), che scrive una versione in lettere maiuscole 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à.

Esamina il codice di esempio completo

Ecco il functions/index.js completato contenente le funzioni addMessage() e makeUppercase(). Queste funzioni ti consentono di passare un parametro a un endpoint HTTP che scrive un valore in Cloud Firestore e poi lo trasforma mettendo tutti i caratteri della stringa in maiuscolo.

// The Cloud Functions for Firebase SDK to create Cloud Functions and set up triggers.
const functions = require('firebase-functions/v1');

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

// Take the text parameter passed to this HTTP endpoint and insert it into
// Firestore under the path /messages/:documentId/original
exports.addMessage = functions.https.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 admin
    .firestore()
    .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 creates an
// uppercase version of the message to /messages/:documentId/uppercase
exports.makeUppercase = functions.firestore
  .document("/messages/{documentId}")
  .onCreate((snap, context) => {
    // Grab the current value of what was written to Firestore.
    const original = snap.data().original;

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

    const uppercase = original.toUpperCase();

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

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: