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

تتيح لك طلبات البحث في 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 Firestore أكثر من مرة واحدة في الثانية. بالإضافة إلى ذلك، إذا قرأت معاملة مستندًا تم تعديله خارج المعاملة، فإنّها تعيد المحاولة عددًا محدودًا من المرات ثم تفشل. يُرجى الاطّلاع على العدادات الموزّعة للحصول على حلّ بديل مناسب لعمليات التجميع التي تحتاج إلى تعديلات أكثر تكرارًا.

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

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

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 Function، قد يستغرق ذلك وقتًا أطول من تنفيذ المعاملة محليًا.
  • معدّلات الكتابة : قد لا ينجح هذا الحلّ في عمليات التجميع التي يتم تعديلها بشكل متكرّر لأنّه لا يمكن تعديل مستندات Cloud Firestore أكثر من مرة واحدة في الثانية. بالإضافة إلى ذلك، إذا قرأت معاملة مستندًا تم تعديله خارج المعاملة، فإنّها تعيد المحاولة عددًا محدودًا من المرات ثم تفشل. يُرجى الاطّلاع على العدادات الموزّعة للحصول على حلّ بديل مناسب لعمليات التجميع التي تحتاج إلى تعديلات أكثر تكرارًا.