Агрегации времени записи

Запросы в 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

Быстрый

Примечание: этот продукт недоступен на устройствах watchOS и 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

Примечание: этот продукт недоступен на устройствах watchOS и App Clip. 
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

Быстрый

Примечание: этот продукт недоступен на устройствах 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)
SolutionAggregationViewController.swift

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

Быстрый

Примечание: этот продукт недоступен на устройствах 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 {
    // ...
  }
}
SolutionAggregationViewController.swift

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) {
    // ...
  }];
}
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 могут обновляться не чаще одного раза в секунду. Кроме того, если транзакция считывает документ, изменённый вне транзакции, она повторяет попытку конечное число раз , после чего завершается сбоем. Ознакомьтесь с распределёнными счётчиками, чтобы найти подходящий способ решения проблемы для агрегатов, требующих более частых обновлений.

Решение: агрегация во время записи с помощью облачных функций

Если транзакции на стороне клиента не подходят для вашего приложения, вы можете использовать облачную функцию для обновления совокупной информации каждый раз, когда ресторану добавляется новый рейтинг:

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 Functions.
  • Задержка . Благодаря передаче задач агрегации облачной функции ваше приложение не увидит обновлённых данных, пока облачная функция не завершит выполнение и клиент не будет уведомлён о новых данных. В зависимости от скорости облачной функции это может занять больше времени, чем локальное выполнение транзакции.
  • Скорость записи — это решение может не работать для часто обновляемых агрегатов, поскольку документы Cloud Firestore могут обновляться не чаще одного раза в секунду. Кроме того, если транзакция считывает документ, изменённый вне транзакции, она повторяет попытку конечное число раз , после чего завершается сбоем. Ознакомьтесь с распределёнными счётчиками, чтобы найти подходящий способ решения проблемы для агрегатов, требующих более частых обновлений.