MapEntry用途解析及Dart中Firestore文档更新代码详解

整体作用 #

这个抽象类FirestoreDocumentUpdater提供了一个静态方法update，负责将Dart数据转换为Firestore兼容的格式，然后更新指定的Firestore文档。Firestore对可存储的数据类型有特定要求，该方法自动处理那些Firestore不直接支持的类型转换，避免手动转换的繁琐。

update方法拆解 #

参数说明 #

• documentRef: 指向目标Firestore文档的引用，明确要更新的具体文档位置。
• map: 包含待更新字段和对应新值的Map，键为文档中的字段名，值为需要设置的新数据。

核心逻辑 #

1. 调试日志: debugPrint('update function called')仅用于打印调试信息，标记更新方法已被触发。
2. 数据类型转换流程:
   • map.entries提取输入Map中的所有键值对，返回一个Iterable<MapEntry<String, dynamic>>集合。
   • 遍历每个键值对(e)，通过switch语句根据值的类型做针对性转换：
     • 若为DateTime类型：调用toJsonDateTime转为Firestore原生支持的Timestamp类型（Firestore不直接存储Dart的DateTime对象）。
     • 若为Duration类型：调用toJsonDuration转为微秒数（整数），因为Firestore没有原生Duration类型，存储微秒数是常用的兼容方案。
     • 若为Enum类型：取枚举值的name属性（字符串），由于枚举无法直接存入Firestore，字符串形式便于后续读取并转换回枚举。
     • 其他类型：保持原数值不变，只要是Firestore支持的类型（如String、int、bool、List等）均可直接使用。
3. 构建兼容Map: Map.fromEntries(...)将转换后的所有MapEntry重新组合成一个新Map，传入Firestore的documentRef.update()方法执行实际更新操作。

辅助函数说明 #

• toJsonDateTime: 接收DateTime对象（或null），返回对应的FirestoreTimestamp。若输入为null则返回null，处理空值场景。
• toJsonDuration: 接收Duration对象，返回其对应的微秒数（整数），使Duration能以数字形式存入Firestore。

MapEntry的用途 #

MapEntry是Dart中用于表示Map单个键值对的类。在这段代码中的作用：

• 原Map的entries返回的是不可变的MapEntry实例，无法直接修改其值。
• 我们需要为每个键值对生成新的MapEntry，保留原键不变，仅将值替换为转换后的兼容类型。
• 最终通过Map.fromEntries将这些新的MapEntry组装成符合Firestore要求的新Map。简言之，它是封装转换后键值对的载体，让我们能重新构建可用的更新数据Map。

内容的提问来源于stack exchange，提问作者M99Coder