تجميعات أوقات الكتابة

تتيح لك طلبات البحث في Cloud Firestore العثور على المستندات في مجموعات كبيرة. للحصول على إحصاءات حول خصائص المجموعة ككل، يمكنك تجميع البيانات على مستوى المجموعة.

يمكنك تجميع البيانات إما في وقت القراءة أو في وقت الكتابة:

  • تحسب عمليات التجميع في وقت القراءة النتيجة في وقت الطلب. يتيح Cloud Firestore استخدام طلبات البحث التجميعية count() وsum() وaverage() في وقت القراءة. تُعدّ طلبات تجميع البيانات في وقت القراءة أسهل في الإضافة إلى تطبيقك من عمليات التجميع في وقت الكتابة. لمزيد من المعلومات حول طلبات البحث التجميعية، يُرجى الاطّلاع على مقالة تلخيص البيانات باستخدام طلبات البحث التجميعية.

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

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

يمكنك تنفيذ تجميع وقت الكتابة باستخدام معاملة من جهة العميل أو باستخدام Cloud Functions. توضّح الأقسام التالية كيفية تنفيذ عمليات تجميع وقت الكتابة.

الحلّ: التجميع في وقت الكتابة باستخدام معاملة من جهة العميل

لنفترض أنّك طوّرت تطبيقًا للاقتراحات المحلية يساعد المستخدمين في العثور على مطاعم رائعة. يستردّ طلب البحث التالي جميع التقييمات لمطعم معيّن:

الويب

db.collection("restaurants")
  .doc("arinell-pizza")
  .collection("ratings")
  .get();

Swift

ملاحظة: لا يتوفّر هذا المنتج على watchOS وأهداف App Clip.
do {
  let snapshot = try await db.collection("restaurants")
    .document("arinell-pizza")
    .collection("ratings")
    .getDocuments()
  print(snapshot)
} catch {
  print(error)
}

Objective-C

ملاحظة: لا يتوفّر هذا المنتج على watchOS وأهداف App Clip.
FIRQuery *query = [[[self.db collectionWithPath:@"restaurants"]
    documentWithPath:@"arinell-pizza"] collectionWithPath:@"ratings"];
[query getDocumentsWithCompletion:^(FIRQuerySnapshot * _Nullable snapshot,
                                    NSError * _Nullable error) {
  // ...
}];

Kotlin

db.collection("restaurants")
    .document("arinell-pizza")
    .collection("ratings")
    .get()

Java

db.collection("restaurants")
        .document("arinell-pizza")
        .collection("ratings")
        .get();

بدلاً من جلب جميع التقييمات ثم حساب المعلومات المجمّعة، يمكننا تخزين هذه المعلومات في مستند المطعم نفسه:

الويب

var arinellDoc = {
  name: 'Arinell Pizza',
  avgRating: 4.65,
  numRatings: 683
};

Swift

ملاحظة: لا يتوفّر هذا المنتج على watchOS وأهداف App Clip.
struct Restaurant {

  let name: String
  let avgRating: Float
  let numRatings: Int

}

let arinell = Restaurant(name: "Arinell Pizza", avgRating: 4.65, numRatings: 683)

Objective-C

ملاحظة: لا يتوفّر هذا المنتج على watchOS وأهداف App Clip.
@interface FIRRestaurant : NSObject

@property (nonatomic, readonly) NSString *name;
@property (nonatomic, readonly) float averageRating;
@property (nonatomic, readonly) NSInteger ratingCount;

- (instancetype)initWithName:(NSString *)name
               averageRating:(float)averageRating
                 ratingCount:(NSInteger)ratingCount;

@end

@implementation FIRRestaurant

- (instancetype)initWithName:(NSString *)name
               averageRating:(float)averageRating
                 ratingCount:(NSInteger)ratingCount {
  self = [super init];
  if (self != nil) {
    _name = name;
    _averageRating = averageRating;
    _ratingCount = ratingCount;
  }
  return self;
}

@end

Kotlin

data class Restaurant(
    // default values required for use with "toObject"
    internal var name: String = "",
    internal var avgRating: Double = 0.0,
    internal var numRatings: Int = 0,
)
val arinell = Restaurant("Arinell Pizza", 4.65, 683)

Java

public class Restaurant {
    String name;
    double avgRating;
    int numRatings;

    public Restaurant(String name, double avgRating, int numRatings) {
        this.name = name;
        this.avgRating = avgRating;
        this.numRatings = numRatings;
    }
}
Restaurant arinell = new Restaurant("Arinell Pizza", 4.65, 683);

