Flutter 之 Key 详解

1、Key 作用

在 Flutter 中,Key 是不能重复使用的,所以 Key 一般用来做唯一标识。组件在更新的时候,其状态的保存主要是通过判断组件的类型或者 key 值是否一致。因此,当各组件的类型不同的时候,类型已经足够用来区分不同的组件了,此时我们可以不必使用 key。但是如果同时存在多个同一类型的控件的时候,此时类型已经无法作为区分的条件了,我们就需要使用到 key。

2、示例

class HomePage extends StatefulWidget {
  const HomePage({super.key});

  @override
  State<HomePage> createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  List<Widget> list = [
    Box(
      color: Colors.blue,
    ),
    Box(
      color: Colors.red,
    ),
    Box(
      color: Colors.orange,
    )
  ];

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      floatingActionButton: FloatingActionButton(
        onPressed: () {
          setState(() {
            list.shuffle(); //打乱list的顺序
          });
        },
        child: const Icon(Icons.refresh),
      ),
      appBar: AppBar(
        title: const Text('Title'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: list,
        ),
      ),
    );
  }
}

// ignore: must_be_immutable
class Box extends StatefulWidget {
  Color color;
  Box({super.key, required this.color});
  @override
  State<Box> createState() => _BoxState();
}

class _BoxState extends State<Box> {
  int _count = 0;
  @override
  Widget build(BuildContext context) {
    return SizedBox(
      height: 100,
      width: 100,
      child: ElevatedButton(
        style: ButtonStyle(
            backgroundColor: MaterialStateProperty.all(widget.color)),
        onPressed: () {
          setState(() {
            _count++;
          });
        },
        child: Center(
          child: Text("$_count"),
        ),
      ),
    );
  }
}

运行后发现改变 list Widget 顺序后,Widget 颜色会变化,但是每个 Widget 里面的文本内容并没有变化?
当 List 重新排序后 Flutter 检测到了 Widget 的顺序变化,所以重新绘制 ListWidget,但是 Flutter 发现 List Widget 里面的元素没有变化,所以就没有改变 Widget 里面的内容。
把 List 里面的 Box 的颜色改成一样,这个时候重新对 list 进行排序,就很容易理解了。重新排序后虽然执行了setState,但是代码和以前是一样的,所以 Flutter 不会重构 List Widget 里面的内容, 也就是 Flutter 没法通过 Box 里面传入的参数来识别 Box 是否改变。如果要让 FLutter 能识别到 List Widget 子元素的改变,就需要给每个 Box 指定一个 key。

3、LocalKey、GlobalKey

1、 Flutter key 子类包含 LocalKey 和 GlobalKey 。

局部键(LocalKey):ValueKey、ObjectKey、UniqueKey。
全局键(GlobalKey): GlobalKey、GlobalObjectKey。
ValueKey (值key):把一个值作为 key 。
UniqueKey(唯一key):程序生成唯一的 Key,当我们不知道如何指定 ValueKey 的时候就可以使用 UniqueKey。
ObjectKey(对象 key):把一个对象实例作为 key。
GlobalKey:每个 Widget 都对应一个 Element ,我们可以直接对 Widget 进行操作,但是无法直接操作 Widget 对应的 Element 。而 GlobalKey 就是那把直接访问 Element 的钥匙。通过 GlobalKey可以获取到 Widget 对应的 Element 。

2、key 的使用

LocalKey 使用

//替换上述示例中 list 数据
  // List<Widget> list = [
  //   Box(
  //     color: Colors.blue,
  //   ),
  //   Box(
  //     color: Colors.red,
  //   ),
  //   Box(
  //     color: Colors.orange,
  //   )
  // ];
  List<Widget> list = [
    Box(
      key: const ValueKey(1),
      color: Colors.blue,
    ),
    Box(
      key: ObjectKey(Box(color: Colors.red)),
      color: Colors.red,
    ),
    Box(
      key: UniqueKey(), //程序自动生成一个key
      color: Colors.orange,
    )
  ];

