Dzięki Cloud Functions możesz obsługiwać zdarzenia w Cloud Firestore bez konieczności aktualizowania kodu klienta. Zmiany w Cloud Firestore możesz wprowadzać za pomocą interfejsu DocumentSnapshot
lub pakietu Admin SDK .
W typowym cyklu życia funkcja Cloud Firestore wykonuje następujące czynności:
- Czeka na zmiany w konkretnym dokumencie.
- Wyzwala, gdy wystąpi zdarzenie i wykonuje swoje zadania (zobacz Co mogę zrobić z Cloud Functions?, aby zapoznać się z przykładami użycia).
- Otrzymuje obiekt danych zawierający migawkę danych przechowywanych w określonym dokumencie. W przypadku zdarzeń
onWrite
lubonUpdate
obiekt danych zawiera dwie migawki, które reprezentują stan danych przed i po zdarzeniu wyzwalającym.
Odległość między lokalizacją instancji Firestore a lokalizacją funkcji może powodować znaczne opóźnienia w sieci. Aby zoptymalizować wydajność, rozważ określenie lokalizacji funkcji tam, gdzie ma to zastosowanie.
Wyzwalacze funkcji Cloud Firestore
Pakiet SDK Cloud Functions dla Firebase eksportuje obiekt functions.firestore
, który umożliwia tworzenie modułów obsługi powiązanych z określonymi zdarzeniami Cloud Firestore.
Typ wydarzenia | Cyngiel |
---|---|
onCreate | Wywoływane, gdy dokument jest pisany po raz pierwszy. |
onUpdate | Wywoływane, gdy dokument już istnieje i ma zmienioną dowolną wartość. |
onDelete | Wywoływane po usunięciu dokumentu z danymi. |
onWrite | Wywoływane po onCreate , onUpdate lub onDelete . |
Jeśli nie masz jeszcze projektu w Cloud Functions dla Firebase, przeczytaj artykuł Pierwsze kroki: pisanie i wdrażanie pierwszych funkcji , aby skonfigurować i skonfigurować projekt Cloud Functions dla Firebase.
Pisanie funkcji uruchamianych przez Cloud Firestore
Zdefiniuj wyzwalacz funkcji
Aby zdefiniować wyzwalacz Cloud Firestore, określ ścieżkę dokumentu i typ zdarzenia:
Node.js
const functions = require('firebase-functions');
exports.myFunction = functions.firestore
.document('my-collection/{docId}')
.onWrite((change, context) => { /* ... */ });
Ścieżki dokumentów mogą odwoływać się do określonego dokumentu lub wzorca wieloznacznego .
Określ jeden dokument
Jeśli chcesz wywołać zdarzenie dla dowolnej zmiany w określonym dokumencie, możesz użyć następującej funkcji.
Node.js
// Listen for any change on document `marie` in collection `users` exports.myFunctionName = functions.firestore .document('users/marie').onWrite((change, context) => { // ... Your code here });
Określ grupę dokumentów za pomocą symboli wieloznacznych
Jeśli chcesz dołączyć wyzwalacz do grupy dokumentów, na przykład dowolnego dokumentu z określonej kolekcji, użyj {wildcard}
zamiast identyfikatora dokumentu:
Node.js
// Listen for changes in all documents in the 'users' collection exports.useWildcard = functions.firestore .document('users/{userId}') .onWrite((change, context) => { // If we set `/users/marie` to {name: "Marie"} then // context.params.userId == "marie" // ... and ... // change.after.data() == {name: "Marie"} });
W tym przykładzie, gdy dowolne pole w dowolnym dokumencie w users
zostanie zmienione, dopasuje się do symbolu wieloznacznego o nazwie userId
.
Jeśli dokument w users
zawiera kolekcje podrzędne, a pole w jednym z dokumentów tych podzbiorów zostanie zmienione, symbol wieloznaczny userId
nie zostanie wywołany.
Dopasowania z symbolami wieloznacznymi są wyodrębniane ze ścieżki dokumentu i przechowywane w context.params
. Możesz zdefiniować tyle symboli wieloznacznych, ile chcesz, aby zastąpić jawne identyfikatory kolekcji lub dokumentów, na przykład:
Node.js
// Listen for changes in all documents in the 'users' collection and all subcollections exports.useMultipleWildcards = functions.firestore .document('users/{userId}/{messageCollectionId}/{messageId}') .onWrite((change, context) => { // If we set `/users/marie/incoming_messages/134` to {body: "Hello"} then // context.params.userId == "marie"; // context.params.messageCollectionId == "incoming_messages"; // context.params.messageId == "134"; // ... and ... // change.after.data() == {body: "Hello"} });
Wyzwalacze zdarzeń
Uruchom funkcję po utworzeniu nowego dokumentu
Możesz wywołać funkcję za każdym razem, gdy w kolekcji tworzony jest nowy dokument, używając procedury obsługi onCreate()
z symbolem wieloznacznym . Ta przykładowa funkcja wywołuje funkcję createUser
każdym razem, gdy dodawany jest nowy profil użytkownika:
Node.js
exports.createUser = functions.firestore .document('users/{userId}') .onCreate((snap, context) => { // Get an object representing the document // e.g. {'name': 'Marie', 'age': 66} const newValue = snap.data(); // access a particular field as you would any JS property const name = newValue.name; // perform desired operations ... });
Uruchom funkcję, gdy dokument zostanie zaktualizowany
Możesz także uruchomić funkcję, gdy dokument zostanie zaktualizowany, używając funkcji onUpdate()
z symbolem wieloznacznym . Ta przykładowa funkcja wywołuje updateUser
, jeśli użytkownik zmieni swój profil:
Node.js
exports.updateUser = functions.firestore .document('users/{userId}') .onUpdate((change, context) => { // Get an object representing the document // e.g. {'name': 'Marie', 'age': 66} const newValue = change.after.data(); // ...or the previous value before this update const previousValue = change.before.data(); // access a particular field as you would any JS property const name = newValue.name; // perform desired operations ... });
Uruchom funkcję po usunięciu dokumentu
Możesz także wyzwolić funkcję po usunięciu dokumentu za pomocą funkcji onDelete()
z symbolem wieloznacznym . Ta przykładowa funkcja wywołuje funkcję deleteUser
, gdy użytkownik usuwa swój profil użytkownika:
Node.js
exports.deleteUser = functions.firestore .document('users/{userID}') .onDelete((snap, context) => { // Get an object representing the document prior to deletion // e.g. {'name': 'Marie', 'age': 66} const deletedValue = snap.data(); // perform desired operations ... });
Uruchom funkcję dla wszystkich zmian w dokumencie
Jeśli nie zależy Ci na typie uruchamianego zdarzenia, możesz nasłuchiwać wszystkich zmian w dokumencie Cloud Firestore za pomocą funkcji onWrite()
z symbolem wieloznacznym . Ta przykładowa funkcja wywołuje modifyUser
użytkownika, jeśli użytkownik zostanie utworzony, zaktualizowany lub usunięty:
Node.js
exports.modifyUser = functions.firestore .document('users/{userID}') .onWrite((change, context) => { // Get an object with the current document value. // If the document does not exist, it has been deleted. const document = change.after.exists ? change.after.data() : null; // Get an object with the previous document value (for update or delete) const oldDocument = change.before.data(); // perform desired operations ... });
Odczytywanie i zapisywanie danych
Gdy funkcja zostanie wyzwolona, zapewnia migawkę danych związanych ze zdarzeniem. Możesz użyć tego zrzutu, aby odczytywać lub zapisywać w dokumencie, który wywołał zdarzenie, albo użyć pakietu Firebase Admin SDK, aby uzyskać dostęp do innych części bazy danych.
Dane zdarzenia
Czytanie danych
Gdy funkcja zostanie wyzwolona, możesz chcieć pobrać dane z dokumentu, który został zaktualizowany lub pobrać dane przed aktualizacją. Wcześniejsze dane można uzyskać za pomocą metody change.before.data()
, która zawiera migawkę dokumentu przed aktualizacją. Podobnie change.after.data()
zawiera stan migawki dokumentu po aktualizacji.
Node.js
exports.updateUser2 = functions.firestore .document('users/{userId}') .onUpdate((change, context) => { // Get an object representing the current document const newValue = change.after.data(); // ...or the previous value before this update const previousValue = change.before.data(); });
Możesz uzyskać dostęp do właściwości tak jak w każdym innym obiekcie. Alternatywnie możesz użyć funkcji get
, aby uzyskać dostęp do określonych pól:
Node.js
// Fetch data using standard accessors const age = snap.data().age; const name = snap.data()['name']; // Fetch data using built in accessor const experience = snap.get('experience');
Zapisywanie danych
Każde wywołanie funkcji jest powiązane z konkretnym dokumentem w Twojej bazie danych Cloud Firestore. Możesz uzyskać dostęp do tego dokumentu jako DocumentReference
we właściwości ref
migawki zwróconej do funkcji.
Ten DocumentReference
pochodzi z pakietu SDK Cloud Firestore Node.js i zawiera metody takie jak update()
, set()
i remove()
, dzięki czemu można łatwo modyfikować dokument, który wyzwolił funkcję.
Node.js
// Listen for updates to any `user` document. exports.countNameChanges = functions.firestore .document('users/{userId}') .onUpdate((change, context) => { // Retrieve the current and previous value const data = change.after.data(); const previousData = change.before.data(); // We'll only update if the name has changed. // This is crucial to prevent infinite loops. if (data.name == previousData.name) { return null; } // Retrieve the current count of name changes let count = data.name_change_count; if (!count) { count = 0; } // Then return a promise of a set operation to update the count return change.after.ref.set({ name_change_count: count + 1 }, {merge: true}); });
Dane poza zdarzeniem wyzwalającym
Funkcje Cloud Functions działają w zaufanym środowisku, co oznacza, że są autoryzowane jako konto usługi w Twoim projekcie. Możesz wykonywać odczyty i zapisy za pomocą pakietu Firebase Admin SDK :
Node.js
const admin = require('firebase-admin');
admin.initializeApp();
const db = admin.firestore();
exports.writeToFirestore = functions.firestore
.document('some/doc')
.onWrite((change, context) => {
db.doc('some/otherdoc').set({ ... });
});
Ograniczenia
Zwróć uwagę na następujące ograniczenia wyzwalaczy Cloud Firestore dla Cloud Functions:
- Zamówienie nie jest gwarantowane. Szybkie zmiany mogą wyzwalać wywołania funkcji w nieoczekiwanej kolejności.
- Zdarzenia są dostarczane co najmniej raz, ale jedno zdarzenie może skutkować wieloma wywołaniami funkcji. Unikaj polegania na mechanice dokładnie raz i pisz funkcje idempotentne .
- Wyzwalacze Cloud Firestore dla Cloud Functions są dostępne tylko dla Cloud Firestore w trybie natywnym . Nie jest dostępna w Cloud Firestore w trybie Datastore.