Vue2 的 diff 算法規則原理詳解

  // diff 的過程
  // 分析當前兩個節點的類型
  // 如果是元素，更新雙方屬性、特性等，同時比較雙方子元素，這個遞歸過程，叫深度優先
  // 如果雙方是文本，更新文本
  function patchVnode (
    oldVnode,
    vnode,
    insertedVnodeQueue,
    ownerArray,
    index,
    removeOnly
  ) {
    if (oldVnode === vnode) {
      return
    }
    // 靜態節點處理
    // 判斷新舊兩個虛擬節點是否是靜態節點，如果是，就不需要進行更新操作，可以直接跳過更新比對的過程
    if (isTrue(vnode.isStatic) &&
      isTrue(oldVnode.isStatic) &&
      vnode.key === oldVnode.key &&
      (isTrue(vnode.isCloned) || isTrue(vnode.isOnce))
    ) {
      vnode.componentInstance = oldVnode.componentInstance
      return
    }
    
    // 獲取雙方孩子
    const oldCh = oldVnode.children
    const ch = vnode.children
    // 比較雙方屬性
    // Vue2在更新元素屬性的時候，是暴力全量 diff 更新的。Vue3 則做瞭很多優化。
    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)) {
        // 雙方都有子元素,就進行重排，傳說中的 diff 就發生在這裡
        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)
    }
  }

// 傳說中的 diff 發生的地方
  function updateChildren (parentElm, oldCh, newCh, insertedVnodeQueue, removeOnly) {
    // 4個遊標和對應節點
    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

    const canMove = !removeOnly

    // 循環條件是遊標不能交叉，交叉就結束
    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(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)
        // 進行節點移動
        // node.insertBefore(newnode,existingnode) 1.newnode 必需。需要插入的節點對象  2.existingnode 可選。在其之前插入新節點的子節點。如果未規定，則 insertBefore 方法會在結尾插入 newnode。
        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 {
        // 首尾沒找到
        // 第一次創建一個老的節點的索引 Map，方便後續不需要遍歷查找，這是一個空間換時間的方法
        if (isUndef(oldKeyToIdx)) oldKeyToIdx = createKeyToOldIdx(oldCh, oldStartIdx, oldEndIdx)
        // 拿新虛擬DOM開頭的第一個節點，去老的虛擬DOM中進行查找
        // 如果我們在模版渲染列表時，為節點設置瞭屬性 key，那麼在上面建立的 key 與 index 索引的對應關系時，就生成瞭一個 key 對應著一個節點下標這樣一個對象。
        // 也就是說，如果在節點上設置瞭屬性 key，那麼在老的虛擬DOM中找相同節點時，可以直接通過 key 拿到下標，從而獲取節點，否則我們就需要每一次都要進行遍歷查找。
        // 所以非常推薦在渲染列表時為節點設置 key，最好是後端返回的唯一 ID。
        idxInOld = isDef(newStartVnode.key)
          ? oldKeyToIdx[newStartVnode.key]
          : findIdxInOld(newStartVnode, oldCh, oldStartIdx, oldEndIdx)
        if (isUndef(idxInOld)) { // New element
          // 沒找到就進行創建，並且插入到未處理的節點（oldStartVnode.elm）的前面
          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) {
      // 老的先結束，判斷新的虛擬DOM中是否還有剩下的節點，批量創建
      refElm = isUndef(newCh[newEndIdx + 1]) ? null : newCh[newEndIdx + 1].elm
      addVnodes(parentElm, refElm, newCh, newStartIdx, newEndIdx, insertedVnodeQueue)
    } else if (newStartIdx > newEndIdx) {
      // 新的先結束，判斷老的虛擬DOM中是否還剩下，批量刪除
      removeVnodes(oldCh, oldStartIdx, oldEndIdx)
    }
  }