本文介绍如何在 Firestore 安全规则中校验新增字段的结构，特别是当新增字段的键是动态生成（例如 UUID）时。我们将通过一个示例，展示如何利用辅助字段来解决无法直接访问动态键的问题，并确保新增字段符合预期的结构。
问题背景
在 Firestore 数据库中，我们经常需要对文档进行更新，特别是当文档包含键值对，且键是动态生成的时候，例如 UUID。在这种情况下，如何使用 Firestore 安全规则来验证新增字段的结构，确保其符合预期的格式，就成了一个挑战。
假设 Firestore 文档包含一系列映射，其字段名称是随机 UUID：
- 6e219b89-98fb-44cd-b6ad-e22888b6fb2f - name: 'Harry' - age: 20 - 345c635a-11cb-4165-86ef-50be50794532 - name: 'Mary' - age: 30
客户端代码向该文档添加新的映射：
await updateDoc(docRef, {
[crypto.randomUUID()]: {
name: 'Sally',
age: 24,
}
});我们的目标是验证新提交的字段是否为包含 name (字符串类型) 和 age (数字类型) 的映射。
解决方案
Firestore 安全规则无法直接迭代字段。它们必须明确知道要检查哪个字段。这意味着，对于上述的写操作，安全规则无法直接确定要检查哪个字段，因为字段名是动态的 UUID。
一个简单的解决方案是将 crypto.randomUUID() 的值写入一个已知的位置，例如 newField：
const uuid = crypto.randomUUID()
await updateDoc(docRef, {
newField: uuid,
[uuid]: {
name: 'Sally',
age: 24,
}
});现在，您的安全规则可以读取 newField 来确定添加了哪个字段，然后使用该值来检查新字段是否符合您的规则。
安全规则示例
以下是一个示例安全规则，展示如何利用 newField 来验证新增字段的结构：
rules_version = '2';
service cloud.firestore {
match /databases/{database}/documents {
match /your_collection/{document} {
allow update: if isValidUpdate();
function isValidUpdate() {
let newField = request.resource.data.newField;
return newField != null &&
request.resource.data[newField].name is string &&
request.resource.data[newField].age is number;
}
}
}
}代码解释:
- rules_version = '2';: 指定安全规则的版本。
- match /databases/{database}/documents: 匹配所有数据库下的文档。
- match /your_collection/{document}: 匹配 your_collection 集合下的特定文档。请根据实际情况替换 your_collection。
- allow update: if isValidUpdate();: 允许更新操作，如果 isValidUpdate() 函数返回 true。
- function isValidUpdate(): 定义一个函数来验证更新操作。
- let newField = request.resource.data.newField;: 从请求数据中获取 newField 的值。
- return newField != null && ...: 确保 newField 存在，并且后续的条件都满足。
- request.resource.data[newField].name is string && request.resource.data[newField].age is number;: 验证 newField 对应的值中，name 字段是字符串类型，age 字段是数字类型。
注意事项
- 确保客户端代码在更新文档时，始终包含 newField 字段。
- 根据实际需求，调整安全规则中的类型检查，例如，可以添加对字段长度的限制。
- 在生产环境中，务必进行充分的测试，确保安全规则能够有效地保护您的数据。
总结
通过将动态生成的键存储在一个已知字段中，我们可以克服 Firestore 安全规则无法直接访问动态键的限制，从而实现对新增字段结构的验证。这种方法简单有效，能够确保数据的完整性和安全性。
