在Flutter开发中,状态管理是一个永恒的话题。一般的原则是:

  • 如果状态是组件私有的,则应该由组件自己管理;
  • 如果状态要跨组件共享,则该状态应该由各个组件共同的父元素来管理。

对于组件私有的状态管理很好理解,但对于跨组件共享的状态,管理的方式就比较多了,如
使用 全局事件总线EventBus (将在下一章中介绍),它是一个 观察者模式 的实现,通过它就可以实现跨组件状态同步:

  • 状态持有方(发布者)负责更新、发布状态
  • 状态使用方(观察者)监听状态改变事件来执行一些操作

下面我们看一个登陆状态同步的简单示例:
定义事件:

  1. enum Event{
  2. login,
  3. ... //省略其它事件
  4. }

登录页代码大致如下:

  1. // 登录状态改变后发布状态改变事件
  2. bus.emit(Event.login);

依赖登录状态的页面:

  1. void onLoginChanged(e){
  2. //登录状态变化处理逻辑
  3. }
  4. @override
  5. void initState() {
  6. //订阅登录状态改变事件
  7. bus.on(Event.login,onLogin);
  8. super.initState();
  9. }
  10. @override
  11. void dispose() {
  12. //取消订阅
  13. bus.off(Event.login,onLogin);
  14. super.dispose();
  15. }

我们可以发现,通过观察者模式来实现跨组件状态共享有一些明显的缺点:

  1. 必须显式定义各种事件,不好管理
  2. 订阅者必须需显式注册状态改变回调,也必须在组件销毁时手动去解绑回调以避免内存泄露。

在Flutter当中有没有更好的跨组件状态管理方式了呢?答案是肯定的,那怎么做的?
我们想想前面介绍的InheritedWidget,它的天生特性就是能绑定InheritedWidget与依赖它的子孙组件的依赖关系,并且当InheritedWidget数据发生变化时,可以自动更新依赖的子孙组件!利用这个特性,我们可以将需要跨组件共享的状态保存在InheritedWidget中,然后在子组件中引用InheritedWidget即可,Flutter社区著名的Provider包正是基于这个思想实现的一套跨组件状态共享解决方案,接下来我们便详细介绍一下Provider的用法及原理。

Provider

为了加强读者的理解,我们不直接去看 Provider 包的源代码,相反,我会带着你根据上面描述的通过InheritedWidget 实现的思路来一步一步地实现一个最小功能的Provider

1、建立一个保存的共享数据类

首先,我们需要一个保存需要共享的数据类 InheritedWidget
由于具体业务数据类型不可预期,为了通用性,我们使用泛型,定义一个继承 InheritedWidget的通用类:

  1. // 一个通用的InheritedWidget,保存任需要跨组件共享的状态
  2. class InheritedProvider<T> extends InheritedWidget {
  3. InheritedProvider({@required this.data, Widget child}) : super(child: child);
  4. //共享状态使用泛型
  5. final T data;
  6. @override
  7. bool updateShouldNotify(InheritedProvider<T> old) {
  8. //在此简单返回true,则每次更新都会调用依赖其的子孙节点的`didChangeDependencies`。
  9. return true;
  10. }
  11. }

数据保存的地方有了,那么接下来我们需要做的就是在数据发生变化的时候来重新构建 InheritedWidget,那么现在就面临两个问题:

  1. 数据发生变化怎么通知?
  2. 谁来重新构建 InheritedWidget?

2、数据变化构建

第一个问题其实很好解决,我们当然可以使用之前介绍的 eventBus来进行事件通知,但是为了更贴近Flutter开发,我们使用
Flutter中SDK中提供的 ChangeNotifier 类,它继承自Listenable,也实现了一个Flutter风格的发布者-订阅者模式
ChangeNotifier定义大致如下:

  1. class ChangeNotifier implements Listenable {
  2. @override
  3. void addListener(VoidCallback listener) {
  4. //添加监听器
  5. }
  6. @override
  7. void removeListener(VoidCallback listener) {
  8. //移除监听器
  9. }
  10. void notifyListeners() {
  11. //通知所有监听器,触发监听器回调
  12. }
  13. // ... 省略无关代码
  14. }

我们可以通过调用:

  • addListener() 添加监听器(订阅者)
  • removeListener() 移除监听器(订阅者)
  • notifyListeners() 可以触发所有监听器回调

