Flutter 中 Firestore 按用户名搜索聊天列表匹配异常问题处理

问题根源 #

1. 你当前使用的isEqualTo是全值匹配规则，只有用户名和输入内容完全一致时才会返回对应记录，无法实现模糊匹配效果
2. 输入不存在的字符也返回全部记录，大概率是你传入的searchValue为空或null：Firestore中如果where条件的匹配值为null时会自动忽略该条件，返回集合下的全部文档

解决方案 #

Firestore本身不支持原生的全位置模糊查询，你可以根据业务场景选择以下两种方案：

方案1：服务端前缀匹配（推荐，性能最优，适合大数据量） #

该方案仅支持匹配用户名开头与输入内容一致的场景，比如用户名为「张三峰」，输入「张」「张三」可以命中，输入「三峰」无法命中，服务端查询性能极高。

1. 提前给chats集合的所有文档新增userNameLower字段，存储用户名的全小写格式，避免大小写导致匹配失效
2. 修改chatsSearchService代码：

Stream<QuerySnapshot<Map<String, dynamic>>> chatsSearchService(
    String userId, String searchValue) {
  final trimVal = searchValue.trim();
  // 空输入处理：如果需要空输入返回全部聊天，替换下面的return逻辑即可
  if (trimVal.isEmpty) {
    return const Stream.empty();
  }
  // 统一转小写做匹配，忽略大小写差异
  final searchLower = trimVal.toLowerCase();
  // 构造前缀匹配的上限值：最后一位字符Unicode编码+1
  final searchEnd = searchLower.substring(0, searchLower.length - 1) +
      String.fromCharCode(searchLower.codeUnitAt(searchLower.length - 1) + 1);
  
  return FirebaseFirestore.instance
      .collection('users')
      .doc(userId)
      .collection('chats')
      .where('userNameLower', isGreaterThanOrEqualTo: searchLower)
      .where('userNameLower', isLessThan: searchEnd)
      .snapshots();
}

该方案无需修改现有StreamBuilder代码。

方案2：本地全模糊匹配（适合单用户聊天记录小于1000条的场景） #

该方案支持任意位置字符匹配，比如用户名为「张三峰」，输入「三」「峰」都能命中，缺点是需要拉取全部聊天记录后本地过滤，数据量大时性能差。

1. 修改chatsSearchService代码：

Stream<List<QueryDocumentSnapshot<Map<String, dynamic>>>> chatsSearchService(
    String userId, String searchValue) {
  final searchLower = searchValue.trim().toLowerCase();
  return FirebaseFirestore.instance
      .collection('users')
      .doc(userId)
      .collection('chats')
      .snapshots()
      // 本地过滤用户名包含输入字符的记录
      .map((snapshot) => snapshot.docs.where((doc) {
            final userName = doc.data()['userName']?.toString().toLowerCase() ?? '';
            return userName.contains(searchLower);
          }).toList());
}

2. 对应修改StreamBuilder的代码适配返回类型：

StreamBuilder(
      stream: FirestoreServices()
          .chatsSearchService('${cubit.userModel?.id}', cubit.searchValue),
      builder: (context,
          AsyncSnapshot<List<QueryDocumentSnapshot<Map<String, dynamic>>>> snap) {
        if (!snap.hasData) {
          return Container();
        }
        final chatDocs = snap.data!;
        return ListView.separated(
            physics: const BouncingScrollPhysics(),
            itemBuilder: (context, index) {
              LastMessagesModel currentChats =
                  LastMessagesModel.fromJson(chatDocs[index].data());

              return InkWell(
                child: searchChatBody(user, context, currentChats),
              );
            },
            separatorBuilder: (context, index) {
              return const Divider();
            },
            itemCount: chatDocs.length);
      }),

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