vue中key的作用与工作原理

jason_yang
618 阅读2分钟

1.例子

<!DOCTYPE html> 
<html> 
<head> 
    <title>vue中key的作用与工作原理</title> 
 </head> 
<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') 
                }, 3000); 
            },
        }); 
    </script> 
</body> 
</html>

2.需要实现的效果

在位置C前面插入F元素 image.png

3.源码分析

注意path过程主要是为了减少dom操作，而减少dom操作的核心是找到一个完全没有变化的同一个节点。
patchVnode的方法无论是不用key的节点，还是相同key的同一个节点都会触发。
区别在于一般web网站，相同key的节点都不会有大变化，只有小部分会变更，从而减少执行实际的dom操作。

path -> pathVnode -> updateChildren -> sameVnode()方法 -> pathVnode

 //对比所有子节点
  function updateChildren (parentElm, oldCh, newCh, insertedVnodeQueue, removeOnly) {
    let oldStartIdx = 0
    let newStartIdx = 0
    let oldEndIdx = oldCh.length - 1
    let oldStartVnode = oldCh[0]
    let oldEndVnode = oldCh[oldEndIdx]
    let newEndIdx = newCh.length - 1
    let newStartVnode = newCh[0]
    let newEndVnode = newCh[newEndIdx]
    let oldKeyToIdx, idxInOld, vnodeToMove, refElm

    // removeOnly is a special flag used only by <transition-group>
    // to ensure removed elements stay in correct relative positions
    // during leaving transitions
    const canMove = !removeOnly

    if (process.env.NODE_ENV !== 'production') {
      checkDuplicateKeys(newCh)
    }

    while (oldStartIdx <= oldEndIdx && newStartIdx <= newEndIdx) {
      if (isUndef(oldStartVnode)) {
        oldStartVnode = oldCh[++oldStartIdx] // Vnode has been moved left
      } else if (isUndef(oldEndVnode)) {
        oldEndVnode = oldCh[--oldEndIdx]
      } else if (sameVnode(oldStartVnode, newStartVnode)) {//这里判断是否是相同的节点，如果是则 patchVnode 更新节点，
        patchVnode(oldStartVnode, newStartVnode, insertedVnodeQueue, newCh, newStartIdx)
        oldStartVnode = oldCh[++oldStartIdx]
        newStartVnode = newCh[++newStartIdx]
      } else if (sameVnode(oldEndVnode, newEndVnode)) {
        patchVnode(oldEndVnode, newEndVnode, insertedVnodeQueue, newCh, newEndIdx)
        oldEndVnode = oldCh[--oldEndIdx]
        newEndVnode = newCh[--newEndIdx]
      } else if (sameVnode(oldStartVnode, newEndVnode)) { // Vnode moved right
        patchVnode(oldStartVnode, newEndVnode, insertedVnodeQueue, newCh, newEndIdx)
        canMove && nodeOps.insertBefore(parentElm, oldStartVnode.elm, nodeOps.nextSibling(oldEndVnode.elm))
        oldStartVnode = oldCh[++oldStartIdx]
        newEndVnode = newCh[--newEndIdx]
      } else if (sameVnode(oldEndVnode, newStartVnode)) { // Vnode moved left
        patchVnode(oldEndVnode, newStartVnode, insertedVnodeQueue, newCh, newStartIdx)
        canMove && nodeOps.insertBefore(parentElm, oldEndVnode.elm, oldStartVnode.elm)
        oldEndVnode = oldCh[--oldEndIdx]
        newStartVnode = newCh[++newStartIdx]
      } 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]
      }
    }
    if (oldStartIdx > oldEndIdx) {
      refElm = isUndef(newCh[newEndIdx + 1]) ? null : newCh[newEndIdx + 1].elm
      addVnodes(parentElm, refElm, newCh, newStartIdx, newEndIdx, insertedVnodeQueue)
    } else if (newStartIdx > newEndIdx) {
      removeVnodes(oldCh, oldStartIdx, oldEndIdx)
    }
  }
  
 //比较是否为同一个节点的方法，由于
