مشغِّلات Cloud Firestore

باستخدام دوال Cloud، يمكنك التعامل مع الأحداث في Cloud Firestore بدون الحاجة إلى تحديث رمز العميل. يمكنك إجراء تغييرات في Cloud Firestore من خلال واجهة لقطة المستند أو من خلال SDK للمشرف.

في دورة الحياة النموذجية، تؤدي دالة Cloud Firestore ما يلي:

1. لانتظار التغييرات في مستند معيّن.
2. يتم تشغيله عند وقوع حدث وتنفيذ مهامه.
3. يتلقى كائن بيانات يحتوي على لقطة من البيانات المخزنة في المستند المحدد. بالنسبة إلى أحداث الكتابة أو التحديث، يحتوي كائن البيانات على لقطتين تمثلان حالة البيانات قبل حدث التشغيل وبعده.

يمكن أن تؤدي المسافة بين موقع مثيل Firestore وموقع الدالة إلى إنشاء وقت استجابة كبير للشبكة. لتحسين الأداء، ننصحك بتحديد مكان الوظيفة حيث ينطبق ذلك.

مشغِّلات وظائف Cloud Firestore

تصدِّر حزمة Cloud Functions for Firebase كائن functions.firestore الذي يسمح لك بإنشاء معالِجات مرتبطة بأحداث معيّنة في Cloud Firestore.

إذا لم يكن لديك مشروع مفعَّل للوظائف السحابية لمنصة Firebase، يمكنك الاطّلاع على المقالة البدء: كتابة الدوال الأولى ونشرها لإعداد وظائف السحابة الإلكترونية لمشروع Firebase وإعدادها.

كتابة الدوال التي يتم تشغيلها في Cloud Firestore

تحديد مشغل الدالة

لتحديد مشغل Cloud Firestore، حدد مسار مستند ونوع حدث:

const functions = require('firebase-functions');

exports.myFunction = functions.firestore
  .document('my-collection/{docId}')
  .onWrite((change, context) => { /* ... */ });

يمكن أن تشير مسارات المستندات إلى مستند محدّد أو نمط حرف بدل.

تحديد مستند واحد

إذا أردت تشغيل حدث لأي تغيير في مستند معيّن، يمكنك استخدام الدالة التالية.

// Listen for any change on document `marie` in collection `users`
exports.myFunctionName = functions.firestore
    .document('users/marie').onWrite((change, context) => {
      // ... Your code here
    });
index.js

تحديد مجموعة من المستندات باستخدام أحرف البدل

إذا أردت إرفاق عامل تشغيل بمجموعة من المستندات، مثل أي مستند في مجموعة معيّنة، استخدِم {wildcard} بدلاً من معرّف المستند:

// 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"}
    });
index.js

في هذا المثال، عند تغيير أي حقل في أي مستند في users، يتطابق مع حرف بدل يُسمّى userId.

إذا كان مستند في users يحتوي على مجموعات فرعية وتم تغيير حقل في إحدى هذه المجموعات الفرعية، لن يتم تشغيل حرف البدل userId.

يتم استخراج تطابقات أحرف البدل من مسار المستند وتخزينها في context.params. يمكنك تحديد العدد الذي تريده من أحرف البدل لاستبدال معرّفات المجموعة أو المستندات الصريحة، على سبيل المثال:

// 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"}
    });
index.js

عوامل تشغيل الأحداث

تشغيل دالة عند إنشاء مستند جديد

يمكنك تشغيل دالة في أي وقت يتم فيه إنشاء مستند جديد في مجموعة، وذلك باستخدام معالج onCreate() مع حرف بدل. تستدعي الدالة المثال هذا createUser في كل مرة تتم فيها إضافة ملف شخصي جديد للمستخدم:

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 ...
    });
index.js

تشغيل دالة عند تعديل مستند

يمكنك أيضًا تشغيل دالة عند تعديل مستند باستخدام الدالة onUpdate() مع حرف بدل. تستدعي الدالة التالية المثال updateUser إذا غيّر المستخدم ملفه الشخصي:

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 ...
    });
index.js

تشغيل دالة عند حذف مستند

يمكنك أيضًا تشغيل دالة عند حذف مستند باستخدام الدالة onDelete() مع حرف بدل. يستدعي هذا المثال الدالة deleteUser عندما يحذف أحد المستخدمين الملف الشخصي للمستخدم:

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 ...
    });
index.js

تشغيل دالة لجميع التغييرات التي يتم إجراؤها على مستند

إذا لم تكن مهتمًا بنوع الحدث الذي يجري تنشيطه، يمكنك الاطّلاع على جميع التغييرات في مستند Cloud Firestore باستخدام الدالة onWrite() مع حرف بدل. يستدعي هذا المثال الدالة modifyUser إذا تم إنشاء مستخدم أو تعديله أو حذفه:

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 ...
    });
index.js

قراءة البيانات وكتابتها

