Flutter资源管理插件disposebag的使用

disposebag

DisposeBag 是一个用于帮助取消 StreamSubscriptions 和关闭 Sinks 的 Dart 包。它由 Petrus Nguyễn Thái Học 开发，可以通过 GitHub 仓库获取更多信息和提交问题。

Medium 文章

• 如何在Flutter中轻松取消流

使用方法

下面是一个简单的使用示例：

import 'package:disposebag/disposebag.dart';
import 'dart:async';

main() async {
  final controllers = <StreamController>[];
  final subscriptions = <StreamSubscription>[];

  final bag = DisposeBag([...subscriptions, ...controllers]);

  await Stream.value(3).listen(null).disposedBy(bag);
  await StreamController<int>.broadcast().disposedBy(bag);
  await StreamController<int>.broadcast(sync: true).disposedBy(bag);

  await bag.dispose();
  print("Bag disposed. It's all good");
}

API

1. Add, addAll

Future<bool> DisposeBag.add(StreamSubscription);
Future<bool> DisposeBag.add(Sink);
Future<void> DisposeBag.addAll(Iterable<StreamSubscription>);
Future<void> DisposeBag.addAll(Iterable<Sink>);

// extension methods
Future<bool> StreamSubscription.disposedBy(DisposeBag);
Future<bool> Sink.disposedBy(DisposeBag);
Future<void> Iterable<StreamSubscription>.disposedBy(DisposeBag);
Future<void> Iterable<Sink>.disposedBy(DisposeBag);

2. Delete (removes but does not dispose)

bool delete(StreamSubscription);
bool delete(Sink);

3. Remove (removes and disposes)

Future<bool> remove(StreamSubscription);
Future<bool> remove(Sink);

4. Clear, dispose

Future<void> clear();
Future<void> dispose();

示例代码

以下是一个更完整的示例，展示了如何使用 DisposeBag 来管理多个流和订阅：

import 'dart:async';
import 'package:disposebag/disposebag.dart';

List<Object> get _disposables {
  final controllers = <StreamController<Object>>[
    StreamController<int>()
      ..add(1)
      ..add(2),
    StreamController<int>(sync: true)
      ..add(3)
      ..add(4),
    StreamController<int>.broadcast()
      ..add(5)
      ..add(6),
    StreamController<String>.broadcast(sync: true)
      ..add('7')
      ..add('8'),
  ];
  final subscriptions = <StreamSubscription>[
    Stream.periodic(const Duration(milliseconds: 100), (i) => i)
        .listen((data) => print('[1] $data')),
    Stream.periodic(const Duration(milliseconds: 10), (i) => i)
        .listen((data) => print('[2] $data')),
    for (int i = 0; i < controllers.length; i++)
      controllers[i].stream.listen((data) => print('[${i + 3}] $data')),
  ];
  return [...controllers, ...subscriptions];
}

void main() async {
  DisposeBagConfigs.logger = disposeBagDefaultLogger;
  final bag = DisposeBag(_disposables);

  // add & addAll
  await bag.add(Stream.value(1).listen(null));
  await bag.addAll([
    Stream.value(2).listen(null),
    Stream<void>.periodic(const Duration(seconds: 1)).listen(null),
  ]);

  // disposedBy
  await Stream.value(3).listen(null).disposedBy(bag);
  await StreamController<int>.broadcast().disposedBy(bag);
  await StreamController<int>.broadcast(sync: true).disposedBy(bag);

  // await before clearing
  await Future<void>.delayed(const Duration(seconds: 1));
  await bag.clear();
  await bag.clear();
  await bag.clear();

  // adding after clearing
  await Future<void>.delayed(const Duration(seconds: 1));
  await Stream.periodic(const Duration(milliseconds: 100), (i) => i)
      .listen(print)
      .disposedBy(bag);

  // await before disposing
  await Future<void>.delayed(const Duration(seconds: 2));
  await bag.dispose();
  print("Bag disposed: ${bag.isDisposed}. It's all good");
  await Future<void>.delayed(const Duration(seconds: 2));
}

通过 DisposeBag，你可以更方便地管理流和订阅的生命周期，确保在适当的时候释放资源，避免内存泄漏。希望这个插件能帮助你在 Flutter 应用中更好地管理资源！如果有任何问题或建议，欢迎访问 GitHub 仓库 提交 issue。