Realtime Database-Trigger

Mit Cloud Functions können Sie Ereignisse in der Firebase Realtime Database verarbeiten, ohne den Clientcode aktualisieren zu müssen. Mit Cloud Functions können Sie Realtime Database-Vorgänge mit vollem Verwaltungsaufwand ausführen Berechtigungen und stellt sicher, dass jede Änderung an Realtime Database verarbeitet wird. individuell anpassen. Sie können Firebase Realtime Database-Änderungen über die DataSnapshot oder über das Admin SDK vornehmen.

In einem typischen Lebenszyklus führt eine Firebase Realtime Database-Funktion so vor:

1. Sie wartet auf Änderungen an einem bestimmten Realtime Database-Speicherort.
2. Wird ausgelöst, wenn ein Ereignis eintritt, und führt die zugehörigen Aufgaben aus (siehe Was kann ich tun mit Cloud Functions? für Beispiele für Anwendungsfälle).
3. Sie empfängt ein Datenobjekt, das einen Snapshot der gespeicherten Daten enthält im angegebenen Dokument.

Realtime Database-Funktion auslösen

Neue Funktionen für Realtime Database-Ereignisse erstellen mit functions.database. Wenn Sie festlegen möchten, wann die Funktion ausgelöst wird, geben Sie einen der Ereignishandler und den Realtime Database-Pfad an, unter dem auf Ereignisse gewartet werden soll.

Event-Handler festlegen

Mit Cloud Functions können Sie Realtime Database-Ereignisse mit zwei Spezifitätsgraden verarbeiten: Sie können gezielt nur nach Erstellungs-, Aktualisierungs- oder Löschereignissen oder nach beliebigen Änderungen jeglicher Art an einem Pfad Ausschau halten. Cloud Functions unterstützt diese Event-Handler für Realtime Database:

• onWrite(): wird ausgelöst, wenn Daten in Realtime Database erstellt, aktualisiert oder gelöscht werden.
• onCreate(), was ausgelöst wird, wenn in Realtime Database neue Daten erstellt werden
• onUpdate(), der ausgelöst wird, wenn Daten in Realtime Database aktualisiert werden.
• onDelete(), was ausgelöst wird, wenn Daten aus Realtime Database gelöscht werden .

Instanz und Pfad angeben

Wenn Sie festlegen möchten, wann und wo Ihre Funktion ausgelöst werden soll, rufen Sie ref(path) auf, um einen Pfad anzugeben, und optional eine Realtime Database-Instanz mit instance('INSTANCE_NAME'). Wenn Sie keine Instanz angeben, wird die Funktion für die Standard-Realtime Database-Instanz des Firebase-Projekts bereitgestellt. Beispiel:

• Standardinstanz Realtime Database: functions.database.ref('/foo/bar')
• Instanz mit dem Namen „my-app-db-2“: functions.database.instance('my-app-db-2').ref('/foo/bar')

Diese Methoden weisen Ihre Funktion an, Schreibvorgänge unter einem bestimmten Pfad innerhalb Die Instanz Realtime Database. Die Pfadspezifikationen gleichen alle Schreibvorgänge ab, die einen Pfad tangieren, einschließlich Schreibvorgängen, die an einem beliebigen untergeordneten Punkt auftreten. Wenn Sie als Pfad für Ihre Funktion /foo/bar festlegen, werden die Ereignisse an diesen beiden Speicherorten abgeglichen:

 /foo/bar
 /foo/bar/baz/really/deep/path

In beiden Fällen geht Firebase davon aus, dass das Ereignis unter /foo/bar auftritt, und die Ereignisdaten enthalten die alten und neuen Daten unter /foo/bar. Wenn die Ereignisdaten sehr umfangreich sein können, sollten Sie erwägen, mehrere Funktionen auf tieferen Pfadebenen anstatt lediglich einer Funktion im Bereich des Datenbankstamms zu verwenden. Für optimale Leistung sollten Sie Daten nur auf der untersten Ebene anfordern.

Sie können eine Pfadkomponente als Platzhalter angeben, indem Sie sie in geschweifte Klammern setzen. ref('foo/{bar}') entspricht allen untergeordneten Elementen von /foo. Die Werte dieser Platzhalterpfadkomponenten sind innerhalb des EventContext.params-Objekts Ihrer Funktion verfügbar. In diesem Beispiel ist der Wert als context.params.bar

Pfade mit Platzhaltern können mit mehreren Ereignissen aus einem einzigen Schreibvorgang übereinstimmen. Die Verwendung von

{
  "foo": {
    "hello": "world",
    "firebase": "functions"
  }
}

ergibt zwei Übereinstimmungen mit dem Pfad "/foo/{bar}": einmal "hello": "world" und einmal "firebase": "functions".

