Flutter中Firestore动态创建集合与文档问题排查及解决

问题场景 #

我开发的系统允许用户向基于变量动态生成的集合提交数据，要求集合或文档不存在时自动创建。之前类似功能的代码能正常运行，但当前代码失效了。

失效代码 #

await FirebaseFirestore.instance
        .collection('user-content')
        .doc('councils')
        .collection('council-paydates')
        .doc(council)
        .collection(year)
        .add({"data": "data"});

变量说明：council、year为动态传入的参数

此前正常运行的代码 #

await FirebaseFirestore.instance
            .collection('reviews')
            .doc('councils')
            .collection('reviews')
            .doc(widget.council)
            .collection('councilRatingReviews')
            .add({
          "POST_DETAILS": {
            "UID": userId,
            "USERNAME": displayName ?? '',
            "DATE_OF_POST": _dateOfPost,
            "ANONYMOUS": anonymousComment,
          },
          "COUNCIL_REVIEW": {
            "TITLE": _titleTextController.text.trim(),
            "REVIEW": _commentTextController.text.trim(),
            "COUNCIL": widget.council,
            "OVERALL_RATING": _rating,
          },});

其中动态创建集合/文档的变量为widget.council

问题排查与解决方案 #

排查后发现问题出在year变量上：输入的year字符串包含Firestore不允许的/字符。Firestore的集合和文档名称不能包含/、\、#、$、[、]、.等特殊字符。

将year中的/替换为合法字符（比如-）后，代码恢复正常。修改后的代码如下：

String year = "2024/2025";
String convertedYear = year.replaceAll('/', '-');// 转换为2024-2025

await FirebaseFirestore.instance
        .collection('user-content')
        .doc('councils')
        .collection('council-paydates')
        .doc(council)
        .collection(convertedYear)// 替换为处理后的year变量
        .add({"data": "data"});

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