现在,我们将要共享的状态放到一个Model类中,然后让它继承自ChangeNotifier,这样当共享的状态改变时,我们只需要调用 notifyListeners() 来通知订阅者,然后由订阅者来重新构建InheritedProvider,这也是第二个问题的答案!接下来我们便实现这个订阅者类:

  1. // 该方法用于在Dart中获取模板类型
  2. Type _typeOf<T>() => T;
  3. class ChangeNotifierProvider<T extends ChangeNotifier> extends StatefulWidget {
  4. ChangeNotifierProvider({
  5. Key key,
  6. this.data,
  7. this.child,
  8. });
  9. final Widget child;
  10. final T data;
  11. //定义一个便捷方法,方便子树中的widget获取共享数据
  12. static T of<T>(BuildContext context) {
  13. final type = _typeOf<InheritedProvider<T>>();
  14. final provider = context.inheritFromWidgetOfExactType(type) as InheritedProvider<T>;
  15. return provider.data;
  16. }
  17. @override
  18. _ChangeNotifierProviderState<T> createState() => _ChangeNotifierProviderState<T>();
  19. }

该类继承StatefulWidget,然后定义了一个 of() 静态方法供子类方便获取Widget树中的InheritedProvider中保存的共享状态(model)

下面我们实现该类对应的_ChangeNotifierProviderState类:

  1. class _ChangeNotifierProviderState<T extends ChangeNotifier> extends State<ChangeNotifierProvider<T>> {
  2. void update() {
  3. //如果数据发生变化(model类调用了notifyListeners),重新构建InheritedProvider
  4. setState(() => {});
  5. }
  6. @override
  7. void didUpdateWidget(ChangeNotifierProvider<T> oldWidget) {
  8. //当Provider更新时,如果新旧数据不"==",则解绑旧数据监听,同时添加新数据监听
  9. if (widget.data != oldWidget.data) {
  10. oldWidget.data.removeListener(update);
  11. widget.data.addListener(update);
  12. }
  13. super.didUpdateWidget(oldWidget);
  14. }
  15. @override
  16. void initState() {
  17. // 给model添加监听器
  18. widget.data.addListener(update);
  19. super.initState();
  20. }
  21. @override
  22. void dispose() {
  23. // 移除model的监听器
  24. widget.data.removeListener(update);
  25. super.dispose();
  26. }
  27. @override
  28. Widget build(BuildContext context) {
  29. return InheritedProvider<T>(
  30. data: widget.data,
  31. child: widget.child,
  32. );
  33. }
  34. }

可以看到_ChangeNotifierProviderState类的主要作用就是 监听到共享状态(model)改变时重新构建Widget树。

  • 注意,在_ChangeNotifierProviderState类中调用setState()方法,widget.child始终是同一个,所以执行build时,InheritedProvider的child引用的始终是同一个子widget,所以widget.child并不会重新build,这也就相当于对child进行了缓存!
  • 当然如果ChangeNotifierProvider父级Widget重新build时,则其传入的child便有可能会发生变化。

现在我们所需要的各个工具类都已完成,下面我们通过一个购物车的例子来看看怎么使用上面的这些类。

购物车示例

我们需要实现一个显示购物车中所有商品总价的功能:

  1. 向购物车中添加新商品时总价更新

定义一个Item类,用于表示商品信息:

  1. class Item {
  2. Item(this.price, this.count);
  3. double price; //商品单价
  4. int count; // 商品份数
  5. //... 省略其它属性
  6. }

定义一个保存购物车内商品数据的CartModel类:

  1. class CartModel extends ChangeNotifier {
  2. // 用于保存购物车中商品列表
  3. final List<Item> _items = [];
  4. // 禁止改变购物车里的商品信息
  5. UnmodifiableListView<Item> get items => UnmodifiableListView(_items);
  6. // 购物车中商品的总价
  7. double get totalPrice =>
  8. _items.fold(0, (value, item) => value + item.count * item.price);
  9. // 将 [item] 添加到购物车。这是唯一一种能从外部改变购物车的方法。
  10. void add(Item item) {
  11. _items.add(item);
  12. // 通知监听器(订阅者),重新构建InheritedProvider, 更新状态。
  13. notifyListeners();
  14. }
  15. }

CartModel即要跨组件共享的model类。最后我们构建示例页面:

  1. class ProviderRoute extends StatefulWidget {
  2. @override
  3. _ProviderRouteState createState() => _ProviderRouteState();
  4. }
  5. class _ProviderRouteState extends State<ProviderRoute> {
  6. @override
  7. Widget build(BuildContext context) {
  8. return Center(
  9. child: ChangeNotifierProvider<CartModel>(
  10. data: CartModel(),
  11. child: Builder(builder: (context) {
  12. return Column(
  13. children: <Widget>[
  14. Builder(builder: (context){
  15. var cart=ChangeNotifierProvider.of<CartModel>(context);
  16. return Text("总价: ${cart.totalPrice}");
  17. }),
  18. Builder(builder: (context){
  19. print("RaisedButton build"); //在后面优化部分会用到
  20. return RaisedButton(
  21. child: Text("添加商品"),
  22. onPressed: () {
  23. //给购物车中添加商品,添加后总价会更新
  24. ChangeNotifierProvider.of<CartModel>(context).add(Item(20.0, 1));
  25. },
  26. );
  27. }),
  28. ],
  29. );
  30. }),
  31. ),
  32. );
  33. }
  34. }

