Flutter中多Realtime Database监听器的管理与销毁问题

1. 单个变量存储多个群组监听器的问题 #

你当前用单个变量groupChatListener和lastReadTimestampListener存储监听器的方式存在严重缺陷：

• 每次调用getGroupChatsListener或getLastReadTimestampListener时，新创建的监听器会直接覆盖变量中存储的旧监听器引用。
• 旧的监听器会因为失去引用变成“游离”状态，既无法被主动取消，也无法被垃圾回收机制回收，最终引发内存泄漏，还会维持不必要的实时数据库连接，浪费资源。
• 举个实际场景：用户加入A、B两个群组，第一次调用getGroupChatsListener("A")时变量存A群的监听器；调用getGroupChatsListener("B")时，变量被替换成B群的监听器，A群的监听器引用彻底丢失，再也无法取消。

2. 页面销毁时能否正确取消所有监听器？ #

完全不能。

• 在dispose()方法中，你只能取消groupChatListener和lastReadTimestampListener变量中最后一次存储的监听器，之前所有被覆盖的群组监听器都无法被取消。
• 这些未被取消的监听器会持续监听实时数据库变化，即便页面已经销毁，不仅浪费资源，还可能触发已销毁页面的setState()，导致应用报错。

修复方案：用列表管理多监听器 #

我们需要改用列表来存储所有群组相关的监听器，确保每个监听器都能被追踪和取消：

修改后的代码示例 #

// 存储所有群组聊天监听器
final List<StreamSubscription> _groupChatListeners = [];
// 存储所有最后读取时间戳监听器
final List<StreamSubscription> _lastReadTimestampListeners = [];
StreamSubscription? _groupsListener;

@override
void initState() {
  super.initState();
  initialize();
}

void initialize() async {
  getGroupsListener();
}

@override
void dispose() {
  // 取消群组列表监听器
  _groupsListener?.cancel();
  // 批量取消所有群组聊天监听器
  for (final listener in _groupChatListeners) {
    listener.cancel();
  }
  // 批量取消所有最后读取时间戳监听器
  for (final listener in _lastReadTimestampListeners) {
    listener.cancel();
  }
  super.dispose();
}

// 获取用户加入的所有群组
void getGroupsListener() async {
  await globals.userGlobals();
  final groupsStream = FirebaseFirestore.instance
      .collection(globals.usersCollection)
      .doc(globals.currentUID)
      .collection(globals.groupsCollection)
      .snapshots();

  _groupsListener = groupsStream.listen((event) {
    tempGroupsList = [];
    for (var doc in event.docs) {
      tempGroupsList.add(doc.data());
    }

    // 先清理旧监听器，避免重复监听
    for (final listener in _groupChatListeners) {
      listener.cancel();
    }
    _groupChatListeners.clear();
    for (final listener in _lastReadTimestampListeners) {
      listener.cancel();
    }
    _lastReadTimestampListeners.clear();

    // 创建新监听器并加入列表
    tempGroupsList.forEach((element) {
      final group = ModelGroup.fromJson(element);
      _getLastReadTimestampListener(group.groupID);
      _getGroupChatsListener(group.groupID);
    });

    setState(() {
      // 更新UI...
    });
  });
}

// 获取指定群组的所有聊天
void _getGroupChatsListener(String groupID) async {
  await globals.userGlobals();
  if (groupID.isEmpty) return;

  final node = globals.groupChatsNode(groupID);
  final groupChatRef = FirebaseDatabase.instance.ref(node);

  final listener = groupChatRef.onValue.listen((event) {
    final data = event.snapshot.value;
    // 处理聊天数据逻辑
  });
  _groupChatListeners.add(listener);

  setState(() {
    // 更新UI...
  });
}

// 获取指定群组的最后读取时间戳
void _getLastReadTimestampListener(String groupID) async {
  await globals.userGlobals();
  if (groupID.isEmpty) return;

  final node = globals.groupActivityNode(groupID);
  final groupActivityRef = FirebaseDatabase.instance.ref(node);

  final listener = groupActivityRef.onValue.listen((event) {
    final data = event.snapshot.value;
    // 处理时间戳数据逻辑
  });
  _lastReadTimestampListeners.add(listener);

  setState(() {
    // 更新UI...
  });
}

关键改进点 #

1. 列表存储多监听器：_groupChatListeners和_lastReadTimestampListeners会保存每个群组对应的监听器引用，不会出现覆盖丢失的情况。
2. 群组更新前清理旧监听器：在groupsStream的回调中，先取消并清空之前的所有群组监听器，再创建新的，避免同一群组被重复监听。
3. dispose时批量取消：遍历所有监听器列表，逐个调用cancel()，确保所有监听器都被正确销毁。

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