VUE源码学习第十三篇-patch(dom更新)

短命女 2022-01-08 02:38 283阅读 0赞

# 一、总述 #

前一章节，我们讲解了diff算法的原理，本章节一起看下vue如何通过该算法实现patch过程。

还记得在第六篇我们在讲到vm.\_update时，它负责将Vnode转化为真实的dom，包含两个分支过程，dom的首次渲染，以及后续的dom的更新。

Vue.prototype._update = function (vnode: VNode, hydrating?: boolean) {
        ...
        if (!prevVnode) {
          // initial render
          vm.$el = vm.__patch__(vm.$el, vnode, hydrating, false /* removeOnly */)
        } else {
          // updates
          vm.$el = vm.__patch__(prevVnode, vnode)
        }
        ...
      }

在第六篇，我们已经学习了首先dom渲染的过程。本章我们继续第二个分支流程。

# 二、patch #

我们用下面的dom更新的例子，结合源码来分析。

<div id="app">
        <button v-on:click="changeMsg">设置</button>
      <ul>
        <li v-for="item in items" :id="item.id">
        </li>
      </ul>
    </div>
    
    
    var vm = new Vue({
        el:"#app",
        data:{
          msg:'this is msg',
          items:[
          {id:1},
          {id:2},
          {id:3}
          ],
       methods:{
        changeMsg(){
          this.items.push({id:4});
        }
      }
    })

这个例子比较简单，dom渲染完成后如下：

![20190716180825439.png][]

当点击"设置"按钮，数组追加一列。由前面的知识可知，items属性值发生变化，会触发其相关的订阅watcher对象更新。因为该属性在模板中使用，则会触发render wacher的更新，执行vm.\_render(),生产新的vnode。 vm.$el = vm.\_\_patch\_\_(prevVnode, vnode)，通过新旧vnode的比较，实现真实dom的更新。最终渲染如下：

![20190716181723910.png][]

整个过程就是li节点增加了一个，其他的保持不变。我们期望在实际dom更新中，也只是新增一个li节点，而不是全局刷新，这样效率是最高的。

vm.\_\_patch\_\_(prevVnode, vnode)方法最终是在src/core/vdom/patch.js中定义。

return function patch (oldVnode, vnode, hydrating, removeOnly) {
        ....
         //1、oldVnode为空(首次渲染，或者组件)，直接创建新的root element
        if (isUndef(oldVnode)) {//
          // empty mount (likely as component), create new root element
          isInitialPatch = true
          createElm(vnode, insertedVnodeQueue)
        } else {
          //2、oldVnode存在，进入patchVnode过程
          const isRealElement = isDef(oldVnode.nodeType)//oldVnode是id为app的dom节点
          if (!isRealElement && sameVnode(oldVnode, vnode)) {
            // patch existing root node
            patchVnode(oldVnode, vnode, insertedVnodeQueue, removeOnly)
          } else {
            ......
            //3、创建节点
            createElm(
              vnode,
              insertedVnodeQueue,
              // extremely rare edge case: do not insert if old element is in a
              // leaving transition. Only happens when combining transition +
              // keep-alive + HOCs. (#4590)
              oldElm._leaveCb ? null : parentElm,
              nodeOps.nextSibling(oldElm)
            )
           ...
      }

进入patchVnode过程，我们直接看第二步，首先判断isRealElement ，以及sameVnode。isRealElement表示是否为实际的dom节点，再来看下sameVnode方法。

function sameVnode (a, b) {
      return (
        a.key === b.key && (//key相同，undefined也算相同
          (
            a.tag === b.tag &&//tag相同
            a.isComment === b.isComment &&//是否是comment
            isDef(a.data) === isDef(b.data) &&//data，属性已定义
            sameInputType(a, b)//input相同
          ) || (
            isTrue(a.isAsyncPlaceholder) &&
            a.asyncFactory === b.asyncFactory &&
            isUndef(b.asyncFactory.error)
          )
        )
      )
    }

sameVnode实际是描述的两个节点的可比性，它需要满足(后面的或条件暂时忽略)，

(1)key相同，undefined也算相同。

(2)tag相同，比如div，ul

(3)data属性，是否有属性定义要保持一致。比如li节点上的id属性。(注意：并不需要data属性相同)

(4)input类型。type类型相同，data是否定义要保持一致。

也就说满足以上条件，才有资格进行节点间的patch，继续子节点的比较，否则就直接走else分支，创建并插入全新节点。

这里我们聊一聊key，我们在开发的过程中，我们在使用v-for，input等标签时，需要加上一个key，表示唯一性标识，否则会发现元素之间"串",得不到我们预期的效果。本例中，我们没有加上key，key为undefined，所以判断可比性，只采用了后面的条件，对于id="1"的li节点，采用了"就地复用"。有时，我们并不想这样，我们只需要将这两个元素的key设置不同，那这两个元素可比性比较通不过，就会重新创建元素节点。

本例中的根节点div是满足这个条件的，所以进入patchVnode过程。

function patchVnode (oldVnode, vnode, insertedVnodeQueue, removeOnly) {
       ...
    
        // 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.
        //1、对于static节点树，无需比较，直接节点复用
        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)
        }
        
        //获取oldVnode，Vnode的子节点，进行比较
        const oldCh = oldVnode.children
        const ch = vnode.children
        //2、更新当前节点，执行update相关方法
        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)
        }
        //3、比较子节点
        if (isUndef(vnode.text)) {//3.1 非text节点叶节点
          if (isDef(oldCh) && isDef(ch)) {//新，旧子节点存在
            if (oldCh !== ch) updateChildren(elm, oldCh, ch, insertedVnodeQueue, removeOnly)
          } else if (isDef(ch)) {//新子节点存在，旧子节点不村子，添加新节点
            if (isDef(oldVnode.text)) nodeOps.setTextContent(elm, '')
            addVnodes(elm, null, ch, 0, ch.length - 1, insertedVnodeQueue)
          } else if (isDef(oldCh)) {//旧子节点存在，新子节点不存在，删除旧节点
            removeVnodes(elm, oldCh, 0, oldCh.length - 1)
          } else if (isDef(oldVnode.text)) {//旧节点的为text节点，则设置为空
            nodeOps.setTextContent(elm, '')
          }
        } else if (oldVnode.text !== vnode.text) {//3.2 text叶节点，但是text不同，直接更新
          nodeOps.setTextContent(elm, vnode.text)
        }
        if (isDef(data)) {
          if (isDef(i = data.hook) && isDef(i = i.postpatch)) i(oldVnode, vnode)
        }
      }