عند تشغيل دالة، فإنها توفر لقطة من البيانات المتعلقة بالحدث. يمكنك استخدام هذه اللقطة للقراءة من المستند الذي بدأ الحدث أو الكتابة فيه، أو استخدام حزمة تطوير البرامج (SDK) لمشرف Firebase للوصول إلى أجزاء أخرى من قاعدة البيانات.

بيانات الأحداث

قراءة البيانات

عند تشغيل دالة، قد ترغب في الحصول على بيانات من مستند تم تحديثه، أو الحصول على البيانات قبل التحديث. يمكنك الحصول على البيانات السابقة باستخدام change.before.data()، التي تحتوي على نبذة عن المستند قبل التعديل. وبالمثل، يشتمل change.after.data() على حالة لقطة المستند بعد التحديث.

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();
    });
index.js

يمكنك الوصول إلى الخصائص كما تفعل في أي عنصر آخر. ويمكنك بدلاً من ذلك استخدام الدالة get للوصول إلى حقول محدّدة:

// 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');
index.js

كتابة البيانات

يرتبط كل استدعاء للدالة بمستند محدد في قاعدة بيانات Cloud Firestore. ويمكنك الوصول إلى هذا المستند على أنّه DocumentReference في السمة ref الخاصة باللقطة التي تعرضها الدالة.

تأتي DocumentReference من حزمة تطوير البرامج (SDK) الخاصة بـ Cloud Firestore Node.js وتشمل طرقًا مثل update() وset() وremove() لتتمكّن من تعديل المستند الذي أدّى إلى تشغيل الدالة بسهولة.

// 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});
    });
index.js

البيانات خارج عامل التفعيل

يتم تنفيذ Cloud Functions في بيئة موثوق بها، ما يعني أنّها معتمدة كحساب خدمة في مشروعك. يمكنك إجراء عمليات القراءة والكتابة باستخدام حزمة تطوير البرامج (SDK) الخاصة بالمشرف في Firebase:

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({ ... });
  });

القيود

لاحِظ القيود التالية على مشغّلات Cloud Firestore لوظائف السحابة الإلكترونية:

• تتطلب ميزة Cloud Functions (الجيل الأول) قاعدة بيانات "(تلقائية)" حالية في وضع Firestore الأصلي. ولا يتوافق مع قواعد البيانات المُسماة في Cloud Firestore أو "وضع مخزن البيانات". يُرجى استخدام Cloud Functions (الجيل الثاني) لضبط الأحداث في مثل هذه الحالات.
• الطلب غير مضمون. يمكن أن تؤدي التغييرات السريعة إلى تشغيل استدعاءات الدوال بترتيب غير متوقع.
• يتم تسليم الأحداث مرة واحدة على الأقل، ولكن قد يؤدي حدث واحد إلى استدعاءات دوال متعددة. تجنَّب الاعتماد على الآليات التي تظهر مرة واحدة بالضبط، واكتب دوال غير فعالة.
• Cloud Firestore في وضع "تخزين البيانات" تتطلب استخدام Cloud Functions (الجيل الثاني). لا يدعم Cloud Functions (الجيل الأول) وضع "تخزين البيانات".
• يرتبط المشغل بقاعدة بيانات واحدة. لا يمكنك إنشاء مشغل يطابق قواعد بيانات متعددة.
• لا يؤدي حذف قاعدة بيانات إلى حذف أي مشغلات لقاعدة البيانات هذه تلقائيًا. يتوقف العامل عن عرض الأحداث، ولكنه سيظل موجودًا إلى أن تحذف عامل التفعيل.
• إذا تجاوز حدث مطابق الحدّ الأقصى لحجم الطلب، قد لا يتمّ تسليم الحدث إلى Cloud Functions (الجيل الأول).
  • يتم تسجيل الأحداث التي لم يتم تسليمها بسبب حجم الطلب في سجلات النظام الأساسي ويتم احتسابها ضمن استخدام السجلّ للمشروع.
  • يمكنك العثور على هذه السجلّات في "مستكشف السجلّات" مع الرسالة "يتعذّر تسليم الحدث إلى دالة السحابة الإلكترونية بسبب تجاوز الحجم الحدّ الأقصى المسموح به من الجيل الأول..." ذي خطورة error. يمكنك العثور على اسم الدالة ضمن الحقل functionName. إذا كان الحقل receiveTimestamp لا يزال بعد ساعة من الآن، يمكنك استنتاج محتوى الحدث الفعلي من خلال قراءة المستند المعني باستخدام لقطة قبل الطابع الزمني وبعده.
  • لتجنُّب هذا النوع من التواصل، يمكنك إجراء ما يلي:
    • نقل البيانات والترقية إلى Cloud Functions (الجيل الثاني)
    • تصغير حجم المستند
    • حذف دوال السحابة الإلكترونية المعنيّة
  • يمكنك إيقاف التسجيل نفسه باستخدام الاستثناءات، ولكن تجدر الإشارة إلى أنّه لن يتم تسليم الأحداث المخالفة.