للحفاظ على اتساق هذه التجميعات، يجب تحديثها في كل مرة تتم إضافة تقييم جديد إلى المجموعة الفرعية. إحدى طرق تحقيق الاتساق هي إجراء الإضافة والتحديث في معاملة واحدة:

الويب

function addRating(restaurantRef, rating) {
    // Create a reference for a new rating, for use inside the transaction
    var ratingRef = restaurantRef.collection('ratings').doc();

    // In a transaction, add the new rating and update the aggregate totals
    return db.runTransaction((transaction) => {
        return transaction.get(restaurantRef).then((res) => {
            if (!res.exists) {
                throw "Document does not exist!";
            }

            // Compute new number of ratings
            var newNumRatings = res.data().numRatings + 1;

            // Compute new average rating
            var oldRatingTotal = res.data().avgRating * res.data().numRatings;
            var newAvgRating = (oldRatingTotal + rating) / newNumRatings;

            // Commit to Firestore
            transaction.update(restaurantRef, {
                numRatings: newNumRatings,
                avgRating: newAvgRating
            });
            transaction.set(ratingRef, { rating: rating });
        });
    });
}

Swift

ملاحظة: لا يتوفّر هذا المنتج على watchOS وأهداف App Clip.
func addRatingTransaction(restaurantRef: DocumentReference, rating: Float) async {
  let ratingRef: DocumentReference = restaurantRef.collection("ratings").document()

  do {
    let _ = try await db.runTransaction({ (transaction, errorPointer) -> Any? in
      do {
        let restaurantDocument = try transaction.getDocument(restaurantRef).data()
        guard var restaurantData = restaurantDocument else { return nil }

        // Compute new number of ratings
        let numRatings = restaurantData["numRatings"] as! Int
        let newNumRatings = numRatings + 1

        // Compute new average rating
        let avgRating = restaurantData["avgRating"] as! Float
        let oldRatingTotal = avgRating * Float(numRatings)
        let newAvgRating = (oldRatingTotal + rating) / Float(newNumRatings)

        // Set new restaurant info
        restaurantData["numRatings"] = newNumRatings
        restaurantData["avgRating"] = newAvgRating

        // Commit to Firestore
        transaction.setData(restaurantData, forDocument: restaurantRef)
        transaction.setData(["rating": rating], forDocument: ratingRef)
      } catch {
        // Error getting restaurant data
        // ...
      }

      return nil
    })
  } catch {
    // ...
  }
}

Objective-C

ملاحظة: لا يتوفّر هذا المنتج على watchOS وأهداف App Clip.
- (void)addRatingTransactionWithRestaurantReference:(FIRDocumentReference *)restaurant
                                             rating:(float)rating {
  FIRDocumentReference *ratingReference =
      [[restaurant collectionWithPath:@"ratings"] documentWithAutoID];

  [self.db runTransactionWithBlock:^id (FIRTransaction *transaction,
                                        NSError **errorPointer) {
    FIRDocumentSnapshot *restaurantSnapshot =
        [transaction getDocument:restaurant error:errorPointer];

    if (restaurantSnapshot == nil) {
      return nil;
    }

    NSMutableDictionary *restaurantData = [restaurantSnapshot.data mutableCopy];
    if (restaurantData == nil) {
      return nil;
    }

    // Compute new number of ratings
    NSInteger ratingCount = [restaurantData[@"numRatings"] integerValue];
    NSInteger newRatingCount = ratingCount + 1;

    // Compute new average rating
    float averageRating = [restaurantData[@"avgRating"] floatValue];
    float newAverageRating = (averageRating * ratingCount + rating) / newRatingCount;

    // Set new restaurant info

    restaurantData[@"numRatings"] = @(newRatingCount);
    restaurantData[@"avgRating"] = @(newAverageRating);

    // Commit to Firestore
    [transaction setData:restaurantData forDocument:restaurant];
    [transaction setData:@{@"rating": @(rating)} forDocument:ratingReference];
    return nil;
  } completion:^(id  _Nullable result, NSError * _Nullable error) {
    // ...
  }];
}

Kotlin

