Tổng hợp thời gian ghi

Truy vấn trong Cloud Firestore cho phép bạn tìm tài liệu trong các bộ sưu tập lớn. Để hiểu rõ hơn về toàn bộ thuộc tính của bộ sưu tập, bạn có thể tổng hợp dữ liệu qua một bộ sưu tập.

Bạn có thể tổng hợp dữ liệu tại thời điểm đọc hoặc lúc ghi:

  • Tổng hợp thời gian đọc tính toán kết quả tại thời điểm yêu cầu. Cloud Firestore hỗ trợ các truy vấn tổng hợp count() , sum()average() tại thời điểm đọc. Các truy vấn tổng hợp thời gian đọc dễ dàng thêm vào ứng dụng của bạn hơn so với các truy vấn tổng hợp thời gian ghi. Để biết thêm về truy vấn tổng hợp, hãy xem Tóm tắt dữ liệu bằng truy vấn tổng hợp .

  • Tổng hợp thời gian ghi sẽ tính toán kết quả mỗi khi ứng dụng thực hiện thao tác ghi có liên quan. Việc tổng hợp theo thời gian ghi tốn nhiều công sức hơn để triển khai nhưng bạn có thể sử dụng chúng thay vì tập hợp theo thời gian đọc vì một trong những lý do sau:

    • Bạn muốn nghe kết quả tổng hợp để cập nhật theo thời gian thực. Các truy vấn tổng hợp count() , sum()average() không hỗ trợ cập nhật theo thời gian thực.
    • Bạn muốn lưu trữ kết quả tổng hợp trong bộ đệm phía máy khách. Các truy vấn tổng hợp count() , sum()average() không hỗ trợ bộ nhớ đệm.
    • Bạn đang tổng hợp dữ liệu từ hàng chục nghìn tài liệu cho mỗi người dùng của mình và xem xét chi phí. Với số lượng tài liệu thấp hơn, việc tổng hợp thời gian đọc sẽ ít tốn kém hơn. Đối với một số lượng lớn tài liệu trong một tập hợp, việc tập hợp theo thời gian ghi có thể tốn ít chi phí hơn.

Bạn có thể triển khai tổng hợp thời gian ghi bằng cách sử dụng giao dịch phía máy khách hoặc với Chức năng đám mây. Các phần sau đây mô tả cách triển khai tập hợp thời gian ghi.

Giải pháp: Tổng hợp thời gian ghi với giao dịch phía khách hàng

Hãy xem xét một ứng dụng đề xuất địa phương giúp người dùng tìm thấy những nhà hàng tuyệt vời. Truy vấn sau đây truy xuất tất cả xếp hạng cho một nhà hàng nhất định:

Web

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

Nhanh

Lưu ý: Sản phẩm này không khả dụng trên các mục tiêu watchOS và App Clip.
do {
  let snapshot = try await db.collection("restaurants")
    .document("arinell-pizza")
    .collection("ratings")
    .getDocuments()
  print(snapshot)
} catch {
  print(error)
}

Mục tiêu-C

Lưu ý: Sản phẩm này không khả dụng trên các mục tiêu watchOS và 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();

Thay vì tìm nạp tất cả xếp hạng và sau đó tính toán thông tin tổng hợp, chúng ta có thể lưu trữ thông tin này trên chính tài liệu của nhà hàng:

Web

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

Nhanh

Lưu ý: Sản phẩm này không khả dụng trên các mục tiêu watchOS và App Clip.
struct Restaurant {

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

}

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

Mục tiêu-C

Lưu ý: Sản phẩm này không khả dụng trên các mục tiêu watchOS và 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);

Để giữ cho các tập hợp này nhất quán, chúng phải được cập nhật mỗi khi xếp hạng mới được thêm vào bộ sưu tập con. Một cách để đạt được tính nhất quán là thực hiện việc thêm và cập nhật trong một giao dịch:

Web

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

Nhanh

Lưu ý: Sản phẩm này không khả dụng trên các mục tiêu watchOS và 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 {
    // ...
  }
}

Mục tiêu-C

Lưu ý: Sản phẩm này không khả dụng trên các mục tiêu watchOS và 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;
        }
    });
}

