Flutter资源管理插件stream_disposable的使用

Flutter资源管理插件stream_disposable的使用

标题

Stream Disposable

内容

• Package介绍：stream_disposable 是一个帮助处理 Streams 和 Sinks 的包。
• 简单使用示例：
  • 创建一个可丢弃的对象：

    var disposable = StreamDisposable();
    

  • 添加 StreamSubscription 或 Sink 到它：

    var streamToDispose = Stream.fromIterable([1, b, as]);
    disposable.add(streamToDispose.listen(print))
    

  • 在状态类的 dispose 方法中或等效的地方，可以调用：

    disposable.dispose(className: this.runtimeType.toString())
    

可用方法

• add: 添加一个 Sink 或一个 StreamSubscription 到可丢弃的对象。如果添加了另一种类型的对象或可丢弃的对象已经被丢弃，则会抛出错误。
• Future<void> didDispose: 当 StreamDisposable 被丢弃时完成的 Future。
• bool isDisposed: 检查可丢弃的对象是否已被丢弃的布尔值。
• Future<void> dispose: 处理当前的 Sink 和 StreamSubscription 并将它们从这个实例中移除。如果在处理 dispose 行动或可丢弃的对象已经被丢弃时抛出错误。

示例代码

import 'dart:async';

import 'package:flutter/material.dart';

import 'package:stream_disposable/stream_disposable.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  var disposable = StreamDisposable();

  void _incrementCounter() {
    Navigator.of(context)
        .push(MaterialPageRoute(builder: (context) => PageB()));
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Container(
              padding: EdgeInsets.symmetric(horizontal: 20),
              child: Text(
                'Click on the button to go to the next page and stop counting:',
                softWrap: true,
                textAlign: TextAlign.center,
              ),
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.displayLarge,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: Icon(Icons.add),
      ),
    );
  }

  [@override](/user/override)
  void initState() {
    super.initState();
    var controller = StreamController<int>();
    var sink = controller.sink;
    var stream = controller.stream;
    disposable.add(stream.listen((data) {
      setState(() {
        _counter = data;
      });
    }));

    disposable.add(sink);

    Timer.periodic(Duration(milliseconds: 500), (i) {
      try {
        sink.add(i.tick);
      } catch (e) {
        print("Closed sink");
        i.cancel();
      }
    });
  }

  /// When pushing, we will dispose of the stream
  [@override](/user/override)
  void deactivate() {
    super.deactivate();
    disposable.dispose(className: this.runtimeType.toString());
  }
}

class PageB extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text("Page B"),
      ),
      body: Container(
        color: Colors.amber,
      ),
    );
  }
}