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õ các thuộc tính của toàn bộ tập hợp, bạn có thể tổng hợp dữ liệu trên một tập hợp.

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

• Tính năng tổng hợp theo 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() và average() tại thời điểm đọc. Truy vấn tổng hợp theo thời gian đọc dễ thêm vào ứng dụng hơn so với tổng hợp theo thời gian ghi. Để biết thêm về truy vấn tổng hợp, hãy xem bài viết Tóm tắt dữ liệu bằng truy vấn tổng hợp.

• Tính năng tổng hợp tại thời điểm ghi tính toán kết quả mỗi khi ứng dụng thực hiện một thao tác ghi có liên quan. Việc triển khai tính năng tổng hợp tại thời điểm ghi sẽ mất nhiều công sức hơn, nhưng bạn có thể sử dụng tính năng này thay vì tính năng tổng hợp tại thời điểm đọ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() và 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ộ nhớ đệm phía máy khách. Các truy vấn tổng hợp count(), sum() và average() không hỗ trợ lưu vào 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 và xem xét chi phí. Khi số lượng tài liệu ít hơn, chi phí tổng hợp thời gian đọc sẽ thấp hơn. Đối với một lượng lớn tài liệu trong một tập hợp, tổng hợp tại thời điểm ghi có thể tốn ít chi phí hơn.

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

Giải pháp: Tổng hợp tại thời điểm ghi bằng giao dịch phía máy khách

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ả điểm xếp hạng cho một nhà hàng nhất định:

Web

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

Swift

Lưu ý: Sản phẩm này không dùng được 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)
}
SolutionAggregationViewController.swift

Objective-C

Lưu ý: Sản phẩm này không dùng được 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) {
  // ...
}];
FIRSolutionAggregationViewController.m

Kotlin+KTX

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

Java

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

Thay vì tìm nạp tất cả điểm xếp hạng rồi 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 về nhà hàng:

Web

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

Swift

Lưu ý: Sản phẩm này không dùng được 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)
SolutionAggregationViewController.swift

Objective-C

Lưu ý: Sản phẩm này không dùng được 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
FIRSolutionAggregationViewController.m

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

Để duy trì tính nhất quán của các giá trị tổng hợp này, bạn phải cập nhật các giá trị này mỗi khi thêm một điểm xếp hạng mới 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 thao tá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 });
        });
    });
}
test.firestore.js

Swift

Lưu ý: Sản phẩm này không dùng được 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 {
    // ...
  }
}
SolutionAggregationViewController.swift

Objective-C

Lưu ý: Sản phẩm này không dùng được 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) {
    // ...
  }];
}
FIRSolutionAggregationViewController.m

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

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

Các điểm hạn chế

Giải pháp hiển thị ở trên minh hoạ việc tổng hợp dữ liệu bằng thư viện ứng dụng Cloud Firestore, nhưng bạn cần lưu ý những hạn chế sau:

• Bảo mật – Các giao dịch phía máy khách yêu cầu cấp cho máy khách 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 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 trường hợp.
• Hỗ trợ ngoại tuyến – Các 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 không có kết nối mạng. Điều này có nghĩa là bạn cần xử lý trường hợp này trong ứng dụng 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, thì giao dịch đó có thể yêu cầu nhiều yêu cầu đến phần phụ trợ Cloud Firestore. Trên thiết bị di động, việc này có thể mất khá nhiều thời gian.
• Tốc độ ghi – giải pháp này có thể không hoạt động đối với các dữ liệu tổng 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, thì giao dịch đó sẽ thử lại một số lần hữu hạn rồi không thành công. Hãy xem bộ đếm phân tán để biết giải pháp phù hợp cho các dữ liệu tổng hợp cần cập nhật thường xuyên hơn.

Giải pháp: Tổng hợp tại thời điểm ghi bằng Cloud Functions

Nếu giao dịch phía máy khách không phù hợp với ứng dụng của mình, bạn có thể sử dụng Hàm trên đám mây để cập nhật thông tin tổng hợp mỗi khi thêm một điểm xếp hạng mới 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
        });
      });
    });
index.js

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

Các điểm hạn chế

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

• Chi phí – Mỗi điểm xếp hạng được thêm sẽ gây ra một lệnh gọi Hàm trên đá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 giá của Cloud Functions.
• Độ trễ – Bằng cách chuyển công việc tổng hợp sang một Hàm trên đá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 Hàm trên đám mây hoàn tất quá trình thực thi và ứng dụng khách đã được thông báo về dữ liệu mới. Tuỳ thuộc vào tốc độ của Hàm trên đám mây, quá trình này có thể mất nhiều thời gian hơn so với việc thực thi giao dịch trên máy.
• Tốc độ ghi – giải pháp này có thể không hoạt động đối với các dữ liệu tổng 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 chỉnh sửa bên ngoài giao dịch, thì giao dịch đó sẽ thử lại một số lần hữu hạn rồi không thành công. Hãy xem bộ đếm phân tán để biết giải pháp phù hợp cho các dữ liệu tổng hợp cần cập nhật thường xuyên hơn.