Flutter WebSocket报错：Stream已被监听问题的解决方案求助

你遇到的Bad state: Stream has already been listened to错误，根源是WebSocket的channel.stream属于单订阅流，这类流的设计只能被监听一次，重复调用listen()就会触发这个错误。原代码每次调用listenToMessage都会创建新的订阅，自然会触发报错。

下面是两种可行的解决方案：

方案1：将单订阅流转为广播流 #

把WebSocket的stream转换成广播流，这样就能支持多个订阅者。修改后的代码如下：

// 仅需执行一次，将原单订阅流转为广播流
final broadcastStream = channel.stream.asBroadcastStream();

void listenToMessage(Function(String) onMessageReceived) {
  final subscription = broadcastStream.listen((message) {
    final String msg;
    if (message is String) {
      msg = message;
    } else {
      msg = utf8.decode(message);
    }
    onMessageReceived(msg);
  }, onError: (error) {
    print("Error receiving message: $error");
  });

  // 建议让调用方保存subscription，在不需要监听时（如页面销毁）执行subscription.cancel()
}

注意：广播流不会缓存历史事件，新订阅者只能收到订阅之后的消息，需根据业务场景判断是否适用。

方案2：维护全局订阅+回调列表 #

如果不需要多个独立订阅，而是希望所有监听逻辑共享同一个流，可以维护一个全局订阅，通过回调列表分发消息：

// 全局变量：保存所有消息回调
final List<Function(String)> _messageCallbacks = [];
StreamSubscription? _globalSubscription;

void initWebSocketListener() {
  // 仅初始化一次全局订阅
  if (_globalSubscription != null) return;

  _globalSubscription = channel.stream.listen((message) {
    final String msg = message is String ? message : utf8.decode(message);
    // 遍历所有回调，分发消息
    for (final callback in _messageCallbacks) {
      callback(msg);
    }
  }, onError: (error) {
    print("Error receiving message: $error");
  }, onDone: () {
    _globalSubscription?.cancel();
    _globalSubscription = null;
  });
}

void addMessageListener(Function(String) onMessageReceived) {
  // 初始化全局订阅（如果未初始化）
  initWebSocketListener();
  // 添加回调到列表（避免重复添加）
  if (!_messageCallbacks.contains(onMessageReceived)) {
    _messageCallbacks.add(onMessageReceived);
  }
}

void removeMessageListener(Function(String) onMessageReceived) {
  // 移除不再需要的回调
  _messageCallbacks.remove(onMessageReceived);
  // 若无回调，取消订阅节省资源
  if (_messageCallbacks.isEmpty) {
    _globalSubscription?.cancel();
    _globalSubscription = null;
  }
}

使用方式：

• 需要监听消息时调用addMessageListener(yourCallback)
• 不需要监听时（如页面销毁）调用removeMessageListener(yourCallback)

额外注意事项 #

• 原代码中subscription.onDone(() => subscription.cancel());是多余的，onDone触发时订阅已完成，无需再次取消。
• 务必在合适时机取消订阅，避免内存泄漏。

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