Flutter状态管理插件flutter_state_notifier的使用

简介

欢迎来到flutter_state_notifier的世界！这个库是为与state_notifier一起使用而设计的一个辅助包。它为StateNotifier添加了额外的Flutter绑定，例如与provider的集成。

可用的组件

StateNotifierProvider

StateNotifierProvider相当于ChangeNotifierProvider，但用于StateNotifier。

它的作用是创建一个StateNotifier并在提供者从widget树中移除时销毁它。如果创建的StateNotifier使用了LocatorMixin，StateNotifierProvider还将执行必要的操作以使read/update与provider协同工作。

它与大多数提供者类似，有一个小的区别：不是暴露一个值，而是同时暴露两个值：

• StateNotifier实例
• StateNotifier的state

这意味着当你编写以下代码时：

class MyState {}

class MyStateNotifier extends StateNotifier<MyState> {
  MyStateNotifier() : super(MyState());
}

// ...

MultiProvider(
  providers: [
    StateNotifierProvider<MyStateNotifier, MyState>(create: (_) => MyStateNotifier()),
  ]
)

你可以通过以下方式获取：

• 在widget树中获取StateNotifier实例，写法为context.read<MyStateNotifier>()
• 获取并观察当前的MyState，写法为context.watch<MyState>()

StateNotifierBuilder

StateNotifierBuilder等同于Flutter中的ValueListenableBuilder。

它允许你监听一个StateNotifier并根据其状态重建UI，但它不会创建、销毁或提供对象。

与StateNotifierProvider不同，这将不会使StateNotifier的read/update工作。

使用方法如下：

class MyState {}

class MyStateNotifier extends StateNotifier<MyState> {
  MyStateNotifier() : super(MyState());
}

// ...

MyStateNotifier stateNotifier;

return StateNotifierBuilder<MyState>(
  stateNotifier: stateNotifier,
  builder: (BuildContext context, MyState state, Widget child) {
    return Text('$state');
  },
)

示例代码

以下是一个完整的示例demo，展示了如何使用flutter_state_notifier来实现一个简单的计数器应用。

import 'package:flutter/material.dart';
import 'package:flutter_state_notifier/flutter_state_notifier.dart';
import 'package:provider/provider.dart';

// 定义状态类
class MyState {
  final int count;
  MyState(this.count);
}

// 定义状态通知器类
class MyStateNotifier extends StateNotifier<MyState> {
  MyStateNotifier() : super(MyState(0));

  void increment() {
    state = MyState(state.count + 1);
  }
}

// 日志记录器接口
abstract class Logger {
  void log(String message);
}

// 控制台日志记录器实现
class ConsoleLogger implements Logger {
  @override
  void log(String message) {
    print(message);
  }
}

void main() {
  runApp(
    MultiProvider(
      providers: [
        Provider<Logger>(create: (_) => ConsoleLogger()),
        StateNotifierProvider<MyStateNotifier, MyState>(
          create: (_) => MyStateNotifier(),
          // Override MyState to make it animated
          builder: (context, child) {
            return TweenAnimationBuilder<MyState>(
              duration: const Duration(milliseconds: 500),
              tween: MyStateTween(end: context.watch<MyState>()),
              builder: (context, state, _) {
                return Provider.value(value: state, child: child);
              },
            );
          },
        ),
      ],
      child: MyApp(),
    ),
  );
}

/// A [MyStateTween].
///
/// This will apply an [IntTween] on [MyState.count].
class MyStateTween extends Tween<MyState> {
  MyStateTween({MyState? begin, MyState? end}) : super(begin: begin, end: end);

  @override
  MyState lerp(double t) {
    final countTween = IntTween(begin: begin?.count, end: end?.count);
    // Tween the count
    return MyState(
      countTween.lerp(t),
    );
  }
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      title: 'Flutter Demo',
      home: MyHomePage(),
    );
  }
}

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

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Counter example'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
              context.select((MyState value) => value.count).toString(),
              style: Theme.of(context).textTheme.headlineMedium,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: context.read<MyStateNotifier>().increment,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}

在这个示例中，我们创建了一个简单的计数器应用，使用了flutter_state_notifier来进行状态管理，并且实现了计数器数值变化时的动画效果。希望这个例子能帮助你更好地理解和使用flutter_state_notifier。