本文介绍了如何在使用 Firebase Admin SDK 的 Firestore Batch 事务时，检测事务是否成功提交或因错误回滚。通过标准的 JavaScript 错误处理机制，你可以有效地捕获 batch.commit() 操作可能出现的异常，从而确保数据一致性和程序的健壮性。本文将提供代码示例和最佳实践，帮助你更好地管理 Firestore Batch 事务。
Firestore 的 Batch 写入允许你在单个原子操作中执行多个写入操作。这对于需要同时更新多个文档以保持数据一致性的场景非常有用。然而，与任何数据库操作一样，Batch 写入也可能因为各种原因而失败。了解如何检测和处理这些失败至关重要。
Firestore Batch 事务使用 Promise 来处理异步操作的结果。这意味着你可以使用标准的 JavaScript 错误处理技术来确定 batch.commit() 是否成功。
使用 try...catch 块处理异常
最常见也是推荐的方法是使用 try...catch 块。batch.commit() 返回一个 Promise，如果提交过程中出现任何错误，该 Promise 将被拒绝 (rejected)。try...catch 块允许你捕获这些被拒绝的 Promise，并执行相应的错误处理逻辑。
import { getFirestore } from "firebase-admin/firestore";
const firestore = getFirestore();
const batch = firestore.batch();
const docRef = firestore.collection("myCollection").doc("doc1");
const docRef2 = firestore.collection("myCollection").doc("doc2");
batch.update(docRef, { "blah_blah_blah": true });
batch.set(docRef2, { "blah_blah_blah": false });
try {
await batch.commit();
console.log("Batch commit successful!");
// 在这里执行 Batch 成功后的操作
} catch (e) {
// batch.commit() 失败，事务已回滚
console.error("Batch commit failed:", e);
// 在这里执行 Batch 失败后的操作，例如重试或记录错误
}在上面的代码中，await batch.commit() 位于 try 块中。如果 batch.commit() 成功，则会执行 try 块中的后续代码。如果 batch.commit() 失败，则会抛出一个异常，该异常将被 catch 块捕获，允许你处理错误。
使用 .catch() 方法处理 Promise 拒绝
如果你没有使用 async/await，则可以使用 Promise 的 .catch() 方法来处理错误。
import { getFirestore } from "firebase-admin/firestore";
const firestore = getFirestore();
const batch = firestore.batch();
const docRef = firestore.collection("myCollection").doc("doc1");
const docRef2 = firestore.collection("myCollection").doc("doc2");
batch.update(docRef, { "blah_blah_blah": true });
batch.set(docRef2, { "blah_blah_blah": false });
batch.commit()
.then(() => {
console.log("Batch commit successful!");
// 在这里执行 Batch 成功后的操作
})
.catch((e) => {
// batch.commit() 失败，事务已回滚
console.error("Batch commit failed:", e);
// 在这里执行 Batch 失败后的操作，例如重试或记录错误
});在这个例子中，.then() 方法在 Promise 成功解决时执行，而 .catch() 方法在 Promise 被拒绝时执行。
注意事项
- 错误处理至关重要: 始终包含适当的错误处理逻辑。忽略错误可能会导致数据不一致或其他意外行为。
- 幂等性: 如果 Batch 写入失败，你可能需要重试。确保你的写入操作是幂等的，也就是说，多次执行相同的操作不会产生不同的结果。这对于避免重复写入或数据损坏至关重要。
- 日志记录: 记录 Batch 写入的成功和失败对于调试和监控你的应用程序非常有用。
- 事务大小限制: Firestore 对 Batch 写入的大小和操作数量有限制。确保你的 Batch 写入不超过这些限制。
- 具体错误类型: 检查 catch 块中的错误对象 e，可以帮助你了解错误的具体原因，例如权限问题、文档不存在等，并根据具体情况采取不同的处理方式。
总结
通过使用 try...catch 块或 .catch() 方法，你可以有效地检测和处理 Firestore Batch 事务的失败。这有助于确保数据一致性并提高应用程序的健壮性。记住要包含适当的错误处理逻辑，并考虑幂等性、日志记录和事务大小限制等因素。 理解并应用这些最佳实践将使你能够更有效地利用 Firestore Batch 写入功能。
