在Flutter开发中,状态管理是一个永恒的话题。
一般的原则:
- 如果状态是组件私有的,应该由组件自己管理
- 如果状态要跨组件共享,则该状态由各个组件共同的父元素来管理
对于组件私有的状态管理很好理解,但是对于跨组件共享的状态,管理的方式就比较多了,如果用全局事件总线EventBus,它是一个观察者模式的实现,通过它就可以实现跨组件状态同步:状态持有方(发布者)负责更新、发布状态,状态使用方(观察者)监听状态改变事件来执行一些操作。
下面我们看一个登陆状态同步的简单例子:
定义事件:
enum Event{
login,
... //省略其它事件
}
登陆页代码大致如下:
// 登录状态改变后发布状态改变事件
bus.emit(Event.login);
依赖登录状态的页面:
void onLoginChanged(e){
//登录状态变化处理逻辑
}
@override
void initState() {
//订阅登录状态改变事件
bus.on(Event.login,onLogin);
super.initState();
}
@override
void dispose() {
//取消订阅
bus.off(Event.login,onLogin);
super.dispose();
}
我们可以发现,通过观察者模式来实现跨组件状态共享有一些明显的缺点:
- 必须显示定义各种事件,不好管理
- 订阅者必须显示注册状态改变回调,也必须在组件销毁时手动去解绑回调避免内存泄漏。
Flutter中还有更好的跨组件状态管理方式,想想前面的InheritedWidget,它的天生特性就是能绑定InheritedWidget与依赖它的子孙组件的依赖关系,并且当InheritedWidget数据发生变化时,可以自动更新依赖的子孙组件。
利用这个特性,我们可以将需要跨组件共享的状态保存在InheritedWidget中,然后在子组件中引用InheritedWidget即可,Flutter社区著名的Provider包正是基于这个思想实现的一套跨组件状态共享解决方案。
Provider
我们通过InheritedWidget实现的思路来一步步的实现一个最小功能的Provider。
首先,我们需要一个保存需要共享的数据InheritedWidget,由于具体业务数据不可预期,为了通用性,我们使用泛型,定义一个通用的Inheritedprovider类,它继承自InheritedWidget:
// 一个通用的InheritedWidget,保存任需要跨组件共享的状态
class InheritedProvider<T> extends InheritedWidget {
InheritedProvider({@required this.data, Widget child}) : super(child: child);
//共享状态使用泛型
final T data;
@override
bool updateShouldNotify(InheritedProvider<T> old) {
//在此简单返回true,则每次更新都会调用依赖其的子孙节点的`didChangeDependencies`。
return true;
}
}
数据保存的地方就有了,那么接下来我们需要做的就是在数据发生变化的时候来重新构建InheritedProvider,那么现在就有两个问题了:
- 数据发生变化怎么通知?
- 谁来重新构建InheritedProvider?
第一个问题其实很好解决,我们可以使用eventBus来进行事件通知,但是为了更贴近Flutter开发,我们使用 ChangeNotifier类,它继承自 Listenable,也实现了一个Flutter风格的发布者-订阅者模式,ChangeNotifier定义大致如下:
class ChangeNotifier implements Listenable {
@override
void addListener(VoidCallback listener) {
//添加监听器
}
@override
void removeListener(VoidCallback listener) {
//移除监听器
}
void notifyListeners() {
//通知所有监听器,触发监听器回调
}
... //省略无关代码
}
我们可以通过调用addListener()和removeListener()来添加、移除监听器(订阅者);通过调用notifyListeners()可以触发所有监听器回调。
现在,我们将要共享的状态放到一个Model类中,然后让它继承自ChangeNotifier,这样当共享的状态改变时,我们只需要调用notifyListeners()来通知订阅者,然后由订阅者来重新构建InheritedProvider,这也是第二个问题的答案。
接下来我们便实现这个订阅者类:
// 该方法用于在Dart中获取模板类型
Type _typeOf<T>() => T;
class ChangeNotifierProvider<T extends ChangeNotifier> extends StatefulWidget {
ChangeNotifierProvider({
Key key,
this.data,
this.child,
});
final Widget child;
final T data;
//定义一个便捷方法,方便子树中的widget获取共享数据
static T of<T>(BuildContext context) {
final type = _typeOf<InheritedProvider<T>>();
final provider = context.inheritFromWidgetOfExactType(type) as InheritedProvider<T>;
return provider.data;
}
@override
_ChangeNotifierProviderState<T> createState() => _ChangeNotifierProviderState<T>();
}
该类继承StatefulWidget,然后定义了一个of()静态方法供子类方便获取Widget树中的InheritedProvider中保存的共享状态model,下面我们实现该类对应的_ChangenotifierProviderState类:
class _ChangeNotifierProviderState<T extends ChangeNotifier> extends State<ChangeNotifierProvider<T>> {
void update() {
//如果数据发生变化(model类调用了notifyListeners),重新构建InheritedProvider
setState(() => {});
}
@override
void didUpdateWidget(ChangeNotifierProvider<T> oldWidget) {
//当Provider更新时,如果新旧数据不"==",则解绑旧数据监听,同时添加新数据监听
if (widget.data != oldWidget.data) {
oldWidget.data.removeListener(update);
widget.data.addListener(update);
}
super.didUpdateWidget(oldWidget);
}
@override
void initState() {
// 给model添加监听器
widget.data.addListener(update);
super.initState();
}
@override
void dispose() {
// 移除model的监听器
widget.data.removeListener(update);
super.dispose();
}
@override
Widget build(BuildContext context) {
return InheritedProvider<T>(
data: widget.data,
child: widget.child,
);
}
}
可以看到_ChangeNotifierProviderState类的主要作用就是监听到共享状态(model)改变时重新构建Widget树,此时会更新InheritedProvider的data数据,然后由于InheritedProvider继承自InheritedWidget,所以所有依赖InheritedProvider的data数据的子widget都会调用didUpdateDependence方法,然后调用build方法,达到状态共享的作用。
注意:在_ChangeNotifierProviderState类中调用 setState() 方法,widget.child 始终是同一个,所以执行build时,InheritedProvider的child引用的始终是同一个子widget,所以widget.child并不会重新build,这也就相当于对child进行了缓存。当然如果ChangeNotifierProvider父级Widget重新build时,则其传入的child便有可能会发生变化。
下面,我们通过一个购物车的例子,来使用一下:
我们需要实现一个显示购物车中所有商品总价的功能:
- 向购物车中添加新商品时总价更新
定义一个Item类,用于表示商品信息:
class Item {
Item(this.price, this.count);
double price; //商品单价
int count; // 商品份数
//... 省略其它属性
}
定义一个保存购物车内商品数据的CartModel类:
class CartModel extends ChangeNotifier {
// 用于保存购物车中商品列表
final List<Item> _items = [];
// 禁止改变购物车里的商品信息
UnmodifiableListView<Item> get items => UnmodifiableListView(_items);
// 购物车中商品的总价
double get totalPrice =>
_items.fold(0, (value, item) => value + item.count * item.price);
// 将 [item] 添加到购物车。这是唯一一种能从外部改变购物车的方法。
void add(Item item) {
_items.add(item);
// 通知监听器(订阅者),重新构建InheritedProvider, 更新状态。
notifyListeners();
}
}
CartModel即要跨组件共享的model类。最后我们构建示例页面:
class ProviderRoute extends StatefulWidget {
@override
_ProviderRouteState createState() => _ProviderRouteState();
}
class _ProviderRouteState extends State<ProviderRoute> {
@override
Widget build(BuildContext context) {
return Center(
child: ChangeNotifierProvider<CartModel>(
data: CartModel(),
child: Builder(builder: (context) {
return Column(
children: <Widget>[
Builder(builder: (context){
var cart=ChangeNotifierProvider.of<CartModel>(context);
return Text("总价: ${cart.totalPrice}");
}),
Builder(builder: (context){
print("RaisedButton build"); //在后面优化部分会用到
return RaisedButton(
child: Text("添加商品"),
onPressed: () {
//给购物车中添加商品,添加后总价会更新
ChangeNotifierProvider.of<CartModel>(context).add(Item(20.0, 1));
},
);
}),
],
);
}),
),
);
}
}
运行后效果如图:
每次点击“添加商品”按钮,总价就会增加20,我们期望的功能实现了。
对于实现这个功能来说,使用ChangeNotifierProvider的优势并不明显,但是如果做一个购物APP呢?由于购物车数据是通常会在整个APP中共享的,比如会跨路由共享。如果我们将ChangeNotifierProvider放在整个应用的Widget树的根上,那么整个APP就可以共享购物车的数据了,这时ChangeNotifierProvider的优势将会很明显。
虽然上面的例子比较简单,但是却清楚的展现了Provider的原理和流程:
从上图我们可以看到 状态改变 和 更新UI 是链接这三个组件的部分,而这状态改变是通过ChangeNotifier实现的,更新UI就是通过InheritedWidget的特性实现的。
Model变化后会自动通知(调用notifyListeners()方法)通知ChangeNotifierProvider(订阅者),ChangeNotifierProvider内部会重新构建 InheritedWidget,而依赖该 InheritedWidget的子孙Widget就会更新。
我们可以发现使用Provider,将会带来如下收益:
- 我们的业务代码更关注数据了,只要更新Model,则UI会自动更新,而不用再状态改变后再去手动调用setState() 来显式更新页面
- 数据改变的消息传递被屏蔽了,我们无需手动去处理状态改变事件的发布和订阅了,这一切都被风状态Provider中了。
- 在大型复杂应用中,尤其是需要全局共享的状态非常多时,使用Provider将会大大简化我们的代码逻辑,降低出错的概率,提高开发效率。
优化
我们上面实现的ChangeNotifierProvider有两个明显的缺点:
- 代码组织问题
- 性能问题
代码组织问题
我们先看一下构建显示总价Text的代码:
Builder(builder: (context){
var cart=ChangeNotifierProvider.of<CartModel>(context);
return Text("总价: ${cart.totalPrice}");
})
这段代码有两点可以优化:
- 需要显示调用ChangeNotifierProvider.of,当APP内部依赖CartModel很多时,这样的代码很冗余
- 语义不明确;由于ChangeNotifierProvider是订阅者,那么依赖CartModel的Widget自然就是订阅者,也就是状态的消费者,如果我们用Builder来构建,语义就不是很明确,如果我们能使用一个具有明确语义的Widget,比如就叫Consumer,这样的最终代码语义就会很明确,只要看到Consumer,我们就知道它是依赖某个跨组件或全局的状态。
为了优化这两个问题,我们可以封装一个Consumer Widget,实现如下:
class Consumer<T> extends StatelessWidget {
Consumer({
Key key,
@required this.builder,
this.child
}): assert(builder != null),
super(key:key);
final Widget child;
final Widget Function(BuildContext context, T value) builder;
@override
Widget build(BuildContext context) {
return builder(
context,
ChangeNotifierProvider.of<T>(context), // 自动获取model
);
}
}
Consumer实现很简单,它通过指定模板参数,然后再内部自动调用ChangeNotifierProvider.of 获取相应的Model,并且Consumer这个名字也是具有确切的语义(消费者)。现在上面的代码块可以优化为如下这样:
Consumer<CartModel>(
builder: (context, cart)=> Text("总价: ${cart.totalPrice}");
)
性能问题
上面的代码还有一个性能问题,就是在构建“添加按钮”的代码处:
Builder(builder: (context) {
print("RaisedButton build"); // 构建时输出日志
return RaisedButton(
child: Text("添加商品"),
onPressed: () {
ChangeNotifierProvider.of<CartModel>(context).add(Item(20.0, 1));
},
);
}
我们点击“添加商品”按钮后,由于购物车商品总价会变化,所以显示总价的Test更新时符合预期的,但是“添加商品”按钮本身是没有变化,不应该被重新build的。
但是我们运行示例,每次点击“添加商品”按钮,控制台都会输出RaisedButton build 日止,也就是说“添加商品”按钮在每次点击时其自身都会重新build。这是为什么呢?
如果你已经理解了InheritedWIdget的更新机制,那么你会很明白:
因为构建RaisedButton 的 Builder 中调用了 ChangeNotifierprovider.of,也就是说依赖了Widget树上面的InheritedWidget(即InheritedProvider)Widget,所以添加完商品后,CartModel发生变化,会通知ChangeNotifierProvider,而ChangeNotifierProvider则会重新构建子树,所以InheritedProvider将会更新,此时依赖它的子孙Widget就会被重新构建。
问题很清楚了,那么我们如何避免这种不必要的build?
既然按钮重新被build是因为按钮和InheritedWidget建立了依赖关系,那么我们只需要打破或解除这种依赖关系就可以了。
如何解除按钮和InheritedWidget的依赖关系呢?
我们知道调用inheritFromWidgetOfExactType() 和 ancestorInheritedElementForWidgetOfExactType()的区别就是前者会注册依赖关系,而后者不会,所以我们只需要将ChangeNotifierprovider.of 的实现改为下面这样就行:
//添加一个listen参数,表示是否建立依赖关系
static T of<T>(BuildContext context, {bool listen = true}) {
final type = _typeOf<InheritedProvider<T>>();
final provider = listen
? context.inheritFromWidgetOfExactType(type) as InheritedProvider<T>
: context.ancestorInheritedElementForWidgetOfExactType(type)?.widget
as InheritedProvider<T>;
return provider.data;
}
然后我们将调用部分代码改为:
Column(
children: <Widget>[
Consumer<CartModel>(
builder: (BuildContext context, cart) =>Text("总价: ${cart.totalPrice}"),
),
Builder(builder: (context) {
print("RaisedButton build");
return RaisedButton(
child: Text("添加商品"),
onPressed: () {
// listen 设为false,不建立依赖关系
ChangeNotifierProvider.of<CartModel>(context, listen: false)
.add(Item(20.0, 1));
},
);
})
],
)
修改后再次运行,我们会发现点击“添加商品”按钮后,控制台不会再输出“RaisedButton build”,即按钮不会被重新构建了。而总价仍然会更新,这是因为Consumer中调用ChangeNotifierProvider.of时listen值为默认值true,所以还是会建立依赖关系。
至此我们便实现了一个迷你的Provider,它具备Pub上Provider Package中的核心功能;但是我们的迷你版功能并不全面,如只实现了一个可监听的ChangeNotifierProvider,并没有实现只用于数据共享的Provider;另外,我们的实现有些边界也没有考虑的到,比如如何保证在Widget树重新build时Model始终是单例等。实现这个迷你Provider的主要目的主要是为了帮助了解Provider Package底层的原理,可以自己去看下provider的源码。
其他状态管理包
- Provider & Scoped Model
这两个包都是基于InheritedWidget的,原理相似 -
Redux
是Web开发中React生态链中Redux包的Flutter实现 -
MobX
是Web开发中React生态链中MobX包的Flutter实现 -
BLoC
是BLoC模式的Flutter实现
实现思想很重要。
总结:
通过介绍事件总线在跨组件共享中的一些缺点引出了通过使用InheritedWidget来实现状态共享的思想,然后基于该思想实现了一个简单的Provider,在实现的过程中也深入探索了InheritedWidget与其依赖项的注册机制和更新机制。
InheritedWidget是Flutter中非常重要的一个Widget,像国际化、主题等都是通过它来实现,所以要搞懂它。