flutter中状态管理Provider


1.1. 继承关系图

image.png

1.2. 各种Provider

1.2.1. 基础Provider

有点类似于替代 StatefulWidget, 其一些功能相当于State.initState和State.Dispose的组合，在State.initState中只调用Create一次。我们不能使用InheritedWidget，因为它要求值是构造时进行初始化(final标记）。

需要注意：create 会被延迟调用。当第一次值被读取的时候，才会调用 create 函数。所以，这样设置 lazy: false 没有作用。

代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
class Model {
  void dispose() {}
}

class Stateless extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Provider<Model>(
      create: (context) =>  Model(),
      dispose: (context, value) => value.dispose(),
      child: ...,
    );
  }
}
// 另一种创建方式
Provider.value({
    Key key,
    @required T value,
    UpdateShouldNotify<T> updateShouldNotify,
    Widget child,
  })

1.2.1.1. 用法

可用于常量在树中的全局使用。

1.2.2. InheritedProvider

是一个基类，一个InheritedWidget的通用实现。任何widget的子孙都可以通过 Provider.of. 方式来获取值。一般不直接使用。 需要的时候，使用 Provider 即可。

1.2.3. ListenableProvider

可监听的 Provider 。当监听的事件触发的时候，会使子孙节点进行重建。

用法的话，参看 ChangeNotifierProvider 。ChangeNotifierProvider是继承于 ListenableProvider，并且添加了 ChangeNotifier.。

通常使用 ChangeNotifierProvider 即可。但是在需要自己实现监听，或者动画的时候，需要直接使用 ListenableProvider。

1.2.4. ChangeNotifierProvider