function sameVnode (a, b) {
  return (
    a.key === b.key && ( //这里如果没有定义key 默认是undifined 所以满足条件
      (
        a.tag === b.tag && 是否是同一种标签
        a.isComment === b.isComment && //是否同时 是/不是 一个空节点
        isDef(a.data) === isDef(b.data) && //对应的所有节点的data 是否同时声明 或者不声明
        sameInputType(a, b)//是否是相同的输入类型
      ) || (
        isTrue(a.isAsyncPlaceholder) &&
        a.asyncFactory === b.asyncFactory &&
        isUndef(b.asyncFactory.error)
      )
    )
  )
}
  
  //更新节点
  function patchVnode (
    oldVnode,
    vnode,
    insertedVnodeQueue,
    ownerArray,
    index,
    removeOnly
  ) {
    if (oldVnode === vnode) {
      return
    }

    if (isDef(vnode.elm) && isDef(ownerArray)) {
      // clone reused vnode
      vnode = ownerArray[index] = cloneVNode(vnode)
    }

    const elm = vnode.elm = oldVnode.elm

    if (isTrue(oldVnode.isAsyncPlaceholder)) {
      if (isDef(vnode.asyncFactory.resolved)) {
        hydrate(oldVnode.elm, vnode, insertedVnodeQueue)
      } else {
        vnode.isAsyncPlaceholder = true
      }
      return
    }

    // reuse element for static trees.
    // note we only do this if the vnode is cloned -
    // if the new node is not cloned it means the render functions have been
    // reset by the hot-reload-api and we need to do a proper re-render.
    if (isTrue(vnode.isStatic) &&
      isTrue(oldVnode.isStatic) &&
      vnode.key === oldVnode.key &&
      (isTrue(vnode.isCloned) || isTrue(vnode.isOnce))
    ) {
      vnode.componentInstance = oldVnode.componentInstance
      return
    }

    let i
    const data = vnode.data
    if (isDef(data) && isDef(i = data.hook) && isDef(i = i.prepatch)) {
      i(oldVnode, vnode)
    }

    const oldCh = oldVnode.children
    const ch = vnode.children
    if (isDef(data) && isPatchable(vnode)) {
      for (i = 0; i < cbs.update.length; ++i) cbs.update[i](oldVnode, vnode)
      if (isDef(i = data.hook) && isDef(i = i.update)) i(oldVnode, vnode)
    }
    if (isUndef(vnode.text)) {
      if (isDef(oldCh) && isDef(ch)) {
        if (oldCh !== ch) updateChildren(elm, oldCh, ch, insertedVnodeQueue, removeOnly)
      } else if (isDef(ch)) {
        if (process.env.NODE_ENV !== 'production') {
          checkDuplicateKeys(ch)
        }
        if (isDef(oldVnode.text)) nodeOps.setTextContent(elm, '')
        addVnodes(elm, null, ch, 0, ch.length - 1, insertedVnodeQueue)
      } else if (isDef(oldCh)) {
        removeVnodes(oldCh, 0, oldCh.length - 1)
      } else if (isDef(oldVnode.text)) {
        nodeOps.setTextContent(elm, '')
      }
    } else if (oldVnode.text !== vnode.text) {
      nodeOps.setTextContent(elm, vnode.text)
    }
    if (isDef(data)) {
      if (isDef(i = data.hook) && isDef(i = i.postpatch)) i(oldVnode, vnode)
    }
  }

判断逻辑顺序

  1. sameVnode(oldStartVnode, newStartVnode) 两头比较
  2. sameVnode(oldEndVnode, newEndVnode) 两尾比较
  3. sameVnode(oldStartVnode, newEndVnode) 老头+新尾比较
  4. sameVnode(oldEndVnode, newStartVnode) 老尾+新头比较

3.1不使用key

  • 在使用updateChildren同层比较所有子节点时，使用sameVnode判断是否为同一节点。
  • 由于key没有定义，默认为undefined，所以a.key === b.key 为true，往下执行pathVnode更新节点操作。
  • 所以sameVnode(oldStartVnode, newStartVnode) 两头比较永远优先成立

  1. A 和 A 两头比较, 成立更新，由于完全没有变化不做dom操作

  2. B 和 B 两头比较, 成立更新 ，由于完全没有变化不做dom操作

  3. F 更新 C 两头比较, 成立更新，由于数据变化，更新dom

  4. C 更新 D 两头比较, 成立更新，由于数据变化，更新dom

  5. D 更新 E 两头比较, 成立更新，由于数据变化，更新dom

  6. 创建E 插入到 最新D的后面

      结果： 执行了3次dom更新和一次创建插入

image.png

3.2使用key

  • 在使用updateChildren同层比较所有子节点时，使用sameVnode判断是否为同一节点。
  • 由于key定义了，所以a.key === b.key 为不一定一样，会依次执行 两头比较,两尾比较, 老头+新尾比较,老尾+新头比较的比较。

  1. A 和 A 两头比较, 成立更新，由于完全没有变化不做dom操作

  2. B 和 B 两头比较, 成立更新 ，由于完全没有变化不做dom操作

  3. C 和 F 两头比较, 不成立，继续比较

  4. F 和 F 两个结尾判断 成立 ，由于完全没有变化不做dom操作

  5. C 和 F 两头比较, 不成立，继续比较

  6. E 和 E 两个结尾判断 成立 ，由于完全没有变化不做dom操作

  7. C 和 F 两头比较, 不成立，继续比较

  8. D 和 D 两个结尾判断 成立 ，由于完全没有变化不做dom操作

  9. C 和 F 两头比较, 不成立，继续比较

  10. C 和 C 两个结尾判断 成立 ，由于完全没有变化不做dom操作

  11. 剩下F，创建F dom，并插入在C的位置的前面

    结果：只执行了一次dom的创建和插入

image.png

// 第1次环patch A ->  
A B C D E 
A B F C D E 
// 第2次循环patch B ->  
B C D E 
B F C D E 
// 第3次循环patch E ->  
C D E 
F C D E 
// 第4次循环patch D ->  
C D 
F C D 
// 第5次循环patch C ->  
C  
F C 
// oldCh全部处理结束，newCh中剩下的F，创建F并插入到C前面

4.总结

  1. key的作用是为了提高在做path时候，能够准确判断新旧节点是不是同一个节点，从而避免频繁更新了不一样的节点。使得更新的过程更加准确，减少更多的dom操作，减少整个path的时间，提高的性能。
  2. 由于不用key，path会认定是相同节点，更新的时候是按顺序执行，可能会导致一些与预期不相符的效果。
avatar
文章
阅读
粉丝