Việc sử dụng giao dịch sẽ giúp dữ liệu tổng hợp của bạn nhất quán với bộ sưu tập cơ bản. Để đọc thêm về các giao dịch trong Cloud Firestore, hãy xem Giao dịch và Viết hàng loạt .

Hạn chế

Giải pháp được trình bày ở trên thể hiện việc tổng hợp dữ liệu bằng thư viện máy khách Cloud Firestore, nhưng bạn nên lưu ý những hạn chế sau:

  • Bảo mật - Các giao dịch phía khách hàng yêu cầu cấp cho khách hàng quyền cập nhật dữ liệu tổng hợp trong cơ sở dữ liệu của bạn. Mặc dù bạn có thể giảm thiểu rủi ro của phương pháp này bằng cách viết các quy tắc bảo mật nâng cao nhưng điều này có thể không phù hợp trong mọi tình huống.
  • Hỗ trợ ngoại tuyến - Giao dịch phía máy khách sẽ không thành công khi thiết bị của người dùng ngoại tuyến, điều đó có nghĩa là bạn cần xử lý trường hợp này trong ứng dụng của mình và thử lại vào thời điểm thích hợp.
  • Hiệu suất - Nếu giao dịch của bạn chứa nhiều thao tác đọc, ghi và cập nhật, giao dịch đó có thể yêu cầu nhiều yêu cầu tới phần phụ trợ của Cloud Firestore. Trên thiết bị di động, việc này có thể mất thời gian đáng kể.
  • Tốc độ ghi - giải pháp này có thể không hoạt động đối với các tập hợp được cập nhật thường xuyên vì tài liệu Cloud Firestore chỉ có thể được cập nhật tối đa một lần mỗi giây. Ngoài ra, nếu một giao dịch đọc một tài liệu đã được sửa đổi bên ngoài giao dịch, nó sẽ thử lại một số lần hữu hạn và sau đó không thành công. Kiểm tra các bộ đếm được phân phối để biết giải pháp phù hợp cho các tập hợp cần cập nhật thường xuyên hơn.

Giải pháp: Tổng hợp thời gian ghi bằng Cloud Functions

Nếu giao dịch phía khách hàng không phù hợp với ứng dụng của bạn, bạn có thể sử dụng Chức năng đám mây để cập nhật thông tin tổng hợp mỗi khi xếp hạng mới được thêm vào nhà hàng:

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

Giải pháp này chuyển công việc từ máy khách sang chức năng được lưu trữ, nghĩa là ứng dụng di động của bạn có thể thêm xếp hạng mà không cần đợi giao dịch hoàn tất. Mã được thực thi trong Chức năng đám mây không bị ràng buộc bởi các quy tắc bảo mật, điều đó có nghĩa là bạn không cần cấp cho khách hàng quyền truy cập ghi vào dữ liệu tổng hợp nữa.

Hạn chế

Việc sử dụng Hàm đám mây để tổng hợp sẽ tránh được một số vấn đề với giao dịch phía khách hàng nhưng đi kèm với một số hạn chế khác:

  • Chi phí - Mỗi xếp hạng được thêm sẽ gây ra lệnh gọi Chức năng đám mây, điều này có thể làm tăng chi phí của bạn. Để biết thêm thông tin, hãy xem trang định giá Chức năng đám mây.
  • Độ trễ - Bằng cách giảm tải công việc tổng hợp cho Chức năng đám mây, ứng dụng của bạn sẽ không thấy dữ liệu cập nhật cho đến khi Chức năng đám mây thực thi xong và khách hàng đã được thông báo về dữ liệu mới. Tùy thuộc vào tốc độ của Chức năng đám mây của bạn, việc này có thể mất nhiều thời gian hơn so với việc thực hiện giao dịch cục bộ.
  • Tốc độ ghi - giải pháp này có thể không hoạt động đối với các tập hợp được cập nhật thường xuyên vì tài liệu Cloud Firestore chỉ có thể được cập nhật tối đa một lần mỗi giây. Ngoài ra, nếu một giao dịch đọc một tài liệu đã được sửa đổi bên ngoài giao dịch, nó sẽ thử lại một số lần hữu hạn và sau đó không thành công. Kiểm tra các bộ đếm được phân phối để biết giải pháp phù hợp cho các tập hợp cần cập nhật thường xuyên hơn.