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

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

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

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

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

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

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

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

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

الويب

db.collection("restaurants")
  .doc("arinell-pizza")
  .collection("ratings")
  .get();
test.solution-aggregation.js

Swift

ملاحظة: لا يتوفّر هذا المنتج على watchOS واستهدافات "مقاطع التطبيقات".

do {
  let snapshot = try await db.collection("restaurants")
    .document("arinell-pizza")
    .collection("ratings")
    .getDocuments()
  print(snapshot)
} catch {
  print(error)
}
SolutionAggregationViewController.swift

Objective-C

ملاحظة: لا يتوفّر هذا المنتج على watchOS واستهدافات "مقاطع التطبيقات".

FIRQuery *query = [[[self.db collectionWithPath:@"restaurants"]
    documentWithPath:@"arinell-pizza"] collectionWithPath:@"ratings"];
[query getDocumentsWithCompletion:^(FIRQuerySnapshot * _Nullable snapshot,
                                    NSError * _Nullable error) {
  // ...
}];
FIRSolutionAggregationViewController.m

Kotlin

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

Java

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

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

الويب

var arinellDoc = {
  name: 'Arinell Pizza',
  avgRating: 4.65,
  numRatings: 683
};
test.solution-aggregation.js

Swift

ملاحظة: لا يتوفّر هذا المنتج على watchOS واستهدافات "مقاطع التطبيقات".

struct Restaurant {

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

}

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

Objective-C

ملاحظة: لا يتوفّر هذا المنتج على watchOS واستهدافات "مقاطع التطبيقات".

@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
FIRSolutionAggregationViewController.m

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)
SolutionAggregation.kt

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);
SolutionAggregation.java

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

الويب

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

Swift

ملاحظة: لا يتوفّر هذا المنتج على watchOS واستهدافات "مقاطع التطبيقات".

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 {
    // ...
  }
}
SolutionAggregationViewController.swift

Objective-C

ملاحظة: لا يتوفّر هذا المنتج على watchOS واستهدافات "مقاطع التطبيقات".

- (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) {
    // ...
  }];
}
FIRSolutionAggregationViewController.m

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
    }
}
SolutionAggregation.kt

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

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

القيود

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

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

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

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

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

القيود

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

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