Flutter数据流控制插件streamed_controller的使用

Flutter数据流控制插件streamed_controller的使用

简介

streamed_controller 是一个用于Flutter应用的状态管理库。它基于Flutter的 ChangeNotifier, Stream 和 InheritedNotifier，并且不依赖于任何第三方库。它支持多种并发处理方式，并且可以方便地监听状态变化。

特点

• 并发处理: 支持多样化的并发处理方式（如可丢弃、节流、去抖动、并发和可重启）。
• 无第三方依赖: 基于Flutter的 ChangeNotifier, Stream 和 InheritedNotifier。
• 多样的监听方式: 可以通过 ListenableBuilder, InheritedWidget/InheritedNotifier, StreamBuilder 等方式监听状态变化。
• 复杂状态管理: 能够处理复杂的认证、分页、通知、加载和状态处理等场景。

开始使用

首先，在你的 pubspec.yaml 文件中添加 streamed_controller 依赖：

dependencies:
  streamed_controller: ^x.x.x

然后运行以下命令来安装该包：

flutter pub add streamed_controller

使用示例

定义控制器类

class TestControllerBase extends StreamedController<int> {
  TestControllerBase() : super(initialState: 0, eventHandler: ConcurrentConcurrencyHandler());

  void increment() => handle(_increment(), eventName: 'increment');

  Stream<int> _increment() => () async* {
    yield state + 1;
    await Future.delayed(const Duration(seconds: 2));
    yield state + 2;
  }();
}

创建控制器变量

final $controller = TestControllerBase();

监听状态变化

在需要响应状态变化的 Widget 中使用 ListenableBuilder 或 AnimatedBuilder 来监听状态变化：

class _MyHomePageState extends State<MyHomePage> {
  final $controller = TestControllerBase();

  @override
  void initState() {
    $controller.addListener(() => print('[${$controller.runtimeType}] State: ${$controller.state}'));
    super.initState();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            const Text('You have pushed the button this many times:'),
            // 使用 ListenableBuilder 监听状态变化
            ListenableBuilder(
              listenable: $controller,
              builder: (context, child) => Text(
                '${$controller.state}',
                style: Theme.of(context).textTheme.headlineMedium,
              ),
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: $controller.increment,
        tooltip: 'Async increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}

自定义观察器

你可以创建自定义观察器来监听控制器的生命周期事件：

class _TestControllerObserver extends StreamedControllerObserver {
  @override
  void onCreate(StreamedController<Object> controller) =>
      print('${controller.runtimeType} created');

  @override
  void onDispose(StreamedController<Object> controller) =>
      print('${controller.runtimeType} disposed');

  @override
  void onError(StreamedController<Object>? controller, Object? error, StackTrace stackTrace) =>
      print('${controller.runtimeType} got error: $error');

  @override
  void onStateChanged(StreamedController<Object> controller, Object prevState, Object nextState) =>
      print('${controller.runtimeType} state updated, new state: $nextState');
}

然后将观察器分配给 StreamedController：

StreamedController.observer = _TestControllerObserver();