patchVnode核心流程分为三部分。

1、判断是否是static，在编译的章节，我们介绍了什么是静态节点，为了提高patch效率，对于静态节点，直接进行元素复用。

2、更新当前节点，执行相关的update方法。这些方法如下,主要是更新data属性中定义的内容。(sameVnode不要求data属性相同的原因)

updateAttrs(oldVnode, vnode)  
updateClass(oldVnode, vnode)  
updateDOMListeners(oldVnode, vnode)  
updateDOMProps(oldVnode, vnode)  
updateStyle(oldVnode, vnode)  
update(oldVnode, vnode)  
updateDirectives(oldVnode, vnode)

3、比较子节点。

(1)对于非text叶节点，继续子节点比较。新旧子节点存在，则调用updateChildren继续比较；新子节点存在，旧子节点不存在，则说明该子节点是新增，调用addVnodes创建；新子节点不存在，旧子节点存在，说明该子节点是多余的，调用removeVnodes删除该节点。

(2)对于text叶节点，如果text内容不同，则直接更新。

本例中ul元素的子节点，新旧节点都存在li子节点。所以进入updateChildren方法。

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)) {// os没有定义，os索引向后移动一位
            oldStartVnode = oldCh[++oldStartIdx] 
          } else if (isUndef(oldEndVnode)) {//oe没有定义，oe索引向前移动一位
            oldEndVnode = oldCh[--oldEndIdx]
          } else if (sameVnode(oldStartVnode, newStartVnode)) {//os==ns，保持节点位置不变，继续比较其子节点，os,ns索引向后移动一位
            patchVnode(oldStartVnode, newStartVnode, insertedVnodeQueue)
            oldStartVnode = oldCh[++oldStartIdx]
            newStartVnode = newCh[++newStartIdx]
          } else if (sameVnode(oldEndVnode, newEndVnode)) {//oe==ne，保持节点位置不变，继续比较其子节点，oe，ne索引向后前移动一位。
            patchVnode(oldEndVnode, newEndVnode, insertedVnodeQueue)
            oldEndVnode = oldCh[--oldEndIdx]
            newEndVnode = newCh[--newEndIdx]
          } else if (sameVnode(oldStartVnode, newEndVnode)) { // os==ne，将os节点移动到oe后面，继续比较其子节点，os索引向后移动一位，ne索引向前移动一位
            patchVnode(oldStartVnode, newEndVnode, insertedVnodeQueue)
            canMove && nodeOps.insertBefore(parentElm, oldStartVnode.elm, nodeOps.nextSibling(oldEndVnode.elm))
            oldStartVnode = oldCh[++oldStartIdx]
            newEndVnode = newCh[--newEndIdx]
          } else if (sameVnode(oldEndVnode, newStartVnode)) { // oe==ns，将oe移动到os节点前，继续比较其子节点，oe索引向后移动一位，ns向前移动一位。
            patchVnode(oldEndVnode, newStartVnode, insertedVnodeQueue)
            canMove && nodeOps.insertBefore(parentElm, oldEndVnode.elm, oldStartVnode.elm)
            oldEndVnode = oldCh[--oldEndIdx]
            newStartVnode = newCh[++newStartIdx]
          } else {//两组都不相同的情况下
            if (isUndef(oldKeyToIdx)) oldKeyToIdx = createKeyToOldIdx(oldCh, oldStartIdx, oldEndIdx)
            //在oldstartIdx与oldEndIdx间，查找与newStartVnode相同(key相同，或者节点元素相同)节点索引位置
            idxInOld = isDef(newStartVnode.key)
              ? oldKeyToIdx[newStartVnode.key]
              : findIdxInOld(newStartVnode, oldCh, oldStartIdx, oldEndIdx)
            if (isUndef(idxInOld)) { // New element
              //没有相同节点，则将newStartVnode插入到oldStartVnode前
              createElm(newStartVnode, insertedVnodeQueue, parentElm, oldStartVnode.elm, false, newCh, newStartIdx)
            } else {
              vnodeToMove = oldCh[idxInOld]
              //key值和节点都都相同
              if (sameVnode(vnodeToMove, newStartVnode)) {
                patchVnode(vnodeToMove, newStartVnode, insertedVnodeQueue)
                oldCh[idxInOld] = undefined
                //移动到oldStartVnode前
                canMove && nodeOps.insertBefore(parentElm, vnodeToMove.elm, oldStartVnode.elm)
              } else {
                // same key but different element. treat as new element
                //相同的key，但节点元素不同，创建一个新的newStartVnode节点，插入到oldStartVnode前。
                createElm(newStartVnode, insertedVnodeQueue, parentElm, oldStartVnode.elm, false, newCh, newStartIdx)
              }
            }
            //newStartVnode索引加1
            newStartVnode = newCh[++newStartIdx]
          }
        }
        if (oldStartIdx > oldEndIdx) {//旧节点先遍历完，新增剩余的新节点，并插入到ne+1前位置
          refElm = isUndef(newCh[newEndIdx + 1]) ? null : newCh[newEndIdx + 1].elm
          addVnodes(parentElm, refElm, newCh, newStartIdx, newEndIdx, insertedVnodeQueue)
        } else if (newStartIdx > newEndIdx) {//新节店先遍历完，删除剩余的老节点
          removeVnodes(parentElm, oldCh, oldStartIdx, oldEndIdx)
        }
      }

