Flutter资源清理插件disposed的使用

Disposed 库提供了自动对象清理的包装器，利用了 Finalizer。

注意事项

DisposableContainer 中的内部 Disposable 对象 必须 不要强引用其父容器，否则将导致内存泄漏，并且对象不仅永远不会被释放，还会一直保留在内存中直到程序运行结束。

功能特点

• 使用此包可以创建对象析构函数。

使用方法

以下是一个示例：

// 包含可处置对象，同时也是可处置自身。
class NotificationsProvider extends DisposableContainer implements Disposable {
  final _notificationsController = DisposableStreamController(
    StreamController<String>.broadcast(),
  );

  Stream<String> get notifications => _notificationsController.controller.stream;
 
  void notify(String message) {
    _notificationsController.controller.add(message);
  }

  [@override](/user/override)
  late final List<Disposable> disposables = [ _notificationsController, ];

  [@override](/user/override)
  void dispose() {
    // 注意：这将在 [disposables] 被处置之前调用。
    print('NotificationsProvider is disposed.');
  }
}

// 主容器
class NotificationsCenter extends DisposableContainer {
  NotificationsCenter(this.provider);

  final NotificationsProvider provider;

  void notify(String message) {
    provider.notify(message);
  }

  [@override](/user/override)
  late final List<Disposable> disposables = [ provider, ];
}

当示例中的 NotificationsCenter 实例变得不可访问时，内部的 Finalizer 将按以下顺序释放对象：

• NotificationsProvider - 内部可处置对象，也是包装器。
• DisposableStreamController - 内部可处置对象。

注意，NotificationsCenter 本身只是一个包装器（主包装器），它不会被处置，而是由语言的垃圾回收器进行垃圾收集。

这种顺序是因为父对象引用了子对象，因此垃圾回收器会先销毁父对象，然后子对象失去引用，也会被销毁。

完整示例代码

/// 在此示例中，我们将创建一个包含通知提供者的通知中心。
/// 
/// 这将说明如何创建自动关闭的 [Stream]。
library disposed_example;

import 'dart:async';

import 'package:disposed/disposed.dart';

class NotificationsProvider extends DisposableContainer implements Disposable {
  final _notificationsController = DisposableStreamController(
    StreamController<String>.broadcast(),
  );

  Stream<String> get notifications => _notificationsController.controller.stream;
 
  void notify(String message) {
    _notificationsController.controller.add(message);
  }

  [@override](/user/override)
  late final List<Disposable> disposables = [ _notificationsController, ];

  [@override](/user/override)
  void dispose() {
    // 注意：这将在 [disposables] 被处置之前调用。
    print('NotificationsProvider is disposed.');
  }
}

class NotificationsCenter extends DisposableContainer {
  NotificationsCenter(this.provider);

  final NotificationsProvider provider;

  void notify(String message) {
    provider.notify(message);
  }

  [@override](/user/override)
  late final List<Disposable> disposables = [ provider, ];
}

Future<void> main(List<String> args) async {
  // 创建对象。
  NotificationsProvider? provider = NotificationsProvider();
  NotificationsCenter? center = NotificationsCenter(provider);

  // 通过弱引用跟踪GC状态。
  final _provider = WeakReference(provider);
  final _center = WeakReference(center);

  // 监听一些通知。
  center.provider.notifications.listen(
    (event) => print('New notification: $event'),
    onDone: () => print('Notifications done.'),
  );

  // 执行一些操作。
  center.notify('Test!');
  await Future<void>.delayed(const Duration(milliseconds: 250));
  center.notify('Test 2!');

  // 使对象不可访问。
  provider = null;
  center = null;

  // 等待GC。
  while (_provider.target != null || _center.target != null) {
    await Future<void>.delayed(const Duration(milliseconds: 1));
    // 喂养内存以强制GC。
    // ignore: unused_local_variable
    final bigChunkOfData = '0' * 1024 * 1024 * 5; // 大约5MB的数据。
  }

  print('Disposables are disposed, objects garbage collected, streams closed.');
}