Flutter 组件集录 | SharedAppData 应用数据共享

上一篇《Flutter 组件集录 | InheritedModel 共享模型》介绍了 InheritedModel 通过定义 Aspect(方面) 来更精细地控制依赖更新的粒度。本文看一下基于 InheritedModel 实现的 SharedAppData 组件，如何实现应用级数据的共享。

本组件案例已收录到 FlutterUnit：源码可详见【InheritedModel/node1.dart】

1.认识 SharedAppData 组件

SharedAppData 是新增的组件，其价值是提供键值对的映射关系 ，让子树节点可以访问数据。和 MediaQuery 、Theme、Navigator 组件类似，SharedAppData 组件也是内置在 WidgetsApp 状态类构建逻辑之中的。

也就是说，当使用 MaterialApp 时，组件树种会提供默认的 SharedAppData 组件，我们一般并不需要主动创建它:

2. 使用 SharedAppData 组件

还是拿这个例子说明共享颜色和数值的场景。SharedAppData 的使用包括：

$1\]. 如何访问读取数据。$

SharedAppData 提供了 getValue 静态方法，可以让使用者通过上下文和键访问数据；如果键的值不存在，在回调中将返回初始值：

dart 复制代码

@override
Widget build(BuildContext context) {
  final Color color = SharedAppData.getValue<String, Color>(context, 'color', () => Colors.black);
  final int counter = SharedAppData.getValue<String, int>(context, 'counter', () => 0);
  return Text(
    "Counter = $counter",
    style: TextStyle(color: color,fontWeight: FontWeight.bold),
  );
}

SharedAppData 提供了 setValue 静态方法，可以让使用者通过上下文和键设置数据。在设置值时，通过该键读取过值的 context，将会被通知更新 (无需 setState) 。

dart 复制代码

void _onSelectColor(Color value) {
  SharedAppData.setValue<String, Color?>(context, 'color', value);
}

SharedAppData 的底层基于 InheritedModel 实现的，它将 key 视为方面，所以也具有精确控制粒度的能力。比如仅修改数字时，没有依赖数字 key 的 BoxDecorationWrap，其对应的元素将不会被通知更新。

diff 复制代码

---->[修改颜色时]----
flutter: ======BoxDecorationWrap#didChangeDependencies=========
flutter: ======CounterText#didChangeDependencies=========

---->[修改数字时]----
flutter: ======CounterText#didChangeDependencies=========

这就是 SharedAppData 所有的功能，它的目的很明确，就是：

向子树共享键值对数据，在更新数据时，通知所有依赖过 key 访问数据的 context 元素更新。

源码中对 SharedAppData 的介绍在表示: 它并不是替代 Provider 或任何其他状态管理系统的方案。一般会通过 SharedAppData 共享 package 内的，一个或几个可以惰性初始化的不可变数据对象。

4. SharedAppData 的源码实现

SharedAppData 是一个 StatefulWidget，其中定义了 setValue 和 getValue 两个静态方法；通过 _SharedAppDataState 状态类处理组件的构建任务。

_SharedAppDataState 中维护一个映射 data 对象，用于存储键值对，构建逻辑中返回 _SharedAppModel 组件:

dart 复制代码

class _SharedAppDataState extends State<SharedAppData> {
  late Map<Object, Object?> data = <Object, Object?>{};

  @override
  Widget build(BuildContext context) {
    return _SharedAppModel(sharedAppDataState: this, child: widget.child);
  }

  V getValue<K extends Object, V>(K key, SharedAppDataInitCallback<V> init) {
    data[key] ??= init();
    return data[key] as V;
  }

  void setValue<K extends Object, V>(K key, V value) {
    if (data[key] != value) {
      setState(() {
        data = Map<Object, Object?>.of(data);
        data[key] = value;
      });
    }
  }
}

_SharedAppModel 组件就是 InheritedModel 的派生类，负责存储数据，通过上下文向子树共享数据。在 updateShouldNotifyDependent 回调方法的处理中可以看出，数据的 key 被视为数据的 Aspect。只有依赖者使用到相关的 key, 当 key 对应数据发生变化时，才会通知该依赖者。

dart 复制代码

class _SharedAppModel extends InheritedModel<Object> {
  _SharedAppModel({
    required this.sharedAppDataState,
    required super.child
  }) : data = sharedAppDataState.data;

  final _SharedAppDataState sharedAppDataState;
  final Map<Object, Object?> data;

  @override
  bool updateShouldNotify(_SharedAppModel old) {
    return data != old.data;
  }

  @override
  bool updateShouldNotifyDependent(_SharedAppModel old, Set<Object> keys) {
    for (final Object key in keys) {
      if (data[key] != old.data[key]) {
        return true;
      }
    }
    return false;
  }
}

这就是 SharedAppData 的所有源码内容，总的来看它的作用非常明确，向子树共享键值对数据。由于 MaterialApp 已经内置 SharedAppData，所以在应用中直接通过静态方法存取数据即可。那本文就到这里，谢谢观看 ~