多くのリアルタイム アプリにはカウンタとして働くドキュメントがあります。たとえば、投稿の「いいね」や特定のアイテムの「お気に入り」をカウントしたい場合があります。
Cloud Firestore では、1 つのドキュメントを 1 秒間に約 1 回しか更新できません。これはトラフィックの多いアプリケーションでは少なすぎる可能性があります。
解決策: 分散カウンタ
カウンタをもっと頻繁に更新できるようにするには、分散カウンタを作成します。各カウンタは「シャード」のサブコレクションを持つドキュメントであり、カウンタの値はシャードの値の合計です。
書き込みスループットはシャードの数に比例して増加するため、10 個のシャードを持つ分散カウンタは従来のカウンタの 10 倍の書き込みを処理できます。
ウェブ
// counters/${ID}
{
"num_shards": NUM_SHARDS,
"shards": [subcollection]
}
// counters/${ID}/shards/${NUM}
{
"count": 123
}
Swift
// counters/${ID}
struct Counter {
let numShards: Int
init(numShards: Int) {
self.numShards = numShards
}
}
// counters/${ID}/shards/${NUM}
struct Shard {
let count: Int
init(count: Int) {
self.count = count
}
}
Android
// counters/${ID}
public class Counter {
int numShards;
public Counter(int numShards) {
this.numShards = numShards;
}
}
// counters/${ID}/shards/${NUM}
public class Shard {
int count;
public Shard(int count) {
this.count = count;
}
}
次のコードは、分散カウンタを初期化します。
ウェブ
function createCounter(ref, num_shards) {
var batch = db.batch();
// Initialize the counter document
batch.set(ref, { num_shards: num_shards });
// Initialize each shard with count=0
for (let i = 0; i < num_shards; i++) {
let shardRef = ref.collection('shards').doc(i.toString());
batch.set(shardRef, { count: 0 });
}
// Commit the write batch
return batch.commit();
}
Swift
func createCounter(ref: DocumentReference, numShards: Int) {
ref.setData(["numShards": numShards]){ (err) in
for i in 0...numShards {
ref.collection("shards").document(String(i)).setData(["count": 0])
}
}
}
Android
public Task<Void> createCounter(final DocumentReference ref, final int numShards) {
// Initialize the counter document, then initialize each shard.
return ref.set(new Counter(numShards))
.continueWithTask(new Continuation<Void, Task<Void>>() {
@Override
public Task<Void> then(@NonNull Task<Void> task) throws Exception {
if (!task.isSuccessful()) {
throw task.getException();
}
List<Task<Void>> tasks = new ArrayList<>();
// Initialize each shard with count=0
for (int i = 0; i < numShards; i++) {
Task<Void> makeShard = ref.collection("shards")
.document(String.valueOf(i))
.set(new Shard(0));
tasks.add(makeShard);
}
return Tasks.whenAll(tasks);
}
});
}
カウンタをインクリメントするには、シャードをランダムに選択し、トランザクションでカウントをインクリメントします。
ウェブ
function incrementCounter(db, ref, num_shards) {
// Select a shard of the counter at random
const shard_id = Math.floor(Math.random() * num_shards).toString();
const shard_ref = ref.collection('shards').doc(shard_id);
// Update count in a transaction
return db.runTransaction(t => {
return t.get(shard_ref).then(doc => {
const new_count = doc.data().count + 1;
t.update(shard_ref, { count: new_count });
});
});
}
Swift
func incrementCounter(ref: DocumentReference, numShards: Int) {
// Select a shard of the counter at random
let shardId = Int(arc4random_uniform(UInt32(numShards)))
let shardRef = ref.collection("shards").document(String(shardId))
// Update count in a transaction
db.runTransaction({ (transaction, errorPointer) -> Any? in
do {
let shardData = try transaction.getDocument(shardRef).data() ?? [:]
let shardCount = shardData["count"] as! Int
transaction.updateData(["count": shardCount + 1], forDocument: shardRef)
} catch {
// Error getting shard data
// ...
}
return nil
}) { (object, err) in
// ...
}
}
Android
public Task<Void> incrementCounter(final DocumentReference ref, final int numShards) {
int shardId = (int) Math.floor(Math.random() * numShards);
final DocumentReference shardRef = ref.collection("shards").document(String.valueOf(shardId));
return db.runTransaction(new Transaction.Function<Void>() {
@Override
public Void apply(Transaction transaction) throws FirebaseFirestoreException {
Shard shard = transaction.get(shardRef).toObject(Shard.class);
shard.count += 1;
transaction.set(shardRef, shard);
return null;
}
});
}
カウントの合計を取得するには、すべてのシャードを照会して count フィールドを合計します。
ウェブ
function getCount(ref) {
// Sum the count of each shard in the subcollection
return ref.collection('shards').get().then(snapshot => {
let total_count = 0;
snapshot.forEach(doc => {
total_count += doc.data().count;
});
return total_count;
});
}
Swift
func getCount(ref: DocumentReference) {
ref.collection("shards").getDocuments() { (querySnapshot, err) in
var totalCount = 0
if err != nil {
// Error getting shards
// ...
} else {
for document in querySnapshot!.documents {
let count = document.data()["count"] as! Int
totalCount += count
}
}
print("Total count is \(totalCount)")
}
}
Android
public Task<Integer> getCount(final DocumentReference ref) {
// Sum the count of each shard in the subcollection
return ref.collection("shards").get()
.continueWith(new Continuation<QuerySnapshot, Integer>() {
@Override
public Integer then(@NonNull Task<QuerySnapshot> task) throws Exception {
int count = 0;
for (DocumentSnapshot snap : task.getResult()) {
Shard shard = snap.toObject(Shard.class);
count += shard.count;
}
return count;
}
});
}
制限事項
上記の解決策は Cloud Firestore で共有カウンタを作成するスケーラブルな方法ですが、次の制限に注意する必要があります。
- シャードの数 - シャードの数は分散カウンタのパフォーマンスに影響を与えます。シャードが少なすぎると、再試行が必要となるトランザクションが発生し、結果的に書き込みが遅くなります。シャードが多すぎると、読み取り速度が遅くなり、コストがかかります。
- コスト - シャードのサブコレクション全体を読み込まなければならないため、カウンタ値を読み取るコストはシャードの数に比例して増加します。
ご不明な点がありましたら、Google の