整合代码

  1. import 'package:flutter/material.dart';
  2. import 'dart:collection';
  3. void main() => runApp(new MyApp());
  4. class MyApp extends StatelessWidget {
  5. @override
  6. Widget build(BuildContext context) {
  7. return MaterialApp(
  8. debugShowCheckedModeBanner: true,
  9. title: 'WillPopScopeTestRoute',
  10. theme: ThemeData(
  11. primarySwatch: Colors.blue,
  12. ),
  13. home: Scaffold(
  14. appBar: AppBar(title: Text("跨组件状态管理(Provider)")),
  15. body: ProviderRoute(),
  16. ));
  17. }
  18. }
  19. class ProviderRoute extends StatefulWidget {
  20. @override
  21. _ProviderRouteState createState() => _ProviderRouteState();
  22. }
  23. class _ProviderRouteState extends State<ProviderRoute> {
  24. @override
  25. Widget build(BuildContext context) {
  26. return Center(
  27. child: ChangeNotifierProvider<CartModel>(
  28. data: CartModel(),
  29. child: Builder(builder: (context) {
  30. return Column(
  31. children: <Widget>[
  32. Builder(builder: (context) {
  33. var cart = ChangeNotifierProvider.of<CartModel>(context);
  34. return Text("总价: ${cart.totalPrice}");
  35. }),
  36. Builder(builder: (context) {
  37. print("RaisedButton build"); //在后面优化部分会用到
  38. return RaisedButton(
  39. child: Text("添加商品"),
  40. onPressed: () {
  41. //给购物车中添加商品,添加后总价会更新
  42. print("1:点击了添加商品");
  43. ChangeNotifierProvider.of<CartModel>(context)
  44. .add(Item(20.0, 1));
  45. },
  46. );
  47. }),
  48. ],
  49. );
  50. }),
  51. ),
  52. );
  53. }
  54. }
  55. //------------------------------------------------------------------------------------------
  56. class Item {
  57. Item(this.price, this.count);
  58. double price; //商品单价
  59. int count; // 商品份数
  60. }
  61. //观察者,CartModel里面更新后调度 notifyListeners(),触发
  62. class CartModel extends ChangeNotifier {
  63. // 用于保存购物车中商品列表
  64. final List<Item> _items = [];
  65. // 禁止改变购物车里的商品信息
  66. UnmodifiableListView<Item> get items => UnmodifiableListView(_items);
  67. // 购物车中商品的总价
  68. double get totalPrice {
  69. double totalPrice = _items.fold(0, (value, item) {
  70. return (value + item.count * item.price);
  71. });
  72. print("CartModel中的double get totalPrice = $totalPrice");
  73. return totalPrice;
  74. }
  75. // 将 [item] 添加到购物车。这是唯一一种能从外部改变购物车的方法。
  76. void add(Item item) {
  77. _items.add(item);
  78. notifyListeners(); // 通知监听器(订阅者),重新构建InheritedProvider, 更新状态
  79. }
  80. }
  81. /*
  82. 事件中心处理观察者模式
  83. var ChangeNotifier = {list:[update() { setState(() => {}) }],
  84. addListener:(){},
  85. removeListener:(){},
  86. notifyListeners:(){}
  87. }
  88. */
  89. class ChangeNotifier implements Listenable {
  90. List<VoidCallback> list = [];
  91. @override
  92. void addListener(VoidCallback listener) {
  93. //添加监听器
  94. list.add(listener);
  95. }
  96. @override
  97. void removeListener(VoidCallback listener) {
  98. //移除监听器
  99. list = [];
  100. }
  101. void notifyListeners() {
  102. //通知所有监听器,触发监听器回调
  103. list.forEach((item) => item());
  104. print("通知所有监听器,触发监听器回调");
  105. }
  106. }
  107. //-----------------------------------------------------------------------------
  108. // 该方法用于在Dart中获取模板类型
  109. Type _typeOf<T>() => T;
  110. class ChangeNotifierProvider<T extends ChangeNotifier> extends StatefulWidget {
  111. ChangeNotifierProvider({
  112. Key key,
  113. this.data,
  114. this.child,
  115. });
  116. final Widget child;
  117. final T data;
  118. //定义一个便捷方法,方便子树中的widget获取共享数据
  119. static T of<T>(BuildContext context) {
  120. final type = _typeOf<InheritedProvider<T>>();
  121. final provider =
  122. context.inheritFromWidgetOfExactType(type) as InheritedProvider<T>;
  123. var testTotalPrice = (provider.data as CartModel)
  124. ._items
  125. .fold(0, (value, item) => value + item.count * item.price);
  126. print("2:实现了第二步 ChangeNotifierProvider 【testTotalPrice $testTotalPrice】");
  127. return provider.data;
  128. }
  129. @override
  130. _ChangeNotifierProviderState<T> createState() =>
  131. _ChangeNotifierProviderState<T>();
  132. }
  133. class _ChangeNotifierProviderState<T extends ChangeNotifier>
  134. extends State<ChangeNotifierProvider<T>> {
  135. void update() {
  136. //如果数据发生变化(model类调用了 notifyListeners ),重新构建InheritedProvider
  137. setState(() => {});
  138. }
  139. @override
  140. void didUpdateWidget(ChangeNotifierProvider<T> oldWidget) {
  141. //当Provider更新时,如果新旧数据不"==",则解绑旧数据监听,同时添加新数据监听
  142. if (widget.data != oldWidget.data) {
  143. oldWidget.data.removeListener(update);
  144. widget.data.addListener(update);
  145. }
  146. super.didUpdateWidget(oldWidget);
  147. }
  148. @override
  149. void initState() {
  150. // 给model添加监听器
  151. widget.data.addListener(update);
  152. super.initState();
  153. }
  154. @override
  155. void dispose() {
  156. // 移除model的监听器
  157. widget.data.removeListener(update);
  158. super.dispose();
  159. }
  160. @override
  161. Widget build(BuildContext context) {
  162. // Future.delayed(Duration(milliseconds: 0), () {
  163. // setState(() {});
  164. // });
  165. print("【widget.data:${widget.data}】【widget.child:${widget.child}】");
  166. return InheritedProvider<T>(
  167. //调用ChangeNotifierProvider<T>传进来的CartModel,在这里是Instance of 'CartModel'
  168. data: widget.data,
  169. child: widget.child,
  170. );
  171. }
  172. }
  173. /*
  174. InheritedProvider, 保存任需要跨组件共享的状态,格式类型如下
  175. var InheritedProvider = {data:{CartModel:{
  176. _items:[],
  177. add:(){ _items.add(item); notifyListeners();}
  178. totalPrice:(){return <totalPrice>;}}}}
  179. */
  180. class InheritedProvider<T> extends InheritedWidget {
  181. InheritedProvider({@required this.data, Widget child}) : super(child: child);
  182. //共享状态使用泛型,用来存储传进来的widget
  183. final T data;
  184. @override
  185. bool updateShouldNotify(InheritedProvider<T> old) {
  186. print(
  187. "ShareDataWidget:【old:${old.data.toString()} new:$data ${old.data != data}】");
  188. //在此简单返回true,则每次更新都会调用依赖其的子孙节点的`didChangeDependencies`。
  189. return true;
  190. }
  191. }
  192. //——————————————————————————————————————————————————————————————————————————————————————————————————-
  193. // ChangeNotifierProvider -> InheritedProvider -> CartModel -> ChangeNotifier -> Listenable
  194. // ChangeNotifierProvider对象的data = CartModel,然后在 build 里面返回 InheritedProvider对象(把CartModel传给InheritedProvider)
  195. // CartModel 继承 ChangeNotifier,可以调用 ChangeNotifier 的方法
  196. // 每次调用 ChangeNotifierProvider.of<CartModel>(context) 就会触发 ChangeNotifier 中的 notifyListeners,
  197. // notifyListeners 中的 list.forEach((item) => item())会把存在的方法执行;
  198. //——————————————————————————————————————————————————————————————————————————————————————————————————-
  199. /*
  200. 1:点击了添加商品
  201. 2:实现了第二步 ChangeNotifierProvider 【testTotalPrice 0】
  202. 通知所有监听器,触发监听器回调
  203. 【widget.data:Instance of 'CartModel'】【widget.child:Builder】
  204. ShareDataWidget:【old:Instance of 'CartModel' new:Instance of 'CartModel' false】
  205. 2:实现了第二步 ChangeNotifierProvider 【testTotalPrice 20.0】
  206. CartModel中的double get totalPrice = 20.0
  207. RaisedButton build
  208. */

