一、Key是什么?

在开始之前,我们先还原两个实际工作场景

  1. 当我们使用v-for时,需要给单元加上key

    1. <ul>
    2. <li v-for="item in items" :key="item.id">...</li>
    3. </ul>
  2. +new Date()生成的时间戳作为key,手动强制触发渲染

    1. <Compment :key="+new Date()" />

    那么背后的逻辑是什么?key的作用是什么?

    key是给每一个vnode的唯一id,也是diff的一种优化策略,可以根据key,更准确更快的找到对应的vnode节点

场景背后的逻辑

当我们在使用v-for时,需要给单元加上key

  • 如果不用key,Vue会采用就地复用原则:最小化element的移动,并且会尝试尽最大程度在同适当的地方对相同的类型的element,做patch或者reuse
  • 如果使用了key,Vue会根据keys的顺序记录element,曾经拥有了key的element如果不再出现的话,会被直接remove或者destoryed

+new Date()生成的时间戳作为key,手动强制触发重新渲染

  • 当拥有了新值的renderer作为key时,拥有了新key的Component出现了,那么旧key Component会被移除,新的Component触发渲染

    二、设置key和不设置key的区别

    举个例子:
    创建一个实例,2秒后往items数组插入数据

    1. <body>
    2. <div id="demo">
    3. <p v-for="item in items" :key="item">{{item}}</p>
    4. </div>
    5. <script src="../../dist/vue.js"></script>
    6. <script>
    7. // 创建实例
    8. const app = new Vue({
    9. el: '#demo',
    10. data: { items: ['a', 'b', 'c', 'd', 'e'] },
    11. mounted () {
    12. setTimeout(() => {
    13. this.items.splice(2, 0, 'f') //
    14. }, 2000);
    15. },
    16. });
    17. </script>
    18. </body>

    在不使用key的情况下,vue会进行这样的操作
    Vue中key原理 - 图1
    分析整体流程:

  • 比较A, A,相同类型的节点,进行patch,但数据相同,不发生dom操作

  • 比较B, B,相同类型的节点,进行patch,但数据相同,不发生dom操作
  • 比较C,F,相同类型的节点,进行patch,数据不同,发生dom操作
  • 比较D,C,相同类型的节点,进行patch,数据不同,发生dom操作
  • 比较E,D,相同类型的节点,进行patch,数据不同,发生dom操作
  • 循环结束,将E插入到DOM中

一共发生了3次更新,1次插入操作
在使用key的情况下,vue会进行这样的操作:

  • 比较A,A,相同类型的节点,进行patch,但数据相同,不发生dom操作
  • 比较B,B,相同类型的节点,进行patch,但数据相同,不发生dom操作
  • 比较C,F,不相同类型的节点
    • 比较E、E,相同类型的节点,进行patch,但数据相同,不发生dom操作
  • 比较D、D,相同类型的节点,进行patch,但数据相同,不发生dom操作
  • 比较C、C,相同类型的节点,进行patch,但数据相同,不发生dom操作
  • 循环结束,将F插入到C之前

一共发生了0次更新,1次插入操作
通过上述两个例子,可以知道设置key能够大大减少对页面dom的操作,提高了diff效率。

设置key值一定能提高diff效率吗?

其实不然,文档中也明确表示

当 Vue.js 用 v-for 正在更新已渲染过的元素列表时,它默认用“就地复用”策略。如果数据项的顺序被改变,Vue 将不会移动 DOM 元素来匹配数据项的顺序, 而是简单复用此处每个元素,并且确保它在特定索引下显示已被渲染过的每个元素

这个默认的模式是高效的,但是只适用于不依赖子组件状态或临时 DOM 状态 (例如:表单输入值) 的列表渲染输出
建议尽可能在使用 v-for 时提供 key,除非遍历输出的 DOM 内容非常简单,或者是刻意依赖默认行为以获取性能上的提升

三、原理分析

判断是否为同一个key,首先判断key值是否相等。如果没有设置key,那么keyundefined,这时候undefined是恒等于undefined

  1. function sameVnode (a, b) {
  2. return (
  3. a.key === b.key && (
  4. (
  5. a.tag === b.tag &&
  6. a.isComment === b.isComment &&
  7. isDef(a.data) === isDef(b.data) &&
  8. sameInputType(a, b)
  9. ) || (
  10. isTrue(a.isAsyncPlaceholder) &&
  11. a.asyncFactory === b.asyncFactory &&
  12. isUndef(b.asyncFactory.error)
  13. )
  14. )
  15. )
  16. }

updateChildren方法中会对新旧vnode进行diff,然后将比对出的结果用来更新真实的dom

  1. function updateChildren (parentElm, oldCh, newCh, insertedVnodeQueue, removeOnly) {
  2. ...
  3. while (oldStartIdx <= oldEndIdx && newStartIdx <= newEndIdx) {
  4. if (isUndef(oldStartVnode)) {
  5. ...
  6. } else if (isUndef(oldEndVnode)) {
  7. ...
  8. } else if (sameVnode(oldStartVnode, newStartVnode)) {
  9. ...
  10. } else if (sameVnode(oldEndVnode, newEndVnode)) {
  11. ...
  12. } else if (sameVnode(oldStartVnode, newEndVnode)) { // Vnode moved right
  13. ...
  14. } else if (sameVnode(oldEndVnode, newStartVnode)) { // Vnode moved left
  15. ...
  16. } else {
  17. if (isUndef(oldKeyToIdx)) oldKeyToIdx = createKeyToOldIdx(oldCh, oldStartIdx, oldEndIdx)
  18. idxInOld = isDef(newStartVnode.key)
  19. ? oldKeyToIdx[newStartVnode.key]
  20. : findIdxInOld(newStartVnode, oldCh, oldStartIdx, oldEndIdx)
  21. if (isUndef(idxInOld)) { // New element
  22. createElm(newStartVnode, insertedVnodeQueue, parentElm, oldStartVnode.elm, false, newCh, newStartIdx)
  23. } else {
  24. vnodeToMove = oldCh[idxInOld]
  25. if (sameVnode(vnodeToMove, newStartVnode)) {
  26. patchVnode(vnodeToMove, newStartVnode, insertedVnodeQueue, newCh, newStartIdx)
  27. oldCh[idxInOld] = undefined
  28. canMove && nodeOps.insertBefore(parentElm, vnodeToMove.elm, oldStartVnode.elm)
  29. } else {
  30. // same key but different element. treat as new element
  31. createElm(newStartVnode, insertedVnodeQueue, parentElm, oldStartVnode.elm, false, newCh, newStartIdx)
  32. }
  33. }
  34. newStartVnode = newCh[++newStartIdx]
  35. }
  36. }
  37. ...
  38. }