GlobalKey 的使用
如果把 LocalKey 比作局部变量, GlobalKey 就类似于全局变量。在使用了 LocalKey 之后,在上述示例中,当屏幕状态改变的时候把 Colum 换成了 Row,Box 的状态就会丢失。

//示例中要使用添加过 LocalKey 之后的 list
//更改 Scaffold 中 body 里面的内容
     // body: Center(
     //   child: Column(
     //     mainAxisAlignment: MainAxisAlignment.center,
     //     children: list,
     //   ),
     // ),
     body: Center(
       child: MediaQuery.of(context).orientation == Orientation.portrait
           ? Column(
               mainAxisAlignment: MainAxisAlignment.center,
               children: list,
             )
           : Row(
               mainAxisAlignment: MainAxisAlignment.center,
               children: list,
             ),
     ),

分析:由于一个 Widget 状态的保存主要是通过判断组件的类型或者 key 值是否一致。LocalKey 只在当前的组件树有效,所以把 Colum 换成了 Row 的时候 Widget 的状态就丢失了。为了解决这个问题我们就可以使用 GlobalKey。

//在以上代码的基础上更改 list 数据
///1.不适用 key
 // List<Widget> list = [
 //   Box(
 //     color: Colors.blue,
 //   ),
 //   Box(
 //     color: Colors.red,
 //   ),
 //   Box(
 //     color: Colors.orange,
 //   )
 // ];

 ///2.使用 LocalKey
 // List<Widget> list = [
 //   Box(
 //     key: const ValueKey(1),
 //     color: Colors.blue,
 //   ),
 //   Box(
 //     key: ObjectKey(Box(color: Colors.red)),
 //     color: Colors.red,
 //   ),
 //   Box(
 //     key: UniqueKey(), //程序自动生成一个key
 //     color: Colors.orange,
 //   )
 // ];
 
 ///3.GlobalKey
 List<Widget> list = [];
 final GlobalKey _key1 = GlobalKey();
 final GlobalKey _key2 = GlobalKey();
 final GlobalKey _key3 = GlobalKey();
 @override
 void initState() {
   super.initState();
   list = [
     Box(
       key: _key1,
       color: Colors.blue,
     ),
     Box(
       key: _key2,
       color: Colors.red,
     ),
     Box(
       key: _key3,
       color: Colors.orange,
     )
   ];
 }
3、 GlobalKey 获取子组件

globalKey.currentState 可以获取子组件的状态,执行子组件的方法。
globalKey.currentWidget 可以获取子组件的属性。
_globalKey.currentContext!.findRenderObject() 可以获取渲染的属性。

class _HomePageState extends State<HomePage> {
 final GlobalKey _globalKey = GlobalKey();
 @override
 Widget build(BuildContext context) {
   return Scaffold(
     floatingActionButton: FloatingActionButton(
       child: const Icon(Icons.add),
       onPressed: () {
         //1、获取子组件的状态 调用子组件的属性
         var state = (_globalKey.currentState as _BoxState);
         setState(() {
           state._count++;
         });

         //2、获取子组件的属性
         var box = (_globalKey.currentWidget as Box);
         print(box.color);

         //3、获取子组件渲染的属性
         var renderBox =
             (_globalKey.currentContext!.findRenderObject() as RenderBox);
         print(renderBox.size);
       },
     ),
     appBar: AppBar(
       title: const Text('Title'),
     ),
     body: Center(
       child: Box(
         key: _globalKey,
         color: Colors.red,
       ),
     ),
   );
 }
}

4、 Widget Tree、Element Tree 、 RenderObject Tree

Flutter 应用是由是 Widget Tree、Element Tree 和 RenderObject Tree 组成。
Widget:Widget 就是一个类, 是 Element 的配置信息。与 Element 的关系可以是一对多,一份配置可以创造多个 Element 实例。
Element:Widget 的实例化,内部持有 Widget 和 RenderObject。
RenderObject:负责渲染绘制。
默认情况下面,当 Flutter 同一个 Widget 的大小,顺序变化的时候,FLutter 不会改变 Widget 的 state。

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

推荐阅读更多精彩内容