运行示例后效果如图所示:
跨组件状态共享(Provider) - 图1
每次点击”添加商品“按钮,总价就会增加20,我们期望的功能实现了!可能有些读者会疑惑,我们饶了一大圈实现这么简单的功能有意义么?

  • 其实,就这个例子来看,只是更新同一个路由页中的一个状态,我们使用ChangeNotifierProvider的优势并不明显,
  • 但是如果我们是做一个购物APP呢?由于购物车数据是通常是会在整个APP中共享的,比如会跨路由共享。
  • 如果我们将 ChangeNotifierProvider 放在整个应用的Widget树的根上,那么整个APP就可以共享购物车的数据了,这时ChangeNotifierProvider的优势将会非常明显。

虽然上面的例子比较简单,但它却将Provider的原理和流程体现的很清楚,下图是Provider的原理图:
跨组件状态共享(Provider) - 图2
Model变化后会自动通知ChangeNotifierProvider(订阅者),ChangeNotifierProvider内部会重新构建InheritedWidget,而依赖该InheritedWidget的子孙Widget就会更新。
我们可以发现使用Provider,将会带来如下收益:

  1. 我们的业务代码更关注数据了,只要更新Model,则UI会自动更新,而不用在状态改变后再去手动调用setState()来显式更新页面。
  2. 数据改变的消息传递被屏蔽了,我们无需手动去处理状态改变事件的发布和订阅了,这一切都被封装在Provider中了。这真的很棒,帮我们省掉了大量的工作!
  3. 在大型复杂应用中,尤其是需要全局共享的状态非常多时,使用Provider将会大大简化我们的代码逻辑,降低出错的概率,提高开发效率。