1.2.4.1. 关于创建 ChangeNotifier

  • 不要在build函数中使用 ``ChangeNotifierProvider.value`，否则导致内存泄漏，产生潜在的副作用。from
  • 在create函数中创建ChangeNotifier
  • 不用依赖于变量创建ChangeNotifier，否则，变量更新，这个不会跟着更新；需要是需要变量的话，要使用 ChangeNotifierProxyProvider 。
  • 要使用同一个ChangeNotifier实例（重复利用），需要用 ChangeNotifierProvider.value ，而不是默认的构造器。
1
2
3
4
5
6
7
8
9
10
ChangeNotifierProvider(
  create: (_) => new MyChangeNotifier(),
  child: ...
)
///res/
MyChangeNotifier variable;
ChangeNotifierProvider.value(
  value: variable,
  child: ...
)

1.2.5. ListenableProxyProvider 系列

类比 ListenableProvider

1.2.6. ChangeNotifierProxyProvider 系列

用一个外部的值来同步内部的 ChangeNotifier 。

看下面原始provider的代码。

1
2
3
4
5
6
7
8
ChangeNotifierProvider(
  create: (context) {
    return MyChangeNotifier(
      myModel: Provider.of<MyModel>(context, listen: false),
    );
  },
  child: ...
)

在上面的例子中，使用 MyModel 类构造 MyChangeNotifier 。只要 MyModel 不发生改变，上面的代码就不会有问题。一旦变化，MyChangeNotifier不会同步更新。

如何做到同步更新呢？使用下面的代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
ChangeNotifierProxyProvider<MyModel, MyChangeNotifier>(
  create: (_) => MyChangeNotifier(),
  update: (_, myModel, myNotifier) => myNotifier
    ..update(myModel),// 这里两个.表示返回的还是当前对象，如果一个点，返回的是更新函数中的返回值。
  child: ...
);
class MyChangeNotifier with ChangeNotifier {
  void update(MyModel myModel) {
    // Do some custom work based on myModel that may call `notifyListeners`
  }
}

// Not Do:
ChangeNotifierProxyProvider<MyModel, MyChangeNotifier>(
  // may cause the state to be destroyed involuntarily（不由自主的）
  update: (_, myModel, myNotifier) => MyChangeNotifier(myModel: myModel),
  child: ...
);

注意：不要在update函数中再次创建 ChangeNotifier 。这样会造成不必要的开销：处理掉之前的notifier，并订阅新的通知。

1.2.7. ProxyProvider 系列

基于其他 Provider的组合（仅仅适用于组合，如果有其他逻辑，比如http请求，则需要使用上面的 ChangeNotifierProxyProvider ），是 ProxyProvider0 的语法糖 。带有 Proxy字眼的都是依赖于其他Provider。

ProxyProvider 等价于下面的代码：

1
2
3
4
5
6
ProxyProvider0<Result>(
  update: (context, result) {
    final a = Provider.of<A>(context);
    return update(context, a, b, result);
  }
);

ProxyProvider2 等价于下面的代码：

1
2
3
4
5
6
7
ProxyProvider0<Result>(
  update: (context, result) {
    final a = Provider.of<A>(context);
    final b = Provider.of<B>(context);
    return update(context, a, b, result);
  }
);

1.3. 引用方法

顶层扁平模式包裹：

1
2
3
4
5
6
7
8
MultiProvider(
  providers: [
    Provider<Something>(create: (_) => Something()),
    Provider<SomethingElse>(create: (_) => SomethingElse()),
    Provider<AnotherThing>(create: (_) => AnotherThing()),
  ],
  child: someWidget,
)

1.3.1. action中

1
2
3
var counter = Provider.of<Counter>(context, listen: false);
var value = counter.value;
counter.increase();

1.3.2. Consumer

不做额外的工作，只是在新的widget中调用 Provider.of ，然后再使用代理的 builder 函数。

使用场景：

  1. 不能使用 Provider.of. 的时候，比如当前build函数中使用provider。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
@override
// 抛出 ProviderNotFoundException 异常。因为当前context中没有。
Widget build(BuildContext context) {
  return ChangeNotifierProvider(
    create: (_) => Foo(),
    child: Text(Provider.of<Foo>(context).value),
  );
}
// 可以使用下面的代码：
@override
Widget build(BuildContext context) {
  return ChangeNotifierProvider(
    create: (_) => Foo(),
    child: Consumer<Foo>(
      builder: (_, foo, __) => Text(foo.value),
    },
  );
}
  1. 帮助性能优化，提供更细粒度的重建
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
@override
// 当 Bar 更新的时候，FooWidget和BarWidget都会重建，默认listen： true。
 Widget build(BuildContext context) {
   return FooWidget(
     child: BarWidget(
       bar: Provider.of<Bar>(context),
     ),
   );
 }

 @override
 // 当 Bar 更新的时候，只有BarWidget会重建
 Widget build(BuildContext context) {
   return FooWidget(
     child: Consumer<Bar>(
       builder: (_, bar, __) => BarWidget(bar: bar),
     ),
   );
 }

  @override
  // 当 foo 更新的时候，只有FooWidgett会重建，BarWidget不会重建。（builder部分会重建）
 Widget build(BuildContext context) {
   return Consumer<Foo>(
     builder: (_, foo, child) => FooWidget(foo: foo, child: child),
     child: BarWidget(),
   );
 }

注意：Consumer 也能用在 MultiProvider 里面。此时需要使用child参数。

1
2
3
4
5
6
7
8
9
MultiProvider(
  providers: [
    Provider(create: (_) => Foo()),
    Consumer<Foo>(
      builder: (context, foo, child) =>
        Provider.value(value: foo.bar, child: child),
    )
  ],
);

一般 Consumer 中builder返回widget，这里返回 Provider，不知道如果使用。

1.3.3. Selector系列

过滤更新，进行更小范围的Widget重建。默认比较算法使用 DeepCollectionEquality （collection库中），可以使用函数 shouldRebuild 重写。

被选中的值必须是不可变更的，否则选择器可能认为不需要重建。

选择器函数应该返回 List/Map/Set/Iterable 等集合类型或者是实现了 == 重载的类。有多个值的时候，比较简单的方法是使用元组Tuple,这样就不用重载 ==了。

1
2
3
4
5
6
Selector<Foo, Tuple2<Bar, Baz>>(
  selector: (_, foo) => Tuple2(foo.bar, foo.baz),
  builder: (_, data, __) {
    return Text('${data.item1}  ${data.item2}');
  }
)

foo.bar 或者 foo.baz 变更的时候才进行重建。

1.4. 其他问题

  • 对于通用组件中的使用问题。model转化成viewModel？
  • 最佳实践？

1.5. 参考

  • 官方文档
  • 一个之前版本的例子：SEBorrowAndLendAPP
  • Flutter 46: 图解新的状态管理 Provider (一)
  • Flutter App状态管理--Provider v3.1
  • flutter中的状态管理Provider