updateChildren方法就是对diff方法的实现，可以对照前一章节的图解进行代码阅读。

初始化新旧节点的开始，结束索引。分别用os(oldStartIdx)，oe(oldEndIdx),ns(newStartIdx),ne(newEndIdx)表示。

(1)os没有定义，os索引向后移动一位。

(2)oe没有定义，oe索引向前移动一位。

(3)os==ns，保持节点位置不变，继续比较其子节点，os,ns索引向后移动一位。

(4)oe==ne，保持节点位置不变，继续比较其子节点，oe，ne索引向后前移动一位。

(5)os==ne，继续比较其子节点，将os节点移动到oe后面，os索引向后移动一位，ne索引向前移动一位。

(6)oe==ns，继续比较其子节点，将oe移动到os节点前，oe索引向后移动一位，ns向前移动一位。

(7)两组都不相同的情况下,在os与oe间，查找与newStartVnode相同(key相同，或者节点元素相同)的节点，如果节点不存在，则创建一个新节点，并插入到os前；如果节点存在，则将该节点移动到os前。ns索引向后移动一位。

(8)旧节点先遍历完，新增剩余的新节点，并插入到ne+1前位置。

(9)新节点先遍历完，删除剩余的老节点。

本例中li节点，新旧节点中前三个都相同，增加了最后一个，所以执行的第8种情况，符合我们的期望。

其中3,4,5,6情况下，调用patchVnode更新节点，并继续比较子节点，直至到叶节点。

# 三、总结 #

整个过程，就是通过新旧Vnode的对比，以及diff算法，映射成实际的dom操作。

[20190716180825439.png]: /images/20211220/26968db1921c4c858c594ed48e3cf209.png
[20190716181723910.png]: /images/20211220/c933fabf7c094aaabed991ff9516a4d4.png