如何在Flutter的StreamBuilder中仅执行一次异步函数？

为什么readMessage()会执行两次？ #

StreamBuilder的builder回调会被多次触发：

• 初始加载时（snapshot处于loading状态）
• 流首次返回数据时（snapshot变为hasData）
• 后续流中有新消息更新时
• 甚至Widget重建（比如热重载、父组件重绘）也会触发

你直接在builder里调用readMessage()，自然会被多次执行，导致通知计数被重复扣除。

如何修复重复执行的问题？ #

方案1：用状态变量控制执行时机 #

把页面改成StatefulWidget，添加状态变量标记是否已执行过标记操作，避免重复触发：

class ChatPage extends StatefulWidget {
  final String uid;
  const ChatPage({super.key, required this.uid});

  @override
  State<ChatPage> createState() => _ChatPageState();
}

class _ChatPageState extends State<ChatPage> {
  bool _hasMarkedUnreadMessages = false;
  late String chatRoom;

  @override
  void initState() {
    super.initState();
    chatRoom = chatroomId(FirebaseAuth.instance.currentUser!.uid, widget.uid);
  }

  void readMessage() async {
    final currentUserId = FirebaseAuth.instance.currentUser!.uid;
    final query = await FirebaseFirestore.instance
        .collection('chats')
        .doc(chatRoom)
        .collection('messages')
        .where('uid', isEqualTo: widget.uid)
        .where('read', isEqualTo: false)
        .get();

    if (query.docs.isEmpty) return; // 没有未读消息直接返回

    // 等待所有消息标记为已读完成
    await Future.wait(query.docs.map((doc) => doc.reference.update({'read': true})));

    final num = query.docs.length;
    await FirebaseFirestore.instance
        .collection('users')
        .doc(currentUserId)
        .update({
      "messagesNotification": FieldValue.increment(-num),
    });
  }

  @override
  Widget build(BuildContext context) {
    return Container(
      child: StreamBuilder(
        stream: FirebaseFirestore.instance
            .collection('chats')
            .doc(chatRoom)
            .collection('messages')
            .orderBy('createdAt', descending: true)
            .snapshots(),
        builder: (context, AsyncSnapshot<QuerySnapshot<Map<String, dynamic>>> snapshot) {
          // 仅当流有数据且未执行过标记操作时，调用readMessage
          if (snapshot.hasData && !_hasMarkedUnreadMessages) {
            setState(() {
              _hasMarkedUnreadMessages = true;
            });
            readMessage();
          }

          // 后续构建UI的代码...
          return const SizedBox();
        },
      ),
    );
  }
}

方案2：在页面初始化时执行一次 #

如果需求是进入聊天页面就标记所有未读消息为已读，直接在initState里调用readMessage()即可，完全不需要在StreamBuilder的builder里触发：

@override
void initState() {
  super.initState();
  chatRoom = chatroomId(FirebaseAuth.instance.currentUser!.uid, widget.uid);
  readMessage(); // 页面初始化时执行一次
}

这样只会执行一次，彻底避免重复触发的问题。

关于你的疑问：流中有新消息时是否会自动标记已读？ #

按照你原来的写法，是的——每次流有新消息（包括初始加载、对方发送新消息），builder都会触发，readMessage()也会跟着执行，从而自动标记新的未读消息为已读。但这种方式会导致重复执行，反而出问题。

如果需要新消息进来时自动标记已读，可以在builder里判断当前快照是否是新数据，比如对比前一次的快照文档数量，在新消息出现时触发标记操作：

class _ChatPageState extends State<ChatPage> {
  int _previousMessageCount = 0;
  // ...其他代码

  @override
  Widget build(BuildContext context) {
    return Container(
      child: StreamBuilder(
        stream: FirebaseFirestore.instance
            .collection('chats')
            .doc(chatRoom)
            .collection('messages')
            .orderBy('createdAt', descending: true)
            .snapshots(),
        builder: (context, AsyncSnapshot<QuerySnapshot<Map<String, dynamic>>> snapshot) {
          if (snapshot.hasData) {
            final currentCount = snapshot.data!.docs.length;
            // 当消息数量增加时，说明有新消息，执行标记
            if (currentCount > _previousMessageCount) {
              readMessage();
              setState(() {
                _previousMessageCount = currentCount;
              });
            }
          }

          // 构建UI...
          return const SizedBox();
        },
      ),
    );
  }
}

注：当前readMessage()逻辑已经是查询未读消息再处理，所以即使多次调用也不会重复扣除计数，但还是尽量减少不必要的Firestore调用更高效。

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