面试官：说说为什么要在列表组件中写 key，其作用是什么？

我就是我 2022-12-28 15:27 130阅读 0赞

![format_png][]

## 一、Key是什么    ##

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

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

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

<Comp :key="+new Date()" />

那么这背后的逻辑是什么，`key`的作用又是什么？

一句话来讲

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

### 场景背后的逻辑 ###

场景1: 当我们在使用`v-for`时，需要给单元加上`key`

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

场景2: 用`+new Date()`生成的时间戳作为`key`，手动强制触发重新渲染

*  当拥有新值的rerender作为key时，拥有了新key的Comp出现了，那么旧key Comp会被移除，新key Comp触发渲染

## 二、设置key与不设置key区别 ##

举个例子：

创建一个实例，2秒后往`items`数组插入数据

<body>
      <div id="demo">
        <p v-for="item in items" :key="item">{
        {item}}</p>
      </div>
      <script src="../../dist/vue.js"></script>
      <script>
        // 创建实例
        const app = new Vue({
          el: '#demo',
          data: { items: ['a', 'b', 'c', 'd', 'e'] },
          mounted () {
            setTimeout(() => { 
              this.items.splice(2, 0, 'f')  // 
           }, 2000);
         },
       });
      </script>
    </body>

在不使用`key`的情况，`vue`会进行这样的操作：

![format_png 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 内容非常简单，或者是刻意依赖默认行为以获取性能上的提升

## 三、原理分析 ##

源码位置：core/vdom/patch.js

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

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)
                ) || (
                    isTrue(a.isAsyncPlaceholder) &&
                    a.asyncFactory === b.asyncFactory &&
                    isUndef(b.asyncFactory.error)
                )
            )
        )
    }

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

function updateChildren (parentElm, oldCh, newCh, insertedVnodeQueue, removeOnly) {
        ...
        while (oldStartIdx <= oldEndIdx && newStartIdx <= newEndIdx) {
            if (isUndef(oldStartVnode)) {
                ...
            } else if (isUndef(oldEndVnode)) {
                ...
            } else if (sameVnode(oldStartVnode, newStartVnode)) {
                ...
            } else if (sameVnode(oldEndVnode, newEndVnode)) {
                ...
            } else if (sameVnode(oldStartVnode, newEndVnode)) { // Vnode moved right
                ...
            } else if (sameVnode(oldEndVnode, newStartVnode)) { // Vnode moved left
                ...
            } else {
                if (isUndef(oldKeyToIdx)) oldKeyToIdx = createKeyToOldIdx(oldCh, oldStartIdx, oldEndIdx)
                idxInOld = isDef(newStartVnode.key)
                    ? oldKeyToIdx[newStartVnode.key]
                    : findIdxInOld(newStartVnode, oldCh, oldStartIdx, oldEndIdx)
                if (isUndef(idxInOld)) { // New element
                    createElm(newStartVnode, insertedVnodeQueue, parentElm, oldStartVnode.elm, false, newCh, newStartIdx)
                } else {
                    vnodeToMove = oldCh[idxInOld]
                    if (sameVnode(vnodeToMove, newStartVnode)) {
                        patchVnode(vnodeToMove, newStartVnode, insertedVnodeQueue, newCh, newStartIdx)
                        oldCh[idxInOld] = undefined
                        canMove && nodeOps.insertBefore(parentElm, vnodeToMove.elm, oldStartVnode.elm)
                    } else {
                        // same key but different element. treat as new element
                        createElm(newStartVnode, insertedVnodeQueue, parentElm, oldStartVnode.elm, false, newCh, newStartIdx)
                    }
                }
                newStartVnode = newCh[++newStartIdx]
            }
        }
        ...
    }

## 参考文献 ##

*  https://juejin.cn/post/6844903826693029895
 *  https://juejin.cn/post/6844903985397104648
 *  https://vue3js.cn/docs/zh

面试官VUE系列总进度：17／33

[面试官：Vue实例挂载的过程中发生了什么?][Vue]

[面试官：Vue中的$nextTick怎么理解?][Vue_nextTick]

[面试官：说说你对vue的mixin的理解，有哪些应用场景？][vue_mixin]

[面试官：说说你对slot的理解？slot使用场景有哪些？][slot_slot]

[面试官：说说对observable的理解][observable]

篇副有限，扫下方二维码查看往期

![format_png 2][]

[format_png]: /images/20221120/3d4b1dd443b146579a61aa342f4eb3b2.png
[format_png 1]: /images/20221120/ef16f6b276fc4f40ab89ce86ce8d30c8.png
[Vue]: http://mp.weixin.qq.com/s?__biz=MzU1OTgxNDQ1Nw%3D%3D&chksm=fc10c1e5cb6748f3511e98045534c4631c86b13c5f2f6de0290ba7b992913127070090a02e7b&idx=1&mid=2247484339&scene=21&sn=4ce6450e946dc44230ab99934396db10#wechat_redirect
[Vue_nextTick]: http://mp.weixin.qq.com/s?__biz=MzU1OTgxNDQ1Nw%3D%3D&chksm=fc10c19ecb674888b80b27c2b7e8bde37c81150ba417613037d7811ffd1cdd33610f63686892&idx=1&mid=2247484360&scene=21&sn=d505ec934b88d7108cac139b3b047024#wechat_redirect
[vue_mixin]: http://mp.weixin.qq.com/s?__biz=MzU1OTgxNDQ1Nw%3D%3D&chksm=fc10c18dcb67489bcc89f4ba25b2ac35fd6e589b8ab40e2118ba043554ad2cc4053ab2dd3b92&idx=1&mid=2247484379&scene=21&sn=d50794bbaa957339a92b7e4b58acd5e8#wechat_redirect
[slot_slot]: http://mp.weixin.qq.com/s?__biz=MzU1OTgxNDQ1Nw%3D%3D&chksm=fc10c1a7cb6748b1b4b1df7782e30301e55b9d4d5331e4b39124cdc869d47db5a28d5194b162&idx=1&mid=2247484401&scene=21&sn=ca97df335499c6b930ee2b5172524234#wechat_redirect
[observable]: http://mp.weixin.qq.com/s?__biz=MzU1OTgxNDQ1Nw%3D%3D&chksm=fc10c1a8cb6748be745c18710a9e5895b0d5885e938e00106da13ed9d77a1b9bc5866d8a6472&idx=1&mid=2247484414&scene=21&sn=a62897b3506dc7082ef3b4c9cb817e7b#wechat_redirect
[format_png 2]: /images/20221120/cf6c6cba496d4e92a308070ae5b56638.png