private fun addRating(restaurantRef: DocumentReference, rating: Float): Task<Void> {
    // Create reference for new rating, for use inside the transaction
    val ratingRef = restaurantRef.collection("ratings").document()

    // In a transaction, add the new rating and update the aggregate totals
    return db.runTransaction { transaction ->
        val restaurant = transaction.get(restaurantRef).toObject<Restaurant>()!!

        // Compute new number of ratings
        val newNumRatings = restaurant.numRatings + 1

        // Compute new average rating
        val oldRatingTotal = restaurant.avgRating * restaurant.numRatings
        val newAvgRating = (oldRatingTotal + rating) / newNumRatings

        // Set new restaurant info
        restaurant.numRatings = newNumRatings
        restaurant.avgRating = newAvgRating

        // Update restaurant
        transaction.set(restaurantRef, restaurant)

        // Update rating
        val data = hashMapOf<String, Any>(
            "rating" to rating,
        )
        transaction.set(ratingRef, data, SetOptions.merge())

        null
    }
}

Java

private Task<Void> addRating(final DocumentReference restaurantRef, final float rating) {
    // Create reference for new rating, for use inside the transaction
    final DocumentReference ratingRef = restaurantRef.collection("ratings").document();

    // In a transaction, add the new rating and update the aggregate totals
    return db.runTransaction(new Transaction.Function<Void>() {
        @Override
        public Void apply(@NonNull Transaction transaction) throws FirebaseFirestoreException {
            Restaurant restaurant = transaction.get(restaurantRef).toObject(Restaurant.class);

            // Compute new number of ratings
            int newNumRatings = restaurant.numRatings + 1;

            // Compute new average rating
            double oldRatingTotal = restaurant.avgRating * restaurant.numRatings;
            double newAvgRating = (oldRatingTotal + rating) / newNumRatings;

            // Set new restaurant info
            restaurant.numRatings = newNumRatings;
            restaurant.avgRating = newAvgRating;

            // Update restaurant
            transaction.set(restaurantRef, restaurant);

            // Update rating
            Map<String, Object> data = new HashMap<>();
            data.put("rating", rating);
            transaction.set(ratingRef, data, SetOptions.merge());

            return null;
        }
    });
}

يؤدي استخدام معاملة إلى الحفاظ على اتساق بياناتك المجمّعة مع المجموعة الأساسية. لمزيد من المعلومات عن المعاملات في Cloud Firestore، يُرجى الاطّلاع على المعاملات وعمليات الكتابة المجمّعة.

القيود

يوضّح الحلّ أعلاه تجميع البيانات باستخدام مكتبة عميل Cloud Firestore، ولكن يجب أن تكون على دراية بالقيود التالية:

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

الحلّ: التجميع في وقت الكتابة باستخدام Cloud Functions

إذا كانت المعاملات من جهة العميل غير مناسبة لتطبيقك، يمكنك استخدام دالة Cloud لتعديل المعلومات المجمّعة في كل مرة تتم فيها إضافة تقييم جديد إلى مطعم:

Node.js

exports.aggregateRatings = functions.firestore
    .document('restaurants/{restId}/ratings/{ratingId}')
    .onWrite(async (change, context) => {
      // Get value of the newly added rating
      const ratingVal = change.after.data().rating;

      // Get a reference to the restaurant
      const restRef = db.collection('restaurants').doc(context.params.restId);

      // Update aggregations in a transaction
      await db.runTransaction(async (transaction) => {
        const restDoc = await transaction.get(restRef);

        // Compute new number of ratings
        const newNumRatings = restDoc.data().numRatings + 1;

        // Compute new average rating
        const oldRatingTotal = restDoc.data().avgRating * restDoc.data().numRatings;
        const newAvgRating = (oldRatingTotal + ratingVal) / newNumRatings;

        // Update restaurant info
        transaction.update(restRef, {
          avgRating: newAvgRating,
          numRatings: newNumRatings
        });
      });
    });

ينقل هذا الحل العمل من العميل إلى دالة مستضافة، ما يعني أنّ تطبيقك المتوافق مع الأجهزة الجوّالة يمكنه إضافة تقييمات بدون انتظار اكتمال المعاملة. لا يتقيّد الرمز البرمجي الذي يتم تنفيذه في Cloud Function بقواعد الأمان، ما يعني أنّك لم تعُد بحاجة إلى منح العملاء إذن الكتابة في البيانات المجمّعة.

القيود

يؤدي استخدام Cloud Function لعمليات التجميع إلى تجنُّب بعض المشاكل المتعلّقة بالمعاملات من جهة العميل، ولكنّه يفرض مجموعة مختلفة من القيود:

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