目录
0 引言
1 Widget 简介
1.1 Widget 概念
1.2 Widget 接口
1.3 Flutter中的四棵树
1.4 StatelessWidget
1.4.1 简介
1.4.2 Context上下文
1.5 StatefulWidget
1.6 State
1.6.1 简介
1.6.2 State生命周期
1.7 在 widget 树中获取State对象
1.7.1 通过Context获取
1.7.2 通过GlobalKey获取
1.8 通过 RenderObject 自定义 Widget
1.9 Flutter SDK内置组件库介绍
1.9.1 基础组件
1.9.2 Material组件
1.9.3 Cupertino组件
1.10 总结
0 引言
本文是对第二版序 | 《Flutter实战·第二版》 (flutterchina.club)的学习和总结。
1 Widget 简介
1.1 Widget 概念
- Widget 字面意思:控件、组件、部件、微件、插件、小工具
- widget 的功能是“描述一个UI元素的配置信息”,所谓的配置信息就是 Widget 接收的参数
- Widget 只是描述一个UI元素的配置信息,并不是表示最终绘制在设备屏幕上的显示元素
1.2 Widget 接口
@immutable
代表 Widget 是不可变的,即Widget 中定义的属性必须是 final。widget
类继承自DiagnosticableTree
,即“诊断树”,主要作用是提供调试信息。Key
属性类似于 React/Vue 中的key
,主要的作用是决定是否在下一次build
时复用旧的 widget ,决定的条件在canUpdate()
方法中。createElement():
一个 widget 可以对应多个Element,
Flutter 框架在构建UI树时,会先调用此方法生成对应节点的Element
对象。此方法是 Flutter 框架隐式调用的,在开发过程中基本不会调用到。debugFillProperties(...)
复写父类的方法,主要是设置诊断树的一些特性。canUpdate(...)
是一个静态方法,只要newWidget
与oldWidget
的runtimeType
和key
同时相等,就会用new widget
去更新旧UI树上所对应的Element
对象的配置,否则会创建新的Element对象
。- 在 Flutter 开发中,一般不用直接继承
Widget
类来实现一个新组件。通常会通过继承StatelessWidget
或StatefulWidget
来间接继承widget
类来实现。
/*
Widget 类的声明:
*/
@immutable // 不可变的
abstract class Widget extends DiagnosticableTree {const Widget({ this.key });final Key? key;@protected@factoryElement createElement();@overrideString toStringShort() {final String type = objectRuntimeType(this, 'Widget');return key == null ? type : '$type-$key';}@overridevoid debugFillProperties(DiagnosticPropertiesBuilder properties) {super.debugFillProperties(properties);properties.defaultDiagnosticsTreeStyle = DiagnosticsTreeStyle.dense;}@override@nonVirtualbool operator ==(Object other) => super == other;@override@nonVirtualint get hashCode => super.hashCode;static bool canUpdate(Widget oldWidget, Widget newWidget) {return oldWidget.runtimeType == newWidget.runtimeType&& oldWidget.key == newWidget.key;}...
}
1.3 Flutter中的四棵树
Flutter 框架的处理流程:(真正的布局、绘制是由谁来完成的)
- 根据 Widget 树生成一个 Element 树,Element 树中的节点都继承自
Element
类。- 根据 Element 树生成 Render 树(渲染树),渲染树中的节点都继承自
RenderObject
类。- 根据渲染树生成 Layer 树,然后上屏显示,Layer 树中的节点都继承自
Layer
类。
- Flutter 真正的布局和渲染逻辑在 Render 树中
- Element 是 Widget 和 RenderObject 的粘合剂,可以理解为一个中间代理。
/*假设有如下 Widget 树:Container 内部会创建一个新的 ColoredBox 来填充背景Image 内部会通过 RawImage 来渲染图片Text 内部会通过 RichText 来渲染文本
*/
Container( // 一个容器 widgetcolor: Colors.blue, // 设置容器背景色child: Row( // 可以将子widget沿水平方向排列children: [Image.network('https://www.example.com/1.png'), // 显示图片的 widgetconst Text('A'),],),
);
Widget树、Element 树、渲染树结构:
1.4 StatelessWidget
1.4.1 简介
- 无状态的组件,用于不需要维护状态的场景
- 继承自
widget
类,重写了createElement()
方法- 通常在
build
方法中通过嵌套其他 widget 来构建UI,在构建过程中会递归的构建其嵌套的 widget
//main 函数为应用程序的入口
void main() {//runApp(Widget参数),它的功能是启动Flutter应用runApp(const MyApp());
}//MyApp对象
class MyApp extends StatelessWidget {const MyApp({super.key});// 应用的根组件@overrideWidget build(BuildContext context) {// 调用自定义的 widget return Echo(text: "hello world");}
}// 自定义 widget
class Echo extends StatelessWidget {//使用命名参数,定义 widget 的构造函数const Echo({Key? key, //在继承 widget 时,第一个参数通常应该是Keyrequired this.text, //必需要传的参数要添加required关键字this.backgroundColor = Colors.grey, //默认为灰色}):super(key:key);// widget 的属性应尽可能的被声明为final,防止被意外改变final String text;final Color backgroundColor;@overrideWidget build(BuildContext context) {return Center(child: Container(color: backgroundColor,child: Text(text), //child或children参数通常应被放在参数列表的最后),);}
1.4.2 Context上下文
build
方法有一个context
参数- 它是
BuildContext
类的一个实例,表示当前 widget 在 widget 树中的上下文- 每一个 widget 都会对应一个 context 对象
- 它提供了从当前 widget 开始向上遍历 widget 树的方法
- 它提供了按照 widget 类型查找父级 widget 的方法
class ContextRoute extends StatelessWidget {@overrideWidget build(BuildContext context) {/*Scaffold 是 Material 库中提供的页面脚手架它提供了默认的导航栏、标题和包含主屏幕 widget 树的body属性*/return Scaffold(appBar: AppBar(title: Text("Context测试"),),body: Container( // 一个容器 widgetchild: Builder(builder: (context) {// 在 widget 树中向上查找最近的父级`Scaffold` widget Scaffold scaffold = context.findAncestorWidgetOfExactType<Scaffold>();// 直接返回 AppBar的title, 此处实际上是Text("Context测试")return (scaffold.appBar as AppBar).title;}),),);}
}
1.5 StatefulWidget
- 有状态的组件,用于需要维护状态的场景
- 继承自
widget
类,重写了createElement()
方法- 添加了一个新的接口
createState()
- State 对象和
StatefulElement
具有一一对应的关系
/*
StatefulWidget的类定义:
*/
abstract class StatefulWidget extends Widget {const StatefulWidget({ Key key }) : super(key: key);@overrideStatefulElement createElement() => StatefulElement(this); /*用于创建和 StatefulWidget 相关的状态,在StatefulWidget 的生命周期中可能会被多次调用,一个StatefulElement对应一个State实例*/@protectedState createState();
}
1.6 State
1.6.1 简介
一个 StatefulWidget 类会对应一个 State 类,State表示与其对应的 StatefulWidget 要维护的状态,State 中保存的状态信息可以:
- 在 widget 构建时可以被同步读取。
- 在 widget 生命周期中可以被改变,当State被改变时,可以手动调用其
setState()
方法通知Flutter 框架状态发生改变,Flutter 框架在收到消息后,会重新调用其build
方法重新构建 widget 树,从而达到更新UI的目的。
State 中有两个常用属性:
widget
,它表示与该 State 实例关联的 widget 实例,由Flutter 框架动态设置。注意,这种关联并非永久的,因为在应用生命周期中,UI树上的某一个节点的 widget 实例在重新构建时可能会变化,但State实例只会在第一次插入到树中时被创建,当在重新构建时,如果 widget 被修改了,Flutter 框架会动态设置State. widget 为新的 widget 实例。context
。StatefulWidget对应的 BuildContext,作用同StatelessWidget 的BuildContext。
1.6.2 State生命周期
initState
:当 widget 第一次插入到 widget 树时会被调用,对于每一个State对象,Flutter 框架只会调用一次该回调。所以,通常在该回调中做一些一次性的操作,如状态初始化、订阅子树的事件通知等。didChangeDependencies()
:当State对象的依赖发生变化时会被调用。组件第一次被创建后挂载的时候(包括重创建)对应的didChangeDependencies
也会被调用。
build()
:用于构建 widget 子树的,会在如下场景被调用:
- 在调用
initState()
之后。- 在调用
didUpdateWidget()
之后。- 在调用
setState()
之后。- 在调用
didChangeDependencies()
之后。- 在State对象从树中一个位置移除后(会调用deactivate)又重新插入到树的其他位置之后。
reassemble()
:专门为了开发调试而提供的,在热重载(hot reload)时会被调用,在Release模式下永远不会被调用。
didUpdateWidget()
:在 widget 重新构建时,Flutter 框架会调用widget.canUpdate
来检测 widget 树中同一位置的新旧节点,然后决定是否需要更新,如果widget.canUpdate
返回true
则会调用此回调。widget.canUpdate
会在新旧 widget 的key
和runtimeType
同时相等时会返回true。
deactivate()
:当 State 对象从树中被移除时,会调用此回调。在一些场景下,Flutter 框架会将 State 对象重新插到树中,如包含此 State 对象的子树在树的一个位置移动到另一个位置时。如果移除后没有重新插入到树中则紧接着会调用dispose()
方法。
dispose()
:当 State 对象从树中被永久移除时调用;通常在此回调中释放资源。注意:在继承
StatefulWidget
重写其方法时,对于包含@mustCallSuper
标注的父类方法,都要在子类方法中调用父类方法。
/*实现一个计数器 CounterWidget 组件 ,点击它可以使计数器加1,由于要保存计数器的数值状态,所以应继承StatefulWidget
*/
class CounterWidget extends StatefulWidget {//构造函数const CounterWidget({Key? key, this.initValue = 0});//组件的参数final int initValue;//重写createState方法@override_CounterWidgetState createState() => _CounterWidgetState();
}/*createState方法
*/
class _CounterWidgetState extends State<CounterWidget> {int _counter = 0;@overridevoid initState() {super.initState();//初始化状态_counter = widget.initValue;print("initState");}@overrideWidget build(BuildContext context) {print("build");return Scaffold(body: Center(child: TextButton(child: Text('$_counter'),//点击后计数器自增onPressed: () => setState(() => ++_counter,),),),);}@overridevoid didUpdateWidget(CounterWidget oldWidget) {super.didUpdateWidget(oldWidget);print("didUpdateWidget ");}@overridevoid deactivate() {super.deactivate();print("deactivate");}@overridevoid dispose() {super.dispose();print("dispose");}@overridevoid reassemble() {super.reassemble();print("reassemble");}@overridevoid didChangeDependencies() {super.didChangeDependencies();print("didChangeDependencies");}
}/*调用自定义的CounterWidget
*/
class StateLifecycleTest extends StatelessWidget {const StateLifecycleTest({Key? key}) : super(key: key);@overrideWidget build(BuildContext context) {return CounterWidget();}
}/*1.运行应用,屏幕中央就会出现一个数字0,然后控制台日志输出:I/flutter ( 5436): initStateI/flutter ( 5436): didChangeDependenciesI/flutter ( 5436): build2.热重载,控制台输出日志如下:I/flutter ( 5436): reassembleI/flutter ( 5436): didUpdateWidget I/flutter ( 5436): build3.将return CounterWidget();改为 return Text("xxx");然后热重载,日志如下:I/flutter ( 5436): reassembleI/flutter ( 5436): deactiveI/flutter ( 5436): dispose
*/
StatefulWidget 生命周期如下图所示:
1.7 在 widget 树中获取State对象
在子 widget 树中获取父级 StatefulWidget 的State 对象的两种方法:
- 通过Context获取:
context
对象有一个findAncestorStateOfType()
方法,该方法可以从当前节点沿着 widget 树向上查找指定类型的 StatefulWidget 对应的 State 对象。- 通过GlobalKey获取:GlobalKey 是 Flutter 提供的一种在整个 App 中引用 element 的机制。如果一个 widget 设置了
GlobalKey,
则可以通过globalKey.currentState
来获得该 widget 对应的state对象。(开销大,不推荐这种方法)
1.7.1 通过Context获取
通过Context获取State 对象的两种方法:
- 通过
context.findAncestorStateOfType
获取 StatefulWidget 的状态的方法是通用的。- 但如果 StatefulWidget 的状态是公共的(希望暴露出的),Flutter SDK默认在 StatefulWidget 中提供一个
of
静态方法来供开发者获取其 State 对象。开发者在自定义StatefulWidget 时也应遵守这一规则。
// Scaffold组件对应的状态类ScaffoldState中定义了打开 SnackBar(路由页底部提示条)的方法
// 下面是实现打开 SnackBar 的示例:/*1.通过context.findAncestorStateOfType获取ScaffoldState
*/
class GetStateObjectRoute extends StatefulWidget {const GetStateObjectRoute({Key? key}) : super(key: key);@overrideState<GetStateObjectRoute> createState() => _GetStateObjectRouteState();
}class _GetStateObjectRouteState extends State<GetStateObjectRoute> {@overrideWidget build(BuildContext context) {return Scaffold(appBar: AppBar(title: Text("子树中获取State对象"),),body: Center(child: Column(children: [Builder(builder: (context) {return ElevatedButton(onPressed: () {// 查找父级最近的Scaffold对应的ScaffoldState对象ScaffoldState _state = context.findAncestorStateOfType<ScaffoldState>()!;// 打开抽屉菜单_state.openDrawer();},child: Text('打开抽屉菜单1'),);}),],),),drawer: Drawer(),);}
}/*2.通过of静态方法来获取ScaffoldState
*/Builder(builder: (context) {return ElevatedButton(onPressed: () {// 直接通过of静态方法来获取ScaffoldStateScaffoldState _state=Scaffold.of(context);// 打开抽屉菜单_state.openDrawer();},child: Text('打开抽屉菜单2'),);
}),/*显示 snack bar 的代码
*/
Builder(builder: (context) {return ElevatedButton(onPressed: () {ScaffoldMessenger.of(context).showSnackBar(SnackBar(content: Text("我是SnackBar")),);},child: Text('显示SnackBar'),);
}),
1.7.2 通过GlobalKey获取
如果一个 widget 设置了
GlobalKey,则:
- 可以通过
globalKey.currentWidget
获得该 widget 对象- 可以通过
globalKey.currentElement
来获得 widget 对应的element对象- 可以通过
globalKey.currentState
来获得该 widget 对应的state对象
注意事项:
- 使用 GlobalKey 开销较大,如果有其他可选方案,应尽量避免使用它。
- 同一个 GlobalKey 在整个 widget 树中必须是唯一的,不能重复。
/*Flutter还有一种通用的获取State对象的方法——通过GlobalKey来获取! 步骤分两步:
*//*1.给目标StatefulWidget添加GlobalKey。
*/
//定义一个globalKey, 由于GlobalKey要保持全局唯一性,我们使用静态变量存储
static GlobalKey<ScaffoldState> _globalKey= GlobalKey();
...
Scaffold(key: _globalKey , //设置key...
)/*2.通过GlobalKey来获取State对象
*/
_globalKey.currentState.openDrawer()
1.8 通过 RenderObject 自定义 Widget
- Flutter 最原始的定义组件的方式是通过定义RenderObject 来实现的。
StatelessWidget
和StatefulWidget
本身没有对应的 RenderObject,它们是用于组合其他组件的,Flutter 组件库中的很多基础组件都不是通过它们来实现的。- 就好比搭积木,
StatelessWidget 和
StatefulWidget
可以将积木搭成不同的样子,但前提是得有积木,而这些积木都是通过自定义 RenderObject 来实现的,比如 Text 、Column、Align等。
通过RenderObject定义组件的方式:
- 如果自定义的 widget 不会包含子组件,可以直接继承LeafRenderObjectWidget
- 如果自定义的 widget 可以包含子组件,则可以根据子组件的数量来选择继承SingleChildRenderObjectWidget 或 MultiChildRenderObjectWidget
- 它们都继承自RenderObjectWidget
- 它们都实现了createElement() 方法,返回不同类型的 Element 对象
- createRenderObject 方法被组件对应的 Element 调用(构建渲染树时)用于生成渲染对象。
- updateRenderObject 方法是用于在组件树状态发生变化但不需要重新创建 RenderObject 时用于更新组件渲染对象的回调。
/*自定义Widget 继承 叶渲染器Widget
*/
class CustomWidget extends LeafRenderObjectWidget{@overrideRenderObject createRenderObject(BuildContext context) {// 创建 RenderObjectreturn RenderCustomObject();}@overridevoid updateRenderObject(BuildContext context, RenderCustomObject renderObject) {// 更新 RenderObjectsuper.updateRenderObject(context, renderObject);}
}/*自定义RenderObject,继承自 RenderBox,RenderBox 继承自 RenderObject,需要在 RenderCustomObject 中实现布局、绘制、事件响应等逻辑
*/
class RenderCustomObject extends RenderBox{@overridevoid performLayout() {// 实现布局逻辑}@overridevoid paint(PaintingContext context, Offset offset) {// 实现绘制}
}/*如果组件不会包含子组件,可以直接继承自 LeafRenderObjectWidget ,它是 RenderObjectWidget 的子类,而 RenderObjectWidget 继承自 Widget, LeafRenderObjectWidget 的实现如下:
*/
abstract class LeafRenderObjectWidget extends RenderObjectWidget {const LeafRenderObjectWidget({ Key? key }) : super(key: key);@overrideLeafRenderObjectElement createElement() => LeafRenderObjectElement(this);
}
1.9 Flutter SDK内置组件库介绍
Flutter 提供了一套丰富、强大的基础组件库,在基础组件库之上 Flutter 又提供了:
- 一套 Material 风格( Android 默认的视觉风格)的组件库
- 一套 Cupertino 风格(iOS视觉风格)的组件库
1.9.1 基础组件
要使用基础组件,需要先导入:
import 'package:flutter/widgets.dart';
常用的基础组件:
- Text (opens new window):该组件可让您创建一个带格式的文本。
- Row (opens new window)、 Column (opens new window): 这些具有弹性空间的布局类 widget 可让您在水平(Row)和垂直(Column)方向上创建灵活的布局。其设计是基于 Web 开发中的 Flexbox 布局模型。
- Stack (opens new window): 取代线性布局 (和 Android 中的
FrameLayout
相似),[Stack
](https://docs.flutter.dev/flutter/ widgets/Stack-class.html)允许子 widget 堆叠, 你可以使用 Positioned (opens new window)来定位他们相对于Stack
的上下左右四条边的位置。Stacks是基于Web开发中的绝对定位(absolute positioning )布局模型设计的。- Container (opens new window): Container (opens new window)可让您创建矩形视觉元素。Container 可以装饰一个BoxDecoration (opens new window), 如 background、一个边框、或者一个阴影。 Container (opens new window)也可以具有边距(margins)、填充(padding)和应用于其大小的约束(constraints)。另外, Container (opens new window)可以使用矩阵在三维空间中对其进行变换。
1.9.2 Material组件
要使用Material组件,需要先导入:
import 'package:flutter/material.dart';
- Flutter 提供了一套丰富 的Material 组件,它可以帮助我们构建遵循 Material Design 设计规范的应用程序。
- Material 应用程序以MaterialApp (opens new window) 组件开始, 该组件在应用程序的根部创建了一些必要的组件,比如
Theme、
Scaffold
、AppBar
、TextButton
等。- Material 组件库中有一些组件可以根据实际运行平台来切换表现风格,比如
MaterialPageRoute
,在路由切换时,如果是 Android 系统,它将会使用 Android 系统默认的页面切换动画(从底向上);如果是 iOS 系统,它会使用 iOS 系统默认的页面切换动画(从右向左)。
1.9.3 Cupertino组件
要使用Cupertino组件,需要先导入:
import 'package:flutter/cupertino.dart';
Flutter 也提供了一套丰富的 Cupertino 风格的组件,尽管目前还没有 Material 组件那么丰富,但是它仍在不断的完善中。
/*一个简单的 Cupertino 组件风格的页面
*///导入cupertino widget 库
import 'package:flutter/cupertino.dart';class CupertinoTestRoute extends StatelessWidget {const CupertinoTestRoute({Key? key}) : super(key: key);@overrideWidget build(BuildContext context) {return CupertinoPageScaffold(navigationBar: const CupertinoNavigationBar(middle: Text("Cupertino Demo"),),child: Center(child: CupertinoButton(color: CupertinoColors.activeBlue,child: const Text("Press"),onPressed: () {}),),);}
}
1.10 总结
- Flutter 的 widget 类型分为
StatefulWidget
和StatelessWidget
两种,widget 是构建Flutter应用的基石。- Flutter 提供了丰富的组件,在实际的开发中可以根据需要随意使用它们,而不必担心引入过多组件库会让应用安装包变大,这不是 web 开发,dart 在编译时只会编译你使用了的代码。
- 由于 Material 和 Cupertino 都是在基础组件库之上的,所以如果我们的应用中引入了这两者之一,则不需要再引入
flutter/ widgets.dart
了,因为它们内部已经引入过了。