优化

我们上面实现的ChangeNotifierProvider是有两个明显缺点:

  • 代码组织问题
  • 性能问题

下面我们讨论优化

代码组织问题

我们先看一下构建显示总价Text的代码:

  1. Builder(builder: (context){
  2. var cart=ChangeNotifierProvider.of<CartModel>(context);
  3. return Text("总价: ${cart.totalPrice}");
  4. })

这段代码有两点可以优化:

  1. 需要显式调用 ChangeNotifierProvider.of,当APP内部依赖CartModel很多时,这样的代码将很冗余。
  2. 语义不明确;由于 ChangeNotifierProvider 是订阅者,那么依赖 CartModel 的Widget自然就是订阅者,其实也就是状态的消费者,如果我们用Builder 来构建,语义就不是很明确;如果我们能使用一个具有明确语义的Widget,比如就叫 Consumer,这样最终的代码语义将会很明确,只要看到 Consumer,我们就知道它是依赖某个跨组件或全局的状态。

为了优化这两个问题,我们可以封装一个Consumer Widget,实现如下:

  1. // 这是一个便捷类,会获得当前context和指定数据类型的Provider
  2. class Consumer<T> extends StatelessWidget {
  3. Consumer({
  4. Key key,
  5. @required this.builder,
  6. this.child,
  7. }) : assert(builder != null),
  8. super(key: key);
  9. final Widget child;
  10. final Widget Function(BuildContext context, T value) builder;
  11. @override
  12. Widget build(BuildContext context) {
  13. return builder(
  14. context,
  15. ChangeNotifierProvider.of<T>(context), //自动获取Model
  16. );
  17. }
  18. }

Consumer 实现非常简单,它通过指定模板参数,然后再内部自动调用 ChangeNotifierProvider.of 获取相应的Model,并且 Consumer 这个名字本身也是具有确切语义(消费者)。现在上面的代码块可以优化为如下这样:

  1. Consumer<CartModel>(
  2. builder: (cx, vm)=> Text("总价: ${cart.totalPrice}");
  3. )

是不是很优雅!

性能问题

