利用 InheritedWidget 来实现 Flutter 状态共享

背景

Flutter 常用的状态管理框架 Bloc、 Provider,Bloc 架构中使用了 Provide,而 Provider 是基于 InheritedWidget 组件的。所以本节我们通过自实现 InheritedWidget 来了解 Provider 的原理。

setState

当不依赖状态管理框架时,更新组件状态的方法就是 setState(fn),调用该方法后,会重新调用 StatefulWidget 的 build 方法重新构建组件,达到刷新界面的效果。

InheritedWidget

  • 简介
    InheritedWidget 是 Flutter 中非常重要的一个功能型组件,它提供了一种在 widget 树中从上到下共享数据的方式,比如我们在应用的根 widget 中通过InheritedWidget共享了一个数据,那么我们便可以在任意子widget 中来获取该共享的数据!
class CountInheritedWidget extends InheritedWidget {
   CountInheritedWidget({
    Key? key,
    required this.data,
    required Widget child,
  }) : super(key: key, child: child);

  final CountModel data; // 需要在子树中共享的数据,保存点击次数

 //定义一个便捷方法,方便子树中的widget获取共享数据
  static CountInheritedWidget? of(BuildContext context) {
    return context.dependOnInheritedWidgetOfExactType<CountInheritedWidget>();
  }

  //该回调决定当data发生变化时,是否通知子树中依赖data的Widget重新build
  @override
  bool updateShouldNotify(CountInheritedWidget old) {
    return old.data != data;
  }
}
class ChildText extends StatefulWidget {
  @override
  State<ChildText> createState() => _ChildTextState();
}

class _ChildTextState extends State<ChildText> {
  @override
  Widget build(BuildContext context) {
    return Text(
      CountInheritedWidget.of(context)?.data.count.toString() ?? '',
    );
  }

  @override 
  void didChangeDependencies() {
    super.didChangeDependencies();
    //父或祖先widget中的InheritedWidget改变(updateShouldNotify返回true)时会被调用。
    //如果build中没有依赖InheritedWidget,则此回调不会被调用。
    print("ChildText Dependencies change");
  }
}
  • didChangeDependencies
    State对象有一个 didChangeDependencies 回调,它会在“依赖”发生变化时被 Flutter 框架调用。而这个“依赖”指的就是子 widget 是否使用了父 widget 中 InheritedWidget 的数据!如果使用了,则代表子 widget 有依赖;如果没有使用则代表没有依赖。这种机制可以使子组件在所依赖的InheritedWidget 变化时来更新自身!

建立依赖:dependOnInheritedWidgetOfExactType()->dependOnInheritedElement()->
InheritedElement.updateDependencies()->_dependents[dependent] = value;(往依赖表里添加依赖的子组件)
通知依赖更新:
InheritedElement.update->ProxyElement.notifyClients->InheritedElement.notifyClients(遍历_dependents更新依赖)-InheritedElement.notifyDependent>dependent.didChangeDependencies();

  • 通知数据发生变化
    为了更贴近 Flutter 开发,我们使用Flutter SDK中提供的ChangeNotifier 类 ,它实现了一个 Flutter 风格的发布者-订阅者模式。我们将要共享的状态放到一个 Model 类中,然后让它继承自 ChangeNotifier,这样当共享的状态改变时,我们只需要调用 notifyListeners() 来通知订阅者,然后由订阅者来重新构建 InheritedWidget,而依赖该InheritedWidget 的子孙 Widget 就会更新。
class CountModel extends ChangeNotifier {
  int count = 0;
  void add() {
    count++;
    notifyListeners();
  }
}
class _ChangeCountProviderState extends State<ChangeCountProvider> {
  void update() {
    setState(() {});
  }

  @override
  void initState() {
    // 给data添加监听器
    widget.data.addListener(update);
    super.initState();
  }

  @override
  void dispose() {
    // 移除data的监听器
    widget.data.removeListener(update);
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return CountInheritedWidget(
      data: widget.data,
      child: widget.child,
    );
  }
}
  • 优化
    如果我们只想在子组件中引用 CountInheritedWidget 中共享的数据,但却不希望在 CountInheritedWidget 发生变化时调用子组件的 didChangeDependencies 方法重新构建子组件怎么办?因为子组件和 CountInheritedWidget 建立了依赖关系,当 CountInheritedWidget 更新时,依赖它的子组件也会更新,所以只要我们解除这种依赖关系就可以了。通过 getElementForInheritedWidgetOfExactType 方法即可。dependOnInheritedWidgetOfExactType 和 getElementForInheritedWidgetOfExactType 的区别就是前者会注册依赖关系,而后者不会。
  //添加一个listen参数,表示是否建立依赖关系
   static CountModel? of(BuildContext context, {bool listen = true}) {
  final provider = listen
       ? context.dependOnInheritedWidgetOfExactType<CountInheritedWidget>()
       : context.getElementForInheritedWidgetOfExactType<CountInheritedWidget>()?.widget as CountInheritedWidget;
     return provider?.data;
  }

至此我们计数器版的状态管理器就实现了,它具备 Provider Package 中的核心功能,但是这个 demo 的功能并不全面,实现这个迷你 Provider 的主要目的是为了帮助大家了解 Provider Package 底层的原理,所以在实战中还是使用 Provider Package。

Provider

class _ProviderCountViewState extends State<ProviderCountView> {
  @override
  Widget build(BuildContext context) {
    return ChangeNotifierProvider(
      create: (ctx) => _CountChangeNotifier(),
      child: Scaffold(
        appBar: AppBar(
          backgroundColor: Theme.of(context).colorScheme.inversePrimary,
          title: const Text('Provider'),
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              Consumer<_CountChangeNotifier>(builder: (ctx, value, child) {
                return Text(
                  "${value.count}",
                  style: const TextStyle(
                      fontWeight: FontWeight.w500, fontSize: 20),
                );
              }),
              ChildHint(),
              Padding(
                padding: const EdgeInsets.only(top: 50),
                child: Builder(builder: (ctx) {
                  return FloatingActionButton(
                    onPressed: () {
                      var model = ctx.read<_CountChangeNotifier>();
                      model.add();
                    },
                    child: const Icon(Icons.add),
                  );
                }),
              )
            ],
          ),
        ),
      ),
    );
  }
}

class _CountChangeNotifier extends ChangeNotifier {
  int count = 0;

  void add() {
    count++;
    notifyListeners();
  }
}

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,711评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,079评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,194评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,089评论 1 286
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,197评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,306评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,338评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,119评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,541评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,846评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,014评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,694评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,322评论 3 318
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,026评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,257评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,863评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,895评论 2 351

推荐阅读更多精彩内容