Flutter中FieldValue.arrayUnion更新FireStore数组字段类型不匹配问题

问题根源 #

你碰到的类型错误，是因为把FieldValue.arrayUnion()的结果直接赋值给了SchedulerEvent类的notes字段——这个字段的类型是List<Map<String, dynamic>>?，但FieldValue是FireStore专门用来做原子更新的特殊类型，根本没法直接赋值给实体类的属性。

正确操作方式 #

不用改自定义对象的字段，直接在调用FireStore的update()或者set()方法时，传入包含FieldValue的字段映射就行，不用传整个自定义对象。

代码示例 #

比如你的SchedulerEvent类是这样的：

class SchedulerEvent {
  final String id;
  final List<Map<String, dynamic>>? notes;
  // 其他字段...

  SchedulerEvent({required this.id, this.notes});

  // 转成FireStore可用的Map
  Map<String, dynamic> toMap() {
    return {
      'id': id,
      'notes': notes,
      // 其他字段...
    };
  }
}

之前错误的写法（导致类型不匹配）：

// 错误：FieldValue不能赋值给List<Map<String, dynamic>>?
final updatedEvent = SchedulerEvent(
  id: event.id,
  notes: FieldValue.arrayUnion([newNote]), // 这里类型对不上
);

await FirebaseFirestore.instance
    .collection('events')
    .doc(event.id)
    .set(updatedEvent.toMap(), SetOptions(merge: true));

正确的写法：

// 直接构造更新的字段映射，用FieldValue做原子添加
await FirebaseFirestore.instance
    .collection('events')
    .doc(event.id)
    .update({
      'notes': FieldValue.arrayUnion([newNote]) // 这里直接把FieldValue放到字段映射里
    });

如果需要合并其他字段，用set()方法也可以，但同样是传包含FieldValue的Map，不是整个实体对象：

await FirebaseFirestore.instance
    .collection('events')
    .doc(event.id)
    .set(
      {
        'notes': FieldValue.arrayUnion([newNote]),
        // 其他要合并的字段，比如'title': '更新后的标题'
      },
      SetOptions(merge: true),
    );

关于FieldValue.arrayUnion的参数说明 #

FieldValue.arrayUnion()接收的是要添加到数组里的元素，不是字段名字符串。这些元素可以是字符串、数字、Map，甚至自定义对象（只要能转成FireStore支持的类型就行）。你看的官方示例用字符串只是常见场景，不是说只能传字符串。比如你要加的newNote是Map<String, dynamic>类型，直接传就没问题：

final newNote = {'content': '新添加的笔记', 'createdAt': Timestamp.now()};
FieldValue.arrayUnion([newNote]); // 完全合法

总结 #

• 别把FieldValue赋值给自定义实体类的属性，在调用FireStore更新方法时，直接在字段映射里用FieldValue就行。
• FieldValue.arrayUnion()支持所有FireStore兼容的元素类型，不止字符串。

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