深入理解Firestore异步操作与WriteBatch：避免常见的更新陷阱

本文旨在探讨firestore中一个常见的异步操作陷阱，即在处理`writebatch`时，若异步辅助函数未被正确`await`，可能导致批处理提交过早，从而使部分数据更新失效。我们将通过具体案例分析，强调在firestore数据操作中，`async/await`关键字的正确使用对于确保数据一致性和操作完整性的重要性，并提供相应的解决方案和最佳实践。

在Firestore的开发实践中，array-contains查询是处理数组类型字段的常用工具。开发者通常会注意到，当使用array-contains查询包含对象时，Firestore要求对象必须具有完全相同的结构和键值对，甚至键的顺序也需一致。为了满足这一严格要求，许多开发者会精心构造辅助函数来确保对象的精确匹配。然而，即便对array-contains的特性了如指掌，有时我们仍会遇到看似与查询逻辑无关的更新问题。本文将深入探讨一个此类场景，揭示其背后真正的原因：异步操作和Firestore.WriteBatch的协同错误。

理解Firestore.WriteBatch与异步操作

Firestore.WriteBatch是Firestore提供的一种机制，允许开发者在单个原子操作中执行多项写入、更新或删除操作。这意味着批处理中的所有操作要么全部成功，要么全部失败，从而保证了数据的一致性。使用WriteBatch的基本流程是：创建批处理实例，向其中添加操作，最后调用commit()方法提交所有操作。

const batch = getFirestore().batch();

// 添加更新操作到批处理
batch.update(docRef1, { field: 'value1' });
batch.delete(docRef2);
batch.set(docRef3, { field: 'value3' });

// 提交批处理
await batch.commit();

然而，当批处理操作与异步辅助函数结合使用时，如果不注意async/await的正确使用，就可能引入难以察觉的bug。

案例分析：异步辅助函数的陷阱

考虑一个场景，我们有一个清理逻辑，需要从多个文档中移除某个用户引用。初始的代码可能如下所示：

export type UserReference = {
  name?: string;
  uid: string;
};

// 假设getUserRef函数确保了对象结构与Firestore存储的一致性
export const getUserRef = (user: AppUser | DbUser): UserReference => ({
  name: user.name,
  uid: user.uid,
});

// ... 在某个异步函数内部 ...
const batch = getFirestore().batch();

// 假设severGroupOwnerLinksWithUser是一个异步辅助函数
// 它负责查询并向传入的batch添加更新操作
severGroupOwnerLinksWithUser(user.uid, batch); // ⚠️ 潜在问题点：缺少await

// 提交批处理
await batch.commit();

在这个例子中，severGroupOwnerLinksWithUser是一个异步函数，它可能会执行Firestore查询，然后根据查询结果向传入的batch对象添加update操作。问题在于，如果severGroupOwnerLinksWithUser没有被await，那么batch.commit()可能会在severGroupOwnerLinksWithUser内部的所有异步操作完成之前就被执行。

执行流程分析：

钉钉 AI 助理

钉钉AI助理汇集了钉钉AI产品能力，帮助企业迈入智能新时代。

21

查看详情

1. batch对象被创建。
2. severGroupOwnerLinksWithUser(user.uid, batch)被调用。由于它是一个异步函数且没有await，JavaScript运行时会立即执行下一行代码，而不会等待severGroupOwnerLinksWithUser内部的异步操作完成。
3. await batch.commit()被执行。此时，batch可能还没有包含severGroupOwnerLinksWithUser应该添加的所有更新操作。
4. batch.commit()提交了批处理，但只包含了在severGroupOwnerLinksWithUser函数开始执行到batch.commit()被调用之间，同步添加到batch中的操作（如果有的话），或者根本没有包含任何操作。
5. 随后，severGroupOwnerLinksWithUser内部的异步操作（例如查询和添加更新到batch）才陆续完成，但此时batch已经提交，这些后续添加的操作将无效。

这会导致部分数据更新失败，但由于没有明显的错误提示（因为batch.commit()本身可能成功，只是提交了一个空的或不完整的批处理），排查起来会非常困难，甚至可能误导开发者认为array-contains查询存在问题。

解决方案：正确使用await

解决此问题的关键在于确保在batch.commit()之前，所有对批处理进行修改的异步操作都已完成。这意味着任何异步辅助函数，如果它负责向批处理添加操作，都必须被await。

const batch = getFirestore().batch();

// ... 其他同步或已await的批处理操作 ...

// ✅ 关键改进：确保异步辅助函数被await
await severGroupOwnerLinksWithUser(user.uid, batch);

// 提交批处理
await batch.commit();

通过添加await关键字，我们强制JavaScript运行时等待severGroupOwnerLinksWithUser函数及其内部所有异步操作完成，确保所有相关的更新操作都已添加到batch中，然后才允许batch.commit()执行。这样，批处理将包含所有预期的更新，从而保证数据的一致性和操作的完整性。

最佳实践与注意事项

1. 始终await异步操作： 任何返回Promise的函数，如果其结果或副作用对后续代码的正确执行至关重要，都应该被await。
2. 明确异步边界： 在设计函数时，明确哪些函数是异步的，它们何时完成，以及它们的副作用是什么。
3. 日志记录与调试： 在复杂的异步流程中，使用console.log或调试器来追踪Promise的状态和batch的内容，有助于识别问题。例如，在batch.commit()之前打印batch中操作的数量（虽然Firestore SDK不直接提供此API，但可以通过封装或模拟来验证）。
4. 错误处理： 使用try...catch块来捕获异步操作中的潜在错误，确保应用程序的健壮性。
5. 避免副作用的隐式依赖： 尽量避免异步函数通过修改外部变量（如传入的batch对象）来产生副作用，除非这种模式被清晰地管理和await。

总结

Firestore的array-contains查询在处理对象时确实有其严格性，但许多看似与查询相关的更新问题，其根源往往在于对JavaScript异步编程模型的误解。在涉及Firestore.WriteBatch和异步辅助函数的场景中，缺少await关键字是一个常见的陷阱，它会导致批处理提交过早，使得部分更新操作失效。通过正确地使用async/await，我们可以确保异步操作的顺序性，保证WriteBatch能够包含所有预期的更新，从而维护Firestore数据的完整性和一致性。深入理解和正确应用异步编程范式，是构建稳定、可靠Firestore应用程序的关键。

以上就是深入理解Firestore异步操作与WriteBatch：避免常见的更新陷阱的详细内容，更多请关注php中文网其它相关文章！