Riverpod中StreamProvider是否自动销毁旧Stream实例及订阅？

问题场景 #

以下是使用Dart Riverpod编写的伪代码：

final dependingStreamProvider = StreamProvider.autoDispose<int>((ref) {
  final depending = ref.watch(dependingProvider);

  if (depending == typeA) {
     return AStream(); // 返回int类型的流
  } else {
     return BStream(); // 返回另一个int类型的流
  }
});

当dependingProvider状态变化时，StreamProvider会创建新的Stream实例，疑问点在于：Riverpod是否会自动销毁过时的Stream实例（即关闭其StreamController），还是需要手动处理？

结论与解决方案 #

Riverpod不会自动关闭你自行创建的StreamController，但可以通过ref.onDispose回调实现自动销毁逻辑，具体如下：

1. 核心逻辑：当dependingProvider状态变化时，StreamProvider.autoDispose会销毁旧的provider实例，此时该实例注册的ref.onDispose回调会被触发。你需要在回调中关闭对应的StreamController，避免资源泄漏。

2. 修改后的示例代码：

final dependingStreamProvider = StreamProvider.autoDispose<int>((ref) {
  final depending = ref.watch(dependingProvider);
  late StreamController<int> controller;

  if (depending == typeA) {
     controller = StreamController<int>();
     // 此处添加AStream的数据流逻辑
  } else {
     controller = StreamController<int>();
     // 此处添加BStream的数据流逻辑
  }

  // 注册销毁回调，确保旧实例被销毁时关闭控制器
  ref.onDispose(() => controller.close());
  return controller.stream;
});

补充说明 #

• 如果你的Stream来自第三方库，或者是本身具备自清理能力的流（比如Stream.fromFuture、Stream.periodic在完成/取消后自动关闭的流），则无需额外处理；
• 仅当你自行创建StreamController时，必须通过ref.onDispose注册关闭逻辑，否则会导致未关闭的控制器占用资源，引发内存泄漏问题。

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