توسيع نطاق Cloud Firestore باستخدام وظائف السحابة الإلكترونية

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

للحصول على أمثلة على حالات الاستخدام، اطّلِع على المقالة ما الذي يمكنني فعله باستخدام Cloud Functions؟ أو في مستودع GitHub الخاص بملف عيّنات الدوالّ.

مشغّلات دالة 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
    });
index.js

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

إذا كنت تريد إرفاق عامل تشغيل بمجموعة من المستندات، مثل أي مستند في مجموعة معيّنة، استخدِم {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"}
    });
index.js

في هذا المثال، عند تغيير أي حقل في أي مستند في 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"}
    });
index.js

مشغّلات الأحداث

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

يمكنك تنشيط دالة لإطلاقها في أي وقت يتم فيه إنشاء مستند جديد في مجموعة، وذلك باستخدام معالِج 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 ...
    });
index.js

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

يمكنك أيضًا تنشيط دالة لإطلاقها عند تعديل مستند باستخدام الدالة 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 ...
    });
index.js

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

يمكنك أيضًا تنشيط دالة عند حذف مستند باستخدام دالة 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 ...
    });
index.js

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

إذا لم تكن مهتمًا بنوع الحدث الذي يتم تشغيله، يمكنك الاستماع إلى كل التغييرات في مستند 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 ...
    });
index.js

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

عند بدء دالة، تقدّم لقطة بيانات ذات صلة بال الحدث. يمكنك استخدام هذه اللقطة لقراءة المستند الذي بدأ الحدث أو الكتابة فيه، أو استخدام حزمة تطوير البرامج (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();
    });
index.js

يمكنك الوصول إلى السمات كما تفعل في أيّ عنصر آخر. بدلاً من ذلك، يمكنك استخدام الدالة 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');
index.js

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

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

تأتي هذه القيمة DocumentReference من Cloud Firestore حزمة تطوير البرامج (SDK) لـ 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});
    });
index.js

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

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