Mit Cloud Functions (2. Generation) können Sie Funktionen als Reaktion auf benutzerdefinierte Ereignisse auslösen . Dies sind Ereignisse, die von speziellen oder zusätzlichen Ereignisanbietern bereitgestellt werden, im Gegensatz zu den Firebase-Ereignissen, die nativ vom Firebase SDK für Cloud-Funktionen unterstützt werden. Über benutzerdefinierte Ereignisauslöser kann Ihre App auf Ereignisse reagieren, die von Firebase-Erweiterungen bereitgestellt werden, oder Sie können Ihre eigenen benutzerdefinierten Ereignisse veröffentlichen und als Reaktion darauf Funktionen auslösen.
Alle benutzerdefinierten Ereignisse entsprechen dem CloudEvents JSON-Ereignisformat und werden in Eventarc veröffentlicht. Eventarc- Nutzungsgebühren fallen an.
Auslösen von Funktionen mit benutzerdefinierten Ereignissen
Sie können benutzerdefinierte Ereignisse veröffentlichen (oder Ereignisse von Firebase-Erweiterungen abrufen) und Funktionen als Reaktion auf diese Ereignisse auslösen, indem Sie diesen grundlegenden Ablauf implementieren:
- Veröffentlichen Sie die gewünschten Ereignisse in einem Eventarc-Kanal oder identifizieren Sie verfügbare Ereignisse, die von einer von Ihnen installierten Erweiterung bereitgestellt werden.
- Abonnieren Sie in Ihrem Funktionscode Ereignisse im Eventarc-Kanal mit einem
onCustomEventPublishedHandler. - Analysieren Sie in der Funktion die im CloudEvent-Objekt zurückgegebene Nutzlast und führen Sie die benutzerdefinierte Logik aus, die Ihre App erfordert.
Beispielsweise möchte eine Spiele-App möglicherweise Benachrichtigungen an Benutzer senden, wenn sie die Bestenliste der zehn besten Wettbewerber betreten oder verlassen. Diese App könnte Leaderboard-Ereignisse im Standardkanal veröffentlichen und das Ereignis dann in einer Funktion verarbeiten, die gezielte Push-Benachrichtigungen an Benutzer sendet.
In einem anderen Beispiel könnte eine Erweiterung, die Apps helfen soll, große Bilder zu verarbeiten, ein Ereignis nach Abschluss der Bildgrößenänderung ausgeben. Apps mit dieser installierten Erweiterung könnten das Abschlussereignis verarbeiten, indem sie Links in der App so aktualisieren, dass sie auf verkleinerte Versionen des Bilds verweisen.
Veröffentlichen Sie ein Ereignis in einem Kanal
Eventarc-Ereignisse werden in Kanälen veröffentlicht. Kanäle sind eine Möglichkeit, verwandte Ereignisse zu gruppieren und Zugriffsberechtigungen zu verwalten. Wenn Sie eine Erweiterung installieren oder eine Funktion bereitstellen, die benutzerdefinierte Ereignisse nutzt, erstellt Firebase automatisch einen Standardkanal namens firebase in der Region us-central1 . Das Firebase Admin SDK stellt ein eventarc Unterpaket für die Veröffentlichung in Kanälen bereit.
So veröffentlichen Sie ein Ereignis von einem vertrauenswürdigen Server (oder einer anderen Funktion) über den Standardkanal:
import {getEventarc} from 'firebase-admin/eventarc';
getEventarc().channel().publish({
type: 'achieved-leaderboard',
subject: 'Welcome to the top 10',
data: {
message: 'You have achieved the nth position in our leaderboard! To see . . .'
}
});
Zusätzlich zum automatischen Erstellen des Standardkanals legt Firebase die Umgebungsvariable EVENTARC_CLOUD_EVENT_SOURCE fest, die die Quelle des Ereignisses angibt. Wenn Sie Ereignisse außerhalb von Cloud Functions for Firebase veröffentlichen, müssen Sie das source explizit zu Ihrer Ereignisnutzlast hinzufügen.
Behandeln Sie Ereignisse mit onCustomEventPublished
Sie können alle benutzerdefinierten Ereignisse, einschließlich Erweiterungsereignisse, mit dem onCustomEventPublished Handler verarbeiten. Importieren Sie zunächst diesen Handler aus dem Eventarc SDK zusammen mit dem Firebase Admin SDK für Node.js für Ihre benutzerdefinierte Logik und dem logger SDK für die Fehlerbehandlung:
const {onCustomEventPublished} = require("firebase-functions/v2/eventarc");
const logger = require("firebase-functions/logger");
const {initializeApp} = require("firebase-admin/app");
const {getFirestore} = require("firebase-admin/firestore");
Übergeben Sie in Ihrem Funktionscode den Ereignisnamen wie für die Beispielfunktion onimageresized gezeigt:
exports.onimageresized = onCustomEventPublished(
"firebase.extensions.storage-resize-images.v1.complete",
(event) => {
logger.info("Received image resize completed event", event);
// For example, write resized image details into Firestore.
return getFirestore()
.collection("images")
.doc(event.subject.replace("/", "_")) // original file path
.set(event.data); // resized images paths and sizes
});
Für jede einzelne Erweiterung stellt die im Ereignisobjekt zurückgegebene Nutzlast Daten bereit, die Sie verwenden können, um benutzerdefinierte Logik für Ihren Anwendungsfluss auszuführen. In diesem Fall verwendet die Funktion das Admin SDK, um Metadaten über das in der Größe geänderte Bild in eine Sammlung in Cloud Firestore zu kopieren, den Dateinamen aus dem vom Ereignis bereitgestellten subject abzurufen und Metadaten aus den vom Ereignis bereitgestellten data zu speichern.
Veröffentlichen und behandeln Sie Ereignisse auf nicht standardmäßigen Kanälen
Benutzerdefinierte Channels können in Fällen nützlich sein, in denen Sie spezielle Genehmigungsanforderungen oder andere Anforderungen haben und nicht für alle Ereignisse das gleiche Maß an Sichtbarkeit und Zugriff wünschen. Mit der Google Cloud-Konsole können Sie Ihre eigenen Kanäle erstellen. Das Veröffentlichen und Abonnieren von Veranstaltungen muss auf demselben Kanal erfolgen.
In Fällen, in denen ein benutzerdefiniertes Ereignis auf einem nicht standardmäßigen Kanal veröffentlicht wird, müssen Sie den Kanal in Ihrem Funktionscode angeben. Wenn Sie beispielsweise Ereignisse verarbeiten möchten, die in einem nicht standardmäßigen Kanal für den Standort us-west1 veröffentlicht werden, müssen Sie den Kanal wie gezeigt angeben:
import { onCustomEventPublished } from "firebase-functions/v2/eventarc";
export const func = onCustomEventPublished(
{
eventType: "firebase.extensions.storage-resize-images.v1.complete",
channel: "locations/us-west1/channels/firebase",
region: "us-west1",
},
(event) => { ... });