Vue模板中使用v-for时,不建议将index作为key

Vue模板中使用v-for指令时不建议将index作为:key属性。今天我在看项目代码时,发现有多年开发经验的前端老鸟也犯这样的低级错误。

今天我们就从其原理上说明为什么不建议将 index 作为 v-forkey,除非你能确定该 v-for 遍历的数组长度始终不会发生变化,不过在这个需求多变的时代谁能保证产品不会想一出是一出呢?

当我们在模板里使用了响应式变量时,当变化值发生变化时,其对应的dom对象也会触发更新,这背后就是vue内部的 vdom diff 算法过程

如下模板代码

<ul>
     <li>a</li>
     <li>b</li>
</ul>

生成的 VDOM 大致如下

{
  tag: 'ul',
  children: [
    { tag: 'li', children: [ { vnode: { text: 'a' }}]  },
    { tag: 'li', children: [ { vnode: { text: 'b' }}]  },
  ]
}

之后把两个li顺序改变下

{
  tag: 'ul',
  children: [
    { tag: 'li', children: [ { vnode: { text: 'b' }}]  },
    { tag: 'li', children: [ { vnode: { text: 'a' }}]  },
  ]
}

接下来就是diff算法发挥作用了,首先就是响应式 更新之后,会调用渲染 Watcher 的回调函数vm._update(vm._render())去驱动视图更新,vm._render() 其实生成的就是 vnode,而 vm._update 就会带着新的 vnode 去走触发 patch 过程。

  • 其中首先判断的就是节点是否相同:
    • 不相同:就会直接删除旧的vnode,渲染新的vnode;
    • 相同:就要让节点尽可能多的复用;

但是节点相同就要判断很多情况,如:vnode是文字的话就直接替换掉文字;vnode不是的话就要对children进行比较(ul中li做比较);如果有新vnode,没有旧的vnode,就需要增加节点;如果没有新vnode,有旧vnode,那么就要删除节点;如果新旧节点都有,就需要diff算法了;

  // 旧首节点
  let oldStartIdx = 0
  // 新首节点
  let newStartIdx = 0
  // 旧尾节点
  let oldEndIdx = oldCh.length - 1
  // 新尾节点
  let newEndIdx = newCh.length - 1

这是用变量把新节点首尾,旧节点的首尾表示,在while中,不断的对新旧节点进行比较,直到指针收缩到没有节点可以比较。

其中有一个函数 sameVnode,

function sameVnode (a, b) {
  return (
    a.key === b.key && (
      (
        a.tag === b.tag &&
        a.isComment === b.isComment &&
        isDef(a.data) === isDef(b.data) &&
        sameInputType(a, b)
      )
    )
  )
}

它是用来判断节点是否可用的关键函数,可以看到,判断是否是 sameVnode,传递给节点的 key 是关键。

然后我们接着进入 diff 过程,每一轮都是同样的对比,其中某一项命中了,就递归的进入 patchVnode 针对单个 vnode 进行的过程(如果这个 vnode 又有 children,那么还会来到这个 diff children 的过程 ):

  1. 旧首节点和新首节点用sameNode 对比;
  2. 旧尾节点和新尾节点用sameNode 对比;
  3. 旧首节点和新尾节点用sameNode 对比;
  4. 旧尾节点和新首节点用sameNode 对比;
  5. 如果以上逻辑都匹配不到,再把所有旧子节点的 key 做一个映射到旧节点下标的 key -> index 表,然后用新 vnode 的 key 去找出在旧节点中可以复用的位置。

然后不停的把匹配到的指针向内部收缩,直到新旧节点有一端的指针相遇(说明这个端的节点都被patch过了)。

在指针相遇以后,还有两种比较特殊的情况:

有新节点需要加入。 如果更新完以后,oldStartIdx > oldEndIdx,说明旧节点都被 patch 完了,但是有可能还有新的节点没有被处理到。接着会去判断是否要新增子节点。

有旧节点需要删除。 如果新节点先patch完了,那么此时会走 newStartIdx > newEndIdx 的逻辑,那么就会去删除多余的旧子节点。

我们可以使用 Vue SFC Playground 来演示这个过程

<script setup>
import { ref } from 'vue'

const list= ref(['111', '222', '333', '444'])

const handleAddd = () => {
  list.value.unshift('test' + Math.random().toString(16).slice(2))
}

const handleRemove = index => {
  list.value.splice(index, 1)
}
</script>

<template>
  <ul>
    <li v-for="(item, index) in list" :key="index">
      item: {{item}}
      <button @click="handleRemove(index)">
        删除
      </button>
    </li>
  </ul>
  <button @click="handleAddd">
    新增
  </button>
</template>

如上代码所示,我们使用index作为key时,此时我们在数组 list 的头部添加一个元素,会导致其他li进行不必要的更新。

因list子项的key发生了变化导致更新

删除也是如此,由于li的key发生变化,会导致不必要的更新


发生变化的子项key会导致dom更新

此时我们将 key 绑定为 item 时,将只更新需要更新的dom

应确保绑定的 keylist 中能唯一,不与其他项相同

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

推荐阅读更多精彩内容