مشغِّلات Cloud Firestore


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

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

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

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

عوامل تشغيل وظائف Cloud Firestore

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

نوع الحدث عامل التفعيل
onCreate يتم تشغيله عند الكتابة في مستند لأول مرة.
onUpdate يتم تشغيله عندما يكون هناك مستند متوفِّر سلفًا ويتم تغيير أي قيمة له.
onDelete يتم تشغيله عند حذف مستند يحتوي على بيانات.
onWrite يتم تشغيله عند بدء onCreate أو onUpdate أو onDelete.

إذا لم يكن لديك مشروع مفعَّل لخدمة Cloud Functions for Firebase بعد، يُرجى الاطّلاع على مقالة البدء: كتابة وظائفك الأولى ونشرها لضبط إعدادات مشروعك على Cloud Functions for Firebase وإعداده.

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

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

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

Node.js

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

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

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

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

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

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
    });

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

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

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"}
    });

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

إذا كان أحد المستندات في users يتضمّن مجموعات فرعية، وتغيّر حقل في أحد المستندات في تلك المجموعات الفرعية، لا يتم تنشيط العنصر النائب userId.

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

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"}
    });

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

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

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

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

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

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

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

بدء دالة عند حذف مستند

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

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

تنشيط دالة لجميع التغييرات في مستند

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

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

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

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

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

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

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

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

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

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');

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

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

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

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});
    });

البيانات خارج الحدث المشغِّل

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

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

القيود

يُرجى مراعاة القيود التالية لعوامل تشغيل Cloud Firestore في Cloud Functions:

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