Flutter未知功能探索插件flutter_onlooker的使用

flutter_onlooker 是一个用于状态管理和导航的Flutter库。它提供了 StateNotifier, StateObserver 和 StateNotifierProvider 类，帮助开发者简化状态管理及导航事件处理。

功能概览

• StateNotifier: 负责注册和通知状态，并能发出导航事件。
• StateObserver: 根据新的状态构建Widget。
• StateNotifierProvider: 创建 StateNotifier 实例，并提供给子Widget访问。

StateNotifier 主要方法

• observable<S>: 注册可观察的状态。
• initial<S>: 返回初始状态值。
• latest<S>: 返回最新状态值。
• contains<S>: 检查是否已注册某种类型的状态。
• notify<S>: 通知新状态。
• navigate<T extends Object?>: 发出导航事件。

示例代码

下面是一个完整的示例demo，展示了如何使用 flutter_onlooker 插件。

import 'package:flutter/material.dart';
import 'package:flutter_onlooker/flutter_onlooker.dart';

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

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: StateNotifierProvider<IncrementStateNotifier>(
        create: (_) => IncrementStateNotifier(),
        child: const MyHomePage(title: 'Onlooker Demo'),
        router: (context, routeName, arguments) {
          return showDialog<void>(
            context: context,
            builder: (_) => AlertDialog(
              title: Text("Route is '$routeName'"),
              content: Text("You've clicked $arguments times!"),
            ),
          );
        },
      ),
    );
  }
}

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

  final String title;

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            const Text(
              'You have pushed the button this many times:',
            ),
            const SizedBox(
              height: 8,
            ),
            StateObserver<IncrementStateNotifier, int>(
              builder: (_, state) {
                return Text(
                  '$state',
                  style: Theme.of(context).textTheme.headlineMedium,
                );
              },
            ),
            const SizedBox(
              height: 8,
            ),
            ElevatedButton(
              onPressed: context.read<IncrementStateNotifier>().showCounterInfo,
              child: const Text(
                'Show counter value',
              ),
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: context.read<IncrementStateNotifier>().increment,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}

class IncrementStateNotifier extends StateNotifier {
  IncrementStateNotifier() {
    observable<int>(initial: 0);
  }

  void increment() {
    final latestState = latest<int>();
    notify<int>(latestState + 1);
  }

  void showCounterInfo() {
    final latestState = latest<int>();
    navigate<void>(
      '/show-dialog',
      arguments: latestState,
    );
  }
}