Flutter流选择器插件stream_selector的使用

stream_selector 是一个 Flutter 插件，用于从多个流中选择一个流进行监听。它可以帮助你在多个流之间进行动态切换，只监听当前激活的流，从而减少不必要的资源消耗。这在处理多个数据源或状态流的场景中非常有用。

安装

首先，你需要在 pubspec.yaml 文件中添加 stream_selector 依赖：

dependencies:
  flutter:
    sdk: flutter
  stream_selector: ^1.0.0  # 请检查最新版本

然后运行 flutter pub get 来安装依赖。

基本用法

stream_selector 的核心是 StreamSelector 类。你可以通过它来管理多个流，并根据条件选择其中一个流进行监听。

1. 创建 StreamSelector

首先，你需要创建一个 StreamSelector 实例，并传入多个流：

import 'package:stream_selector/stream_selector.dart';

final streamSelector = StreamSelector<String>(
  streams: [
    stream1,
    stream2,
    stream3,
  ],
);

2. 选择流

你可以通过 select 方法来选择一个流进行监听。select 方法接受一个索引参数，表示你要选择的流在 streams 列表中的位置。

streamSelector.select(0);  // 选择第一个流

3. 监听选择的流

你可以通过 selectedStream 属性来获取当前选择的流，并进行监听：

streamSelector.selectedStream.listen((data) {
  print('Received data: $data');
});

4. 切换流

你可以在任何时候通过 select 方法来切换流：

streamSelector.select(1);  // 切换到第二个流

切换后，selectedStream 会自动更新，并且之前的监听器会自动取消。

完整示例

以下是一个完整的示例，展示了如何使用 stream_selector 来管理多个流：

import 'dart:async';
import 'package:flutter/material.dart';
import 'package:stream_selector/stream_selector.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: StreamSelectorExample(),
    );
  }
}

class StreamSelectorExample extends StatefulWidget {
  [@override](/user/override)
  _StreamSelectorExampleState createState() => _StreamSelectorExampleState();
}

class _StreamSelectorExampleState extends State<StreamSelectorExample> {
  final StreamController<String> _controller1 = StreamController();
  final StreamController<String> _controller2 = StreamController();
  final StreamController<String> _controller3 = StreamController();

  late StreamSelector<String> _streamSelector;

  [@override](/user/override)
  void initState() {
    super.initState();
    _streamSelector = StreamSelector<String>(
      streams: [
        _controller1.stream,
        _controller2.stream,
        _controller3.stream,
      ],
    );

    // 默认选择第一个流
    _streamSelector.select(0);

    // 监听选择的流
    _streamSelector.selectedStream.listen((data) {
      print('Received data: $data');
    });
  }

  [@override](/user/override)
  void dispose() {
    _controller1.close();
    _controller2.close();
    _controller3.close();
    _streamSelector.dispose();
    super.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Stream Selector Example'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            ElevatedButton(
              onPressed: () {
                _controller1.add('Data from Stream 1');
              },
              child: Text('Emit from Stream 1'),
            ),
            ElevatedButton(
              onPressed: () {
                _controller2.add('Data from Stream 2');
              },
              child: Text('Emit from Stream 2'),
            ),
            ElevatedButton(
              onPressed: () {
                _controller3.add('Data from Stream 3');
              },
              child: Text('Emit from Stream 3'),
            ),
            SizedBox(height: 20),
            ElevatedButton(
              onPressed: () {
                _streamSelector.select(0);
              },
              child: Text('Select Stream 1'),
            ),
            ElevatedButton(
              onPressed: () {
                _streamSelector.select(1);
              },
              child: Text('Select Stream 2'),
            ),
            ElevatedButton(
              onPressed: () {
                _streamSelector.select(2);
              },
              child: Text('Select Stream 3'),
            ),
          ],
        ),
      ),
    );
  }
}