上面的代码还有一个性能问题,就在构建”添加按钮“的代码处:

  1. Builder(builder: (context) {
  2. print("RaisedButton build"); // 构建时输出日志
  3. return RaisedButton(
  4. child: Text("添加商品"),
  5. onPressed: () {
  6. ChangeNotifierProvider.of<CartModel>(context).add(Item(20.0, 1));
  7. },
  8. );
  9. }

我们点击”添加商品“按钮后,由于购物车商品总价会变化,所以显示总价的Text更新是符合预期的,但是”添加商品“按钮本身没有变化,是不应该被重新build的!
但是我们运行示例,每次点击”添加商品“按钮,控制台都会输出”RaisedButton build”日志,也就是说”添加商品“按钮在每次点击时其自身都会重新build!这是为什么呢?如果你已经理解了InheritedWidget的更新机制,

那么答案一眼就能看出:这是因为构建RaisedButton的Builder中调用了ChangeNotifierProvider.of,也就是说依赖了Widget树上面的InheritedWidget(即InheritedProvider )Widget,所以当添加完商品后,CartModel发生变化,会通知ChangeNotifierProvider, 而ChangeNotifierProvider则会重新构建子树,所以InheritedProvider将会更新,此时依赖它的子孙Widget就会被重新构建。

问题的原因搞清楚了,那么我们如何避免这不必要重构呢?既然按钮重新被build是因为按钮和InheritedWidget建立了依赖关系,那么我们只要打破或解除这种依赖关系就可以了。那么如何解除按钮和InheritedWidget的依赖关系呢?我们上一节介绍InheritedWidget时已经讲过了:

调用inheritFromWidgetOfExactType() 和 ancestorInheritedElementForWidgetOfExactType()的区别就是前者会注册依赖关系,而后者不会。所以我们只需要将ChangeNotifierProvider.of的实现改为下面这样既可:

  1. //添加一个listen参数,表示是否建立依赖关系
  2. static T of<T>(BuildContext context, {bool listen = true}) {
  3. final type = _typeOf<InheritedProvider<T>>();
  4. final provider = listen
  5. ? context.inheritFromWidgetOfExactType(type) as InheritedProvider<T>
  6. : context.ancestorInheritedElementForWidgetOfExactType(type)?.widget
  7. as InheritedProvider<T>;
  8. return provider.data;
  9. }

然后我们将调用部分代码改为:

  1. Column(
  2. children: <Widget>[
  3. Consumer<CartModel>(
  4. builder: (BuildContext cx, vm) =>Text("总价: ${cart.totalPrice}"),
  5. ),
  6. Builder(builder: (context) {
  7. print("RaisedButton build");
  8. return RaisedButton(
  9. child: Text("添加商品"),
  10. onPressed: () {
  11. // listen 设为false,不建立依赖关系
  12. ChangeNotifierProvider.of<CartModel>(context, listen: false)
  13. .add(Item(20.0, 1));
  14. },
  15. );
  16. })
  17. ],
  18. )

修改后在此运行上面的示例,我们会发现点击”添加商品“按钮后,控制台不会再输出”RaisedButton build”了,即按钮不会被重新构建了。而总价仍然会更新,这是因为Consumer中调用ChangeNotifierProvider.of时listen值为默认值true,所以还是会建立依赖关系。
至此我们便实现了一个迷你的Provider,它具备Pub上Provider Package中的核心功能;但是我们的迷你版功能并不全面,如只实现了一个可监听的ChangeNotifierProvider,并没有实现只用于数据共享的Provider;另外,我们的实现有些边界也没有考虑的到,比如如何保证在Widget树重新build时Model始终是单例等。所以建议读者在实战中还是使用Provider Package,而本节实现这个迷你Provider的主要目的主要是为了帮助读者了解Provider Package底层的原理。

优化后的整合代码

  1. import 'package:flutter/material.dart';
  2. import 'dart:collection';
  3. void main() => runApp(new MyApp());
  4. class MyApp extends StatelessWidget {
  5. @override
  6. Widget build(BuildContext context) {
  7. return MaterialApp(
  8. debugShowCheckedModeBanner: true,
  9. title: 'WillPopScopeTestRoute',
  10. theme: ThemeData(
  11. primarySwatch: Colors.blue,
  12. ),
  13. home: Scaffold(
  14. appBar: AppBar(title: Text("跨组件状态管理(Provider)")),
  15. body: ProviderRoute(),
  16. ));
  17. }
  18. }
  19. class ProviderRoute extends StatefulWidget {
  20. @override
  21. _ProviderRouteState createState() => _ProviderRouteState();
  22. }
  23. class _ProviderRouteState extends State<ProviderRoute> {
  24. @override
  25. Widget build(BuildContext context) {
  26. return Center(
  27. child: ChangeNotifierProvider<CartModel>(
  28. data: CartModel(),
  29. child: Column(
  30. children: <Widget>[
  31. Consumer<CartModel>(builder: (cx,vm) {
  32. // var vm = ChangeNotifierProvider.of<CartModel>(context);
  33. return Text("总价: ${vm.totalPrice}");
  34. }),
  35. Builder(builder: (context) {
  36. print("__________________ RaisedButton build __________________"); //在后面优化部分会用到
  37. return RaisedButton(
  38. child: Text("添加商品"),
  39. onPressed: () {
  40. //给购物车中添加商品,添加后总价会更新
  41. print("1:点击了添加商品");
  42. ChangeNotifierProvider.of<CartModel>(context,listen: false).add(Item(20.0, 1));
  43. // vm.add(Item(20.0, 1));
  44. },
  45. );
  46. }),
  47. ],
  48. )
  49. ),
  50. );
  51. }
  52. }
  53. //------------------------------------------------------------------------------------------
  54. class Item {
  55. Item(this.price, this.count);
  56. double price; //商品单价
  57. int count; // 商品份数
  58. }
  59. //观察者,CartModel里面更新后调度 notifyListeners(),触发
  60. class CartModel extends ChangeNotifier {
  61. // 用于保存购物车中商品列表
  62. final List<Item> _items = [];
  63. // 禁止改变购物车里的商品信息
  64. UnmodifiableListView<Item> get items => UnmodifiableListView(_items);
  65. // 购物车中商品的总价
  66. double get totalPrice {
  67. double totalPrice = _items.fold(0, (value, item) {
  68. return (value + item.count * item.price);
  69. });
  70. print("CartModel中的double get totalPrice = $totalPrice");
  71. return totalPrice;
  72. }
  73. // 将 [item] 添加到购物车。这是唯一一种能从外部改变购物车的方法。
  74. void add(Item item) {
  75. _items.add(item);
  76. notifyListeners(); // 通知监听器(订阅者),重新构建InheritedProvider, 更新状态
  77. }
  78. }
  79. /*
  80. 事件中心处理观察者模式
  81. var ChangeNotifier = {list:[update() { setState(() => {}) }],
  82. addListener:(){},
  83. removeListener:(){},
  84. notifyListeners:(){}
  85. }
  86. */
  87. class ChangeNotifier implements Listenable {
  88. List<VoidCallback> list = [];
  89. @override
  90. void addListener(VoidCallback listener) {
  91. //添加监听器
  92. list.add(listener);
  93. }
  94. @override
  95. void removeListener(VoidCallback listener) {
  96. //移除监听器
  97. list = [];
  98. }
  99. void notifyListeners() {
  100. //通知所有监听器,触发监听器回调
  101. list.forEach((item) => item());
  102. print("通知所有监听器,触发监听器回调");
  103. }
  104. }
  105. //-----------------------------------------------------------------------------
  106. // 该方法用于在Dart中获取模板类型
  107. Type _typeOf<T>() => T;
  108. class ChangeNotifierProvider<T extends ChangeNotifier> extends StatefulWidget {
  109. ChangeNotifierProvider({
  110. Key key,
  111. this.data,
  112. this.child,
  113. });
  114. final Widget child;
  115. final T data;
  116. //定义一个便捷方法,方便子树中的widget获取共享数据
  117. static T of<T>(BuildContext context, {bool listen = true}) {
  118. final type = _typeOf<InheritedProvider<T>>();
  119. // final provider =
  120. // context.inheritFromWidgetOfExactType(type) as InheritedProvider<T>;
  121. final provider = listen
  122. ? context.inheritFromWidgetOfExactType(type) as InheritedProvider<T>
  123. : context.ancestorInheritedElementForWidgetOfExactType(type)?.widget
  124. as InheritedProvider<T>;
  125. // TODO 看看能不能优化
  126. var testTotalPrice = (provider.data as CartModel)
  127. ._items
  128. .fold(0, (value, item) => value + item.count * item.price);
  129. print("2:实现了第二步 ChangeNotifierProvider 【testTotalPrice $testTotalPrice】");
  130. return provider.data;
  131. }
  132. @override
  133. _ChangeNotifierProviderState<T> createState() =>
  134. _ChangeNotifierProviderState<T>();
  135. }
  136. class _ChangeNotifierProviderState<T extends ChangeNotifier>
  137. extends State<ChangeNotifierProvider<T>> {
  138. void update() {
  139. //如果数据发生变化(model类调用了 notifyListeners ),重新构建InheritedProvider
  140. setState(() => {});
  141. }
  142. @override
  143. void didUpdateWidget(ChangeNotifierProvider<T> oldWidget) {
  144. //当Provider更新时,如果新旧数据不"==",则解绑旧数据监听,同时添加新数据监听
  145. if (widget.data != oldWidget.data) {
  146. oldWidget.data.removeListener(update);
  147. widget.data.addListener(update);
  148. }
  149. super.didUpdateWidget(oldWidget);
  150. }
  151. @override
  152. void initState() {
  153. // 给model添加监听器
  154. widget.data.addListener(update);
  155. super.initState();
  156. }
  157. @override
  158. void dispose() {
  159. // 移除model的监听器
  160. widget.data.removeListener(update);
  161. super.dispose();
  162. }
  163. @override
  164. Widget build(BuildContext context) {
  165. // Future.delayed(Duration(milliseconds: 0), () {
  166. // setState(() {});
  167. // });
  168. print("【widget.data:${widget.data}】【widget.child:${widget.child}】");
  169. return InheritedProvider<T>(
  170. //调用ChangeNotifierProvider<T>传进来的CartModel,在这里是Instance of 'CartModel'
  171. data: widget.data,
  172. child: widget.child,
  173. );
  174. }
  175. }
  176. /*
  177. InheritedProvider, 保存任需要跨组件共享的状态,格式类型如下
  178. var InheritedProvider = {data:{CartModel:{
  179. _items:[],
  180. add:(){ _items.add(item); notifyListeners();}
  181. totalPrice:(){return <totalPrice>;}}}}
  182. */
  183. class InheritedProvider<T> extends InheritedWidget {
  184. InheritedProvider({@required this.data, Widget child}) : super(child: child);
  185. //共享状态使用泛型,用来存储传进来的widget
  186. final T data;
  187. @override
  188. bool updateShouldNotify(InheritedProvider<T> old) {
  189. print(
  190. "ShareDataWidget:【old:${old.data.toString()} new:$data ${old.data != data}】");
  191. //在此简单返回true,则每次更新都会调用依赖其的子孙节点的`didChangeDependencies`。
  192. return true;
  193. }
  194. }
  195. //——————————————————————————————————————————————————————————————————————————————————————————————————-
  196. // 这是一个便捷类,会获得当前context和指定数据类型的Provider
  197. class Consumer<T> extends StatelessWidget {
  198. Consumer({
  199. Key key,
  200. @required this.builder,
  201. this.child,
  202. }) : assert(builder != null),
  203. super(key: key);
  204. final Widget child;
  205. final Widget Function(BuildContext context, T value) builder;
  206. @override
  207. Widget build(BuildContext context) {
  208. return builder(
  209. context,
  210. ChangeNotifierProvider.of<T>(context), //自动获取Model
  211. );
  212. }
  213. }
  214. //——————————————————————————————————————————————————————————————————————————————————————————————————-
  215. // ChangeNotifierProvider -> InheritedProvider -> CartModel -> ChangeNotifier -> Listenable
  216. // ChangeNotifierProvider对象的data = CartModel,然后在 build 里面返回 InheritedProvider对象(把CartModel传给InheritedProvider)
  217. // CartModel 继承 ChangeNotifier,可以调用 ChangeNotifier 的方法
  218. // 每次调用 ChangeNotifierProvider.of<CartModel>(context) 就会触发 ChangeNotifier 中的 notifyListeners,
  219. // notifyListeners 中的 list.forEach((item) => item())会把存在的方法执行;
  220. //——————————————————————————————————————————————————————————————————————————————————————————————————-
  221. /*
  222. 1:点击了添加商品
  223. 2:实现了第二步 ChangeNotifierProvider 【testTotalPrice 0】
  224. 通知所有监听器,触发监听器回调
  225. 【widget.data:Instance of 'CartModel'】【widget.child:Builder】
  226. ShareDataWidget:【old:Instance of 'CartModel' new:Instance of 'CartModel' false】
  227. 2:实现了第二步 ChangeNotifierProvider 【testTotalPrice 20.0】
  228. CartModel中的double get totalPrice = 20.0
  229. RaisedButton build
  230. */

其它状态管理包

现在Flutter社区已经有很多专门用于状态管理的包了,在此我们列出几个相对评分比较高的:

包名 介绍
Provider & Scoped Model 这两个包都是基于 InheritedWidget 的,原理相似
Redux 是Web开发中React生态链中Redux包的Flutter实现
MobX 是Web开发中React生态链中MobX包的Flutter实现
BLoC 是BLoC模式的Flutter实现

在此笔者不对这些包做推荐,读者有兴趣都可以研究一下,了解它们各自的思想

总结

本节通过介绍事件总线在跨组件共享中的一些缺点引出了通过InheritedWidget来实现状态的共享的思想,然后基于该思想实现了一个简单的Provider,在实现的过程中也更深入的探索了InheritedWidget与其依赖项的注册机制和更新机制。通过本节的学习,读者应该达到两个目标,首先是对InheritedWidget彻底吃透,其次是Provider的设计思想。
InheritedWidget是Flutter中非常重要的一个Widget,像国际化、主题等都是通过它来实现,所以我们也不惜篇幅,通过好几节来介绍它的,在下一节中,我们将介绍另一个基于InheritedWidget的组件Theme(主题)。