تجمعات زمان نوشتن

پرس و جو در Cloud Firestore به شما امکان می دهد اسناد را در مجموعه های بزرگ بیابید. برای به دست آوردن بینش در مورد ویژگی های مجموعه به عنوان یک کل، می توانید داده ها را روی یک مجموعه جمع آوری کنید.

می توانید داده ها را در زمان خواندن یا در زمان نوشتن جمع آوری کنید:

  • تجمیع زمان خواندن نتیجه را در زمان درخواست محاسبه می کند. Cloud Firestore از جستارهای جمع آوری count() ، sum() و average() در زمان خواندن پشتیبانی می کند. پرس‌و‌جوهای انباشتگی زمان خواندن، آسان‌تر از جمع‌آوری‌های زمان نوشتن به برنامه شما اضافه می‌شوند. برای اطلاعات بیشتر در مورد جستارهای تجمیع، به خلاصه کردن داده ها با جستارهای تجمعی مراجعه کنید.

  • هر بار که برنامه عملیات نوشتن مربوطه را انجام می‌دهد ، انبوه‌های زمان نوشتن، یک نتیجه را محاسبه می‌کنند. جمع‌آوری‌های زمان نوشتن کار بیشتری برای پیاده‌سازی هستند، اما ممکن است به یکی از دلایل زیر از آنها به‌جای تجمیع‌های زمان خواندن استفاده کنید:

    • می‌خواهید برای به‌روزرسانی‌های هم‌زمان، به نتیجه تجمع گوش دهید. پرس و جوهای جمع آوری count() sum() و average() از به روز رسانی بلادرنگ پشتیبانی نمی کنند.
    • شما می خواهید نتیجه تجمع را در یک کش سمت مشتری ذخیره کنید. پرس و جوهای جمع آوری count() sum() و average() از کش پشتیبانی نمی کنند.
    • شما در حال جمع آوری داده ها از ده ها هزار سند برای هر یک از کاربران خود هستید و هزینه ها را در نظر می گیرید. در تعداد کمتری از اسناد، تجمیع زمان خواندن هزینه کمتری دارند. برای تعداد زیادی از اسناد در یک مجموعه، تجمیع زمان نوشتن ممکن است هزینه کمتری داشته باشد.

می‌توانید با استفاده از تراکنش سمت مشتری یا با Cloud Functions ، یک تجمیع زمان نوشتن را پیاده‌سازی کنید. بخش‌های زیر نحوه پیاده‌سازی تجمیع‌های زمان نوشتن را توضیح می‌دهند.

راه حل: تجمیع زمان نوشتن با تراکنش سمت مشتری

یک برنامه توصیه‌های محلی را در نظر بگیرید که به کاربران کمک می‌کند رستوران‌های عالی را پیدا کنند. جستار زیر تمام رتبه‌بندی‌های یک رستوران معین را بازیابی می‌کند:

وب

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

سویفت

توجه: این محصول در اهداف watchOS و App Clip موجود نیست.
do {
  let snapshot = try await db.collection("restaurants")
    .document("arinell-pizza")
    .collection("ratings")
    .getDocuments()
  print(snapshot)
} catch {
  print(error)
}

هدف-C

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

Kotlin+KTX

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

سویفت

توجه: این محصول در اهداف 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)

هدف-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+KTX

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

سویفت

توجه: این محصول در اهداف 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 {
    // ...
  }
}

هدف-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+KTX

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 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 می شود که ممکن است هزینه های شما را افزایش دهد. برای اطلاعات بیشتر، به صفحه قیمت گذاری عملکردهای ابری مراجعه کنید.
  • تأخیر - با بارگذاری کار تجمیع در یک تابع Cloud، برنامه شما تا زمانی که اجرای عملکرد Cloud به پایان نرسد و مشتری از داده های جدید مطلع نشود، داده های به روز شده را نمی بیند. بسته به سرعت عملکرد Cloud شما، این ممکن است بیشتر از اجرای تراکنش به صورت محلی طول بکشد.
  • نرخ‌های نوشتن - این راه‌حل ممکن است برای انبوه‌هایی که اغلب به‌روزرسانی می‌شوند کار نکند، زیرا اسناد Cloud Firestore تنها حداکثر یک بار در ثانیه می‌توانند به‌روزرسانی شوند. علاوه بر این، اگر تراکنش سندی را بخواند که خارج از تراکنش اصلاح شده است، تعداد محدودی بار تکرار می‌شود و سپس شکست می‌خورد. شمارنده‌های توزیع‌شده را برای راه‌حل‌های مرتبط برای انبوه‌هایی که به به‌روزرسانی‌های مکرر نیاز دارند، بررسی کنید.