Flutter 中Widget 多种多样,有UI的,固然也有功能型的组件InheritedWidget 组件就是Flutter 中的一个功能组件,它能够实现Flutter 组件之间的数据共享,他的数据传递方向在Widget树传递是从上到下的。android
/// Created with Android Studio. /// User: maoqitian /// Date: 2019/11/15 0015 /// email: maoqitian068@163.com /// des: InheritedWidget是Flutter中很是重要的一个功能型组件,它提供了一种数据在widget树中从上到下传递、共享的方式 import 'package:flutter/material.dart'; class ShareDataWidget extends InheritedWidget { final int data; //须要在子树中共享的数据,保存点击次数 ShareDataWidget( {@required this.data,Widget child}) :super(child:child); // 子树中的widget经过该方法获取ShareDataWidget,从而获取共享数据 static ShareDataWidget of(BuildContext context){ return context.inheritFromWidgetOfExactType(ShareDataWidget); } //继承 InheritedWidget 实现的方法 返回值 决定当data发生变化时,是否通知子树中依赖data的Widget 更新数据 @override bool updateShouldNotify(ShareDataWidget oldWidget) { //若是返回true,则子树中依赖(build函数中有调用)本widget的子widget的`state.didChangeDependencies`会被调用 return oldWidget.data != data; } } 复制代码
/// Created with Android Studio. /// User: maoqitian /// Date: 2019/11/15 0015 /// email: maoqitian068@163.com /// des: 测试 ShareDataWidget import 'package:flutter/material.dart'; import 'package:flutter_hellow_world/InheritedWidget/ShareDataWidget.dart'; class TestShareDataWidget extends StatefulWidget { @override _TestShareDataWidgetState createState() => _TestShareDataWidgetState(); } class _TestShareDataWidgetState extends State<TestShareDataWidget> { @override void didChangeDependencies() { super.didChangeDependencies(); //上层 widget中的InheritedWidget改变(updateShouldNotify返回true)时会被调用。 //若是build中没有依赖InheritedWidget,则此回调不会被调用。 print("didChangeDependencies"); } @override Widget build(BuildContext context) { //显示 ShareDataWidget 数据变化,若是build中没有依赖InheritedWidget,则此回调不会被调用。 return Text(ShareDataWidget.of(context).data.toString()); } } 复制代码
/// Created with Android Studio. /// User: maoqitian /// Date: 2019/11/15 0015 /// email: maoqitian068@163.com /// des: 建立一个按钮,每点击一次,就将ShareDataWidget的值自增 import 'package:flutter/material.dart'; import 'package:flutter_hellow_world/InheritedWidget/ShareDataWidget.dart'; import 'package:flutter_hellow_world/InheritedWidget/TestShareDataWidget.dart'; class InheritedWidgetTest extends StatefulWidget { @override _InheritedWidgetTestState createState() => _InheritedWidgetTestState(); } class _InheritedWidgetTestState extends State<InheritedWidgetTest> { int count = 0; @override Widget build(BuildContext context) { return Center( child: ShareDataWidget( data: count, //共享数据 data child: Column( mainAxisAlignment: MainAxisAlignment.center, children: <Widget>[ Padding( padding: const EdgeInsets.only(bottom: 20.0), child: TestShareDataWidget()//子widget中依赖ShareDataWidget ), RaisedButton( child: Text("计数增长"), onPressed: (){ setState(() { ++ count; }); }, ) ], ), ), ); } } 复制代码
代码很简单,建立一个按钮,每点击一次,就将ShareDataWidget的data值加一,而前面建立的TestShareDataWidget中依赖了ShareDataWidget的data值,若是数据共享则它的值就会跟随变化。git
运行效果github
I/flutter ( 7082): didChangeDependencies
复制代码
// 子树中的widget获取共享数据 方法 static ShareDataWidget of(BuildContext context){ //return context.inheritFromWidgetOfExactType(ShareDataWidget); //使用 ancestorInheritedElementForWidgetOfExactType 方法当数据变化则不会调用 子widget 的didChangeDependencies 方法 return context.ancestorInheritedElementForWidgetOfExactType(ShareDataWidget).widget; } 复制代码
/** * framework.dart inheritFromWidgetOfExactType和ancestorInheritedElementForWidgetOfExactType方法源码 */ @override InheritedWidget inheritFromWidgetOfExactType(Type targetType, { Object aspect }) { assert(_debugCheckStateIsActiveForAncestorLookup()); final InheritedElement ancestor = _inheritedWidgets == null ? null : _inheritedWidgets[targetType]; if (ancestor != null) { assert(ancestor is InheritedElement); return inheritFromElement(ancestor, aspect: aspect); } _hadUnsatisfiedDependencies = true; return null; } @override InheritedElement ancestorInheritedElementForWidgetOfExactType(Type targetType) { assert(_debugCheckStateIsActiveForAncestorLookup()); final InheritedElement ancestor = _inheritedWidgets == null ? null : _inheritedWidgets[targetType]; return ancestor; } 复制代码
/** * framework.dart inheritFromElement方法源码 */ @override InheritedWidget inheritFromElement(InheritedElement ancestor, { Object aspect }) { assert(ancestor != null); _dependencies ??= HashSet<InheritedElement>(); _dependencies.add(ancestor); ancestor.updateDependencies(this, aspect); return ancestor.widget; } 复制代码
/// Created with Android Studio. /// User: maoqitian /// Date: 2019-11-17 /// email: maoqitian068@163.com /// des: 实现InheritedWidget 保存须要共享的数据InheritedWidget import 'package:flutter/material.dart'; class InheritedProvider<T> extends InheritedWidget{ //共享数据 外部传入 final T data; InheritedProvider({@required this.data, Widget child}):super(child:child); @override bool updateShouldNotify(InheritedProvider<T> oldWidget) { ///返回true,则每次更新都会调用依赖其的子孙节点的`didChangeDependencies`方法。 return true; } } 复制代码
/// Created with Android Studio. /// User: maoqitian /// Date: 2019-11-17 /// email: maoqitian068@163.com /// des: 订阅者 import 'package:flutter/material.dart'; import 'package:flutter_theme_change/provider/InheritedProvider.dart'; // 该方法用于在Dart中获取模板类型 Type _typeOf<T>(){ return T; } class ChangeNotifierProvider<T extends ChangeNotifier> extends StatefulWidget{ final Widget child; final T data; ChangeNotifierProvider({Key key,this.child,this.data}); //方便子树中的widget获取共享数据 static T of<T> (BuildContext context,{bool listen = true}){ //listen 是否注册依赖关系 默认注册 final type = _typeOf<InheritedProvider<T>>(); final provider = listen ? context.inheritFromWidgetOfExactType(type) as InheritedProvider<T> : context.ancestorInheritedElementForWidgetOfExactType(type)?.widget as InheritedProvider<T>; return provider.data; } @override State<StatefulWidget> createState() { return _ChangeNotifierProviderState<T>(); } } class _ChangeNotifierProviderState<T extends ChangeNotifier> extends State<ChangeNotifierProvider<T>>{ @override Widget build(BuildContext context) { //构建 InheritedProvider return InheritedProvider<T>( data: widget.data, child: widget.child, ); } } 复制代码
class _ChangeNotifierProviderState<T extends ChangeNotifier> extends State<ChangeNotifierProvider<T>>{ @override void initState() { // 给model添加监听器 widget.data.addListener(update); super.initState(); } @override void didUpdateWidget(ChangeNotifierProvider<T> oldWidget) { //当Provider更新时,若是新旧数据不"==",则解绑旧数据监听,同时添加新数据监听 if(widget.data != oldWidget.data){ oldWidget.data.removeListener(update); widget.data.addListener(update); } super.didUpdateWidget(oldWidget); } // build方法 省略 ........ @override void dispose() { // 移除model监听器 widget.data.removeListener(update); super.dispose(); } void update() { //若是数据发生变化(model类调用了notifyListeners),从新构建InheritedProvider setState(() => { }); } 复制代码
/// Created with Android Studio. /// User: maoqitian /// Date: 2019/11/18 0018 /// email: maoqitian068@163.com /// des: 事件 消费者 得到当前context和指定数据类型的Provider import 'package:flutter/material.dart'; import 'package:flutter_theme_change/provider/ChangeNotifierProvider.dart'; class Consumer<T> extends StatelessWidget{ final Widget child; //得到当前context final Widget Function(BuildContext context, T value) builder; Consumer({Key key,@required this.builder,this.child}):assert(builder !=null),super(key:key); @override Widget build(BuildContext context) { //默认绑定 注册依赖关系 return builder(context,ChangeNotifierProvider.of<T>(context)); //自动获取Model 获取更新的数据 } } 复制代码
上一节中手写了一个很是简单基于InheritedWidget的Provider数据共享组件,接下来经过一个切换主题的例子来使用刚刚写好的ChangeNotifierProvider。数组
主题切换这里简单的改变主题颜色,因此共享数据就是颜色值,Demo 思路为使用Dialog,提供可选择的主题颜色,而后点击对应颜色则切换应用主题颜色,接下来一块儿实现。bash
/// Created with Android Studio. /// User: maoqitian /// Date: 2019/11/18 0018 /// email: maoqitian068@163.com /// des: 主题 model import 'package:flutter/material.dart'; class ThemeModel extends ChangeNotifier { int settingThemeColor ; ThemeModel(this.settingThemeColor); void changeTheme (int themeColor){ this.settingThemeColor = themeColor; // 通知监听器(订阅者),从新构建InheritedProvider, 更新状态。 notifyListeners(); } } 复制代码
class _MyHomePageState extends State<MyHomePage> { int themeColor =0; @override void initState() { super.initState(); themeColor = sp.getInt(SharedPreferencesKeys.themeColor); if(themeColor == null ){ themeColor = 0xFF3391EA;//默认蓝色 } } @override Widget build(BuildContext context) { return Center( child: ChangeNotifierProvider<ThemeModel>( data: ThemeModel(themeColor), child: Consumer<ThemeModel>( builder: (BuildContext context,themeModel){ return MaterialApp( theme: ThemeData( primaryColor: Color(themeModel.settingThemeColor), ), home: Scaffold( appBar: AppBar( title: Text("Flutter Theme Change"), actions: <Widget>[ Builder(builder: (context){ return IconButton(icon: new Icon(Icons.color_lens), onPressed: (){ _changeColor(context); }); },) // onPressed 点击事件 ], ), body: Center( child: Text("主题变化测试"), ) ), ); }, ), ), ); } void _changeColor(BuildContext context) { buildSimpleDialog(context); } 复制代码
class SingleThemeColor extends StatelessWidget { final int themeColor; final String colorName; const SingleThemeColor({Key key,this.themeColor, this.colorName}): super(key:key); @override Widget build(BuildContext context) { return InkWell( onTap: () async{ print("点击了改变主题"); //改变主题 ChangeNotifierProvider.of<ThemeModel>(context,listen: false).changeTheme(this.themeColor); await SpUtil.getInstance()..putInt(SharedPreferencesKeys.themeColor, this.themeColor); Navigator.pop(context); }, child: new Column( // 竖直布局 children: <Widget>[ Container( width: 50, height: 50, margin: const EdgeInsets.all(5.0), decoration: BoxDecoration( //圆形背景装饰 borderRadius:BorderRadius.all( Radius.circular(50) ), color: Color(this.themeColor) ), ), Text( colorName, style: TextStyle( color: Color(this.themeColor), fontSize: 14.0), ), ], ), ); } } 复制代码