Ereignisdaten verarbeiten

Bei der Verarbeitung eines Realtime Database-Ereignisses wird ein DataSnapshot Bei onWrite- oder onUpdate-Ereignissen ist der erste Parameter ein Change-Objekt mit zwei Snapshots, die den Datenstatus vor und nach dem auslösenden Ereignis darstellen. Für onCreate- und onDelete-Ereignisse: Das zurückgegebene Datenobjekt ist ein Snapshot der erstellten oder gelöschten Daten.

In diesem Beispiel ruft die Funktion den Snapshot für den angegebenen Pfad ab, wandelt den String an dieser Stelle in Großbuchstaben um und schreibt den geänderten String in die Datenbank:

// Listens for new messages added to /messages/:pushId/original and creates an
// uppercase version of the message to /messages/:pushId/uppercase
exports.makeUppercase = functions.database.ref('/messages/{pushId}/original')
    .onCreate((snapshot, context) => {
      // Grab the current value of what was written to the Realtime Database.
      const original = snapshot.val();
      functions.logger.log('Uppercasing', context.params.pushId, original);
      const uppercase = original.toUpperCase();
      // You must return a Promise when performing asynchronous tasks inside a Functions such as
      // writing to the Firebase Realtime Database.
      // Setting an "uppercase" sibling in the Realtime Database returns a Promise.
      return snapshot.ref.parent.child('uppercase').set(uppercase);
    });
index.js

Zugriff auf Informationen zur Nutzerauthentifizierung

Von EventContext.auth und EventContext.authType, können Sie auf die Nutzerinformationen, einschließlich Berechtigungen, für den Nutzer, der die eine Funktion. Das kann hilfreich sein, um Sicherheitsregeln durchzusetzen, sodass Ihre Funktion je nach Berechtigungsstufe des Nutzers unterschiedliche Vorgänge ausführen kann:

const functions = require('firebase-functions/v1');
const admin = require('firebase-admin');

exports.simpleDbFunction = functions.database.ref('/path')
    .onCreate((snap, context) => {
      if (context.authType === 'ADMIN') {
        // do something
      } else if (context.authType === 'USER') {
        console.log(snap.val(), 'written by', context.auth.uid);
      }
    });

Außerdem können Sie Informationen zur Nutzerauthentifizierung nutzen, um sich als Nutzer auszugeben und im Namen des Nutzers Schreibvorgänge auszuführen. Vergessen Sie nicht, die App-Instanz wie unten gezeigt an, um Gleichzeitigkeitsprobleme zu vermeiden:

exports.impersonateMakeUpperCase = functions.database.ref('/messages/{pushId}/original')
    .onCreate((snap, context) => {
      const appOptions = JSON.parse(process.env.FIREBASE_CONFIG);
      appOptions.databaseAuthVariableOverride = context.auth;
      const app = admin.initializeApp(appOptions, 'app');
      const uppercase = snap.val().toUpperCase();
      const ref = snap.ref.parent.child('uppercase');

      const deleteApp = () => app.delete().catch(() => null);

      return app.database().ref(ref).set(uppercase).then(res => {
        // Deleting the app is necessary for preventing concurrency leaks
        return deleteApp().then(() => res);
      }).catch(err => {
        return deleteApp().then(() => Promise.reject(err));
      });
    });

Vorherigen Wert lesen

Das Change-Objekt hat die Eigenschaft before, mit der Sie prüfen können, was vor dem Ereignis in Realtime Database gespeichert wurde . Die Property before gibt einen DataSnapshot zurück, bei dem alle Methoden (z. B. val() und exists()) auf den vorherigen Wert verweisen. Sie können den neuen Wert entweder mit Original-DataSnapshot oder Lesen der after Property. Diese Property auf einem beliebigen Change ist ein anderer DataSnapshot, der für den Status der Daten nach dem Ereignis.

Beispielsweise kann das Attribut before verwendet werden, um dafür zu sorgen, dass die Funktion nur Text bei seiner Erstellung in Großbuchstaben:

exports.makeUppercase = functions.database.ref('/messages/{pushId}/original')
    .onWrite((change, context) => {
      // Only edit data when it is first created.
      if (change.before.exists()) {
        return null;
      }
      // Exit when the data is deleted.
      if (!change.after.exists()) {
        return null;
      }
      // Grab the current value of what was written to the Realtime Database.
      const original = change.after.val();
      console.log('Uppercasing', context.params.pushId, original);
      const uppercase = original.toUpperCase();
      // You must return a Promise when performing asynchronous tasks inside a Functions such as
      // writing to the Firebase Realtime Database.
      // Setting an "uppercase" sibling in the Realtime Database returns a Promise.
      return change.after.ref.parent.child('uppercase').set(uppercase);
    });