Vue2.x源码系列08Diff算法原理
Posted 柏成
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Vue2.x源码系列08Diff算法原理相关的知识,希望对你有一定的参考价值。
什么是虚拟DOM
DOM是很慢的,其元素非常庞大,当我们频繁的去做 DOM更新,会产生一定的性能问题,我们可以直观感受一下 div元素包含的海量属性
在Javascript对象中,虚拟DOM
表现为一个 Object对象(以VNode 节点作为基础的树)。并且最少包含标签名tag
、属性attrs
和子元素对象children
三个属性,不同框架对这三个属性的名命可能会有差别。
<ul >
<li key="a">a</li>
<li key="b">b</li>
<li key="c">c</li>
</ul>
真实节点对应的虚拟DOM:
const VDOM =
tag: \'ul\',
data:
style: color: \'#de5e60\', border: \'1px solid #de5e60\' ,
,
children: [
tag: \'li\',
key: \'a\',
data: ,
children: [ text: \'a\' ],
,
tag: \'li\',
key: \'b\',
data: ,
children: [ text: \'b\'],
,
tag: \'li\',
key: \'c\',
data: ,
children: [ text: \'c\'],
,
],
我们常说虚拟DOM可以提升效率。这句话是不严谨的❌
通过虚拟DOM
改变真正的 DOM并不比直接操作 DOM效率更高。恰恰相反,我们仍需要调用DOM API
去操作 DOM,并且虚拟DOM
还会额外占用内存!
but!!!我们可以通过 虚拟DOM
+ diff算法
,找到需要更新的最小单位,最大限度地减少DOM操作,从而提升性能。
什么是Diff
Dom 是多叉树结构,完整对比两棵树的差异,时间复杂度是O(n³)
,这个复杂度会导致比对性能很差!
为了优化,Diff 算法约定只做同层级节点比对,而不是跨层级节点比对,即深度优先遍历算法,其复杂度为O(n)
Diff原理
当数据修改后会触发setter
劫持操作,我们在setter
中执行dep.notity()
,通知所有的订阅者watcher
重新渲染。
订阅者watcher
这时会在回调内部,通过vm._render()
获取最新的虚拟DOM
;然后通过patch
方法比对新旧虚拟DOM
,给真实元素打补丁,更新视图
createElm
利用vnode
创建真实元素,有一个巧妙的地方是,我们把真实元素挂载到了vnode
上,便于我们后续通过虚拟节点去操作对应的真实元素
export function createElm(vnode)
let tag, data, children, text = vnode
// 标签
if (typeof tag === \'string\')
// 将真实节点挂载到虚拟节点上
vnode.el = document.createElement(tag)
patchProps(vnode.el, , data)
children.forEach(child =>
vnode.el.appendChild(createElm(child))
)
else
// 文本
vnode.el = document.createTextNode(text)
return vnode.el
sameVnode
判断是否是相同节点,节点的tag和节点的key都相同
export function isSameVnode(vnode1, vnode2)
return vnode1.tag === vnode2.tag && vnode1.key === vnode2.key
patch
patch方法有两大作用,一个是初始化元素 ,另一个是更新元素
export function patch(oldVNode, vnode)
const isRealElement = oldVNode.nodeType
// 初渲染元素
if (isRealElement)
const elm = oldVNode // 获取真实元素
const parentElm = elm.parentNode // 拿到父元素
let newElm = createElm(vnode) // 根据vnode创建元素
parentElm.insertBefore(newElm, elm.nextSibling) // 插入刚刚创建的元素
parentElm.removeChild(elm) // 删除旧节点
return newElm
else
// 更新元素
return patchVnode(oldVNode, vnode)
patchVnode
比对新旧虚拟节点打补丁,diff比对规则如下:
- 新旧节点不相同(判断节点的tag和节点的key),直接用新节点替换旧节点,无需比对
- 新旧节点相同,且都是文本节点,更新文本内容即可
- 新旧节点是同一个节点,比较两个节点的属性是否有差异,复用旧的节点,将差异的属性更新
- 节点比较完毕后,需要比较两个节点的儿子
- 新旧节点都有儿子,调用
updateChildren()
,这里是diff算法核心逻辑!后面会详细讲解 - 新节点有儿子,旧节点没有儿子,将新的子节点挂载到
oldVNode.el
上 - 旧节点有儿子,新节点没有儿子,删除
oldVNode.el
的所有子节点
- 新旧节点都有儿子,调用
function patchVnode(oldVNode, vnode)
// 1. 新旧节点不相同(判断节点的tag和节点的key),直接用新节点替换旧节点,无需比对
if (!isSameVnode(oldVNode, vnode))
let el = createElm(vnode)
oldVNode.el.parentNode.replaceChild(el, oldVNode.el)
return el
let el = (vnode.el = oldVNode.el)
// 2. 新旧节点相同,且是文本 (判断节点的tag和节点的key),比较文本内容
if (!oldVNode.tag)
if (oldVNode.text !== vnode.text)
el.textContent = vnode.text // 用新的文本覆盖掉旧的
// 3. 新旧节点相同,且是标签 (判断节点的tag和节点的key)
// 3.1 比较标签属性
patchProps(el, oldVNode.data, vnode.data)
let oldChildren = oldVNode.children || []
let newChildren = vnode.children || []
// 4 比较两个节点的儿子
// 4.1 新旧节点都有儿子
if (oldChildren.length > 0 && newChildren.length > 0)
// diff算法核心!!!
updateChildren(el, oldChildren, newChildren)
// 4.2 新节点有儿子,旧节点没有儿子,挂载
else if (newChildren.length > 0)
mountChildren(el, newChildren)
// 4.3 旧节点有儿子,新节点没有儿子,删除
else if (oldChildren.length > 0)
el.innerHTML = \'\'
updateChildren(Diff核心算法)
这个方法是diff比对的核心!
vue2中采用了头尾双指针的方式,通过头头、尾尾、头尾、尾头、乱序五种比对方式,进行新旧虚拟节点的依次比对
在比对过程中,我们需要四个指针,分别指向新旧列表的头部和尾部。为了方便我们理解,我使用了不同颜色和方向的箭头加以区分,图例如下:
双端比对
头头比对
旧孩子的头 比对 新孩子的头
如果是相同节点,则调用patchVnode
打补丁并递归比较子节点;然后将 新旧列表的头指针
都向后移动
终止条件:双方有一方头指针大于尾指针,则停止循环
if (isSameVnode(oldStartVnode, newStartVnode))
patchVnode(oldStartVnode, newStartVnode)
oldStartVnode = oldChildren[++oldStartIndex]
newStartVnode = newChildren[++newStartIndex]
尾尾比对
旧孩子的尾 和 新孩子的尾比较
如果是相同节点,则调用patchVnode
打补丁并递归比较子节点;然后将 新旧列表的尾指针
都向前移动
终止条件:双方有一方头指针大于尾指针,则停止循环
else if (isSameVnode(oldEndVnode, newEndVnode))
patchVnode(oldEndVnode, newEndVnode)
oldEndVnode = oldChildren[--oldEndIndex]
newEndVnode = newChildren[--newEndIndex]
头尾比对
旧孩子的头 和 新孩子的尾比较
如果是相同节点,则调用patchVnode
打补丁并递归比较子节点;然后将 oldStartVnode
移动到 oldEndVnode
的后面(把 旧列表头指针指向的节点
移动到 旧列表尾指针指向的节点
后面)
最后把 旧列表头指针
向后移动,新列表尾指针
向前移动
终止条件:双方有一方头指针大于尾指针,则停止循环
else if (isSameVnode(oldStartVnode, newEndVnode))
patchVnode(oldStartVnode, newEndVnode)
el.insertBefore(oldStartVnode.el, oldEndVnode.el.nextSibling)
oldStartVnode = oldChildren[++oldStartIndex]
newEndVnode = newChildren[--newEndIndex]
尾头比对
旧孩子的尾 和 新孩子的头比较
如果是相同节点,则调用patchVnode
打补丁并递归比较子节点;然后将 oldEndVnode
移动到 oldStartVnode
的前面(把 旧列表尾指针指向的节点
移动到 旧列表头指针指向的节点
前面)
最后把 旧列表尾指针
向前移动,新列表头指针
向后移动
终止条件:双方有一方头指针大于尾指针,则停止循环
else if (isSameVnode(oldEndVnode, newStartVnode))
patchVnode(oldEndVnode, newStartVnode)
el.insertBefore(oldEndVnode.el, oldStartVnode.el)
oldEndVnode = oldChildren[--oldEndIndex]
newStartVnode = newChildren[++newStartIndex]
乱序比对
每次比对时,优先进行头头、尾尾、头尾、尾头的比对尝试,如果都没有命中才会进行乱序比较
- 我们根据旧的列表创建一个
key -> index
的映射表,拿新的儿子去映射关系里查找。注意:查找时只能找得到key相同的老节点,并没判断tag - 若找的到相同key的老节点并且是相同节点,则复用节点移动到
oldStartVnode
(旧列表头指针指向的节点)的前面,然后调用patchVnode
打补丁递归比较子节点(移动走的老位置要做空标记,表示这个旧节点已经被移动过了,后续比对时可直接跳过此节点) - 否则,创建节点并移动到
oldStartVnode
(旧列表头指针指向的节点)的前面 - 只需将
新列表头指针
向后移动即可 - 最后删除老列表中多余的节点,此过程在下一章挂载卸载阶段删除掉
终止条件:双方有一方头指针大于尾指针,则停止循环
----------------- 创建映射关系 -----------------------
function makeIndexByKey(children)
let map =
children.forEach((child, index) =>
map[child.key] = index
)
return map
// 旧孩子映射表(key-index),用于乱序比对
let map = makeIndexByKey(oldChildren)
-------------------- 乱序比对 -------------------------
if (!oldStartVnode)
oldStartVnode = oldChildren[++oldStartIndex]
continue
if (!oldEndVnode)
oldEndVnode = oldChildren[--oldEndIndex]
continue
let moveIndex = map[newStartVnode.key]
// 找的到相同key的老节点,并且是相同节点
if (moveIndex !== undefined && isSameVnode(oldChildren[moveIndex], newStartVnode))
let moveVnode = oldChildren[moveIndex] // 复用旧的节点
el.insertBefore(moveVnode.el, oldStartVnode.el) // 将 moveVnode 移动到 oldStartVnode的前面(把复用节点 移动到 旧列表头指针指向的节点 前面)
oldChildren[moveIndex] = undefined // 表示这个旧节点已经被移动过了
patchVnode(moveVnode, newStartVnode) // 递归比较子节点
// 找不到相同key的老节点 or 找的到相同key的老节点但tag不相同
else
el.insertBefore(createElm(newStartVnode), oldStartVnode.el) // 将 创建的节点 移动到 oldStartVnode的前面(把创建的节点 移动到 旧列表头指针指向的节点 前面)
newStartVnode = newChildren[++newStartIndex]
挂载卸载
终止条件:双方有一方头指针大于尾指针,则停止循环。当循环比对结束后,我们需要将新列表中多余的节点插入到oldVNode.el
中,并将老列表中多余的节点删除掉。
我们将其划分为4种场景,可参考头头比对、尾尾比对章节的图辅助理解
- 同序列尾部挂载:
新列表头指针
到新列表尾指针
的节点需要挂载新增,向后追加 - 同序列头部挂载:
新列表头指针
到新列表尾指针
的节点需要挂载新增,向前追加 - 同序列尾部卸载:
旧列表头指针
到旧列表尾指针
的节点需要卸载删除 - 同序列头部卸载: 和 同序列尾部卸载 逻辑一致
tip:何时向后追加,何时向前追加,我们根据什么去判断的呢?
若 新列表尾指针指向的节点
的下一个节点存在,则向前追加,插入到newChildren[newEndIndex + 1].el
的前面;若不存在,则向后追加,插入到oldVNode.el
子节点列表的末尾处
// 同序列尾部挂载,向后追加
// a b c d
// a b c d e f
// 同序列头部挂载,向前追加
// a b c d
// e f a b c d
if (newStartIndex <= newEndIndex)
for (let i = newStartIndex; i <= newEndIndex; i++)
let childEl = createElm(newChildren[i])
// 这里可能是向后追加 ,也可能是向前追加
let anchor = newChildren[newEndIndex + 1] ? newChildren[newEndIndex + 1].el : null
el.insertBefore(childEl, anchor) // anchor为null的时候等同于 appendChild
// 同序列尾部卸载,删除尾部多余的旧孩子
// a b c d e f
// a b c d
// 同序列头部卸载,删除头部多余的旧孩子
// e f a b c d
// a b c d
if (oldStartIndex <= oldEndIndex)
for (let i = oldStartIndex; i <= oldEndIndex; i++)
if (oldChildren[i])
let childEl = oldChildren[i].el
el.removeChild(childEl)
总结
vue2采用了头尾双指针的方法,每次比对时,优先进行头头、尾尾、头尾、尾头的比对尝试,如果都没有命中才会进行乱序比对
当比对命中时(新旧节点是相同的),则调用patchVnode
打补丁并递归比较子节点;打完补丁后呢,如果该节点是头指针指向的节点
就向后移动指针,是尾指针指向的节点
则向前移动指针
终止条件:双方有一方头指针大于尾指针,则停止循环
如果双端比对中的头尾、尾头命中了节点,也需要进行节点移动操作,为什么不直接用乱序比对呢,没理解其优势在哪?
但是双端diff
相比于简单diff
性能肯定会更好一些,例如:从 ABCD
到 DABC
。简单diff
需要移动 ABC 三个节点,但是双端diff
只需要移动 D 一个节点
关于简单diff的介绍可移步此文章 - 聊聊 Vue 的双端 diff 算法
tip:vue3中并没有头尾、尾头比对的概念;新增了最长递增子序列算法去优化乱序比对,减少了乱序比对中节点的移动次数
updateChildren 核心代码如下:
function updateChildren(el, oldChildren, newChildren)
let oldStartIndex = 0
let newStartIndex = 0
let oldEndIndex = oldChildren.length - 1
let newEndIndex = newChildren.length - 1
let oldStartVnode = oldChildren[0]
let newStartVnode = newChildren[0]
let oldEndVnode = oldChildren[oldEndIndex]
let newEndVnode = newChildren[newEndIndex]
function makeIndexByKey(children)
let map =
children.forEach((child, index) =>
map[child.key] = index
)
return map
// 旧孩子映射表(key-index),用于乱序比对
let map = makeIndexByKey(oldChildren)
// 双方有一方头指针大于尾部指针,则停止循环
while (oldStartIndex <= oldEndIndex && newStartIndex <= newEndIndex)
if (!oldStartVnode)
oldStartVnode = oldChildren[++oldStartIndex]
continue
if (!oldEndVnode)
oldEndVnode = oldChildren[--oldEndIndex]
continue
// 双端比较_1 - 旧孩子的头 比对 新孩子的头;
// 都从头部开始比对(对应场景:同序列尾部挂载-push、同序列尾部卸载-pop)
if (isSameVnode(oldStartVnode, newStartVnode))
patchVnode(oldStartVnode, newStartVnode) // 如果是相同节点,则打补丁,并递归比较子节点
oldStartVnode = oldChildren[++oldStartIndex]
newStartVnode = newChildren[++newStartIndex]
// 双端比较_2 - 旧孩子的尾 比对 新孩子的尾;
// 都从尾部开始比对(对应场景:同序列头部挂载-unshift、同序列头部卸载-shift)
else if (isSameVnode(oldEndVnode, newEndVnode))
patchVnode(oldEndVnode, newEndVnode) // 如果是相同节点,则打补丁,并递归比较子节点
oldEndVnode = oldChildren[--oldEndIndex]
newEndVnode = newChildren[--newEndIndex]
// 双端比较_3 - 旧孩子的头 比对 新孩子的尾;
// 旧孩子从头部开始,新孩子从尾部开始(对应场景:指针尽可能向内靠拢;极端场景-reverse)
else if (isSameVnode(oldStartVnode, newEndVnode))
patchVnode(oldStartVnode, newEndVnode)
el.insertBefore(oldStartVnode.el, oldEndVnode.el.nextSibling) // 将 oldStartVnode 移动到 oldEndVnode的后面(把当前节点 移动到 旧列表尾指针指向的节点 后面)
oldStartVnode = oldChildren[++oldStartIndex]
newEndVnode = newChildren[--newEndIndex]
// 双端比较_4 - 旧孩子的尾 比对 新孩子的头;
// 旧孩子从尾部开始,新孩子从头部开始(对应场景:指针尽可能向内靠拢;极端场景-reverse)
else if (isSameVnode(oldEndVnode, newStartVnode))
patchVnode(oldEndVnode, newStartVnode)
el.insertBefore(oldEndVnode.el, oldStartVnode.el) // 将 oldEndVnode 移动到 oldStartVnode的前面(把当前节点 移动到 旧列表头指针指向的节点 前面)
oldEndVnode = oldChildren[--oldEndIndex]
newStartVnode = newChildren[++newStartIndex]
// 乱序比对
// 根据旧的列表做一个映射关系,拿新的节点去找,找到则移动;找不到则添加;最后删除多余的旧节点
else
let moveIndex = map[newStartVnode.key]
// 找的到相同key的老节点,并且是相同节点
if (moveIndex !== undefined && isSameVnode(oldChildren[moveIndex], newStartVnode))
let moveVnode = oldChildren[moveIndex] // 复用旧的节点
el.insertBefore(moveVnode.el, oldStartVnode.el) // 将 moveVnode 移动到 oldStartVnode的前面(把复用节点 移动到 旧列表头指针指向的节点 前面)
oldChildren[moveIndex] = undefined // 表示这个旧节点已经被移动过了
patchVnode(moveVnode, newStartVnode) // 比对属性和子节点
// 找不到相同key的老节点 or 找的到相同key的老节点但tag不相同
else
el.insertBefore(createElm(newStartVnode), oldStartVnode.el) // 将 创建的节点 移动到 oldStartVnode的前面(把创建的节点 移动到 旧列表头指针指向的节点 前面)
newStartVnode = newChildren[++newStartIndex]
// 同序列尾部挂载,向后追加
// a b c d
// a b c d e f
// 同序列头部挂载,向前追加
// a b c d
// e f a b c d
if (newStartIndex <= newEndIndex)
for (let i = newStartIndex; i <= newEndIndex; i++)
let childEl = createElm(newChildren[i])
// 这里可能是向后追加 ,也可能是向前追加
let anchor = newChildren[newEndIndex + 1] ? newChildren[newEndIndex + 1].el : null // 获取下一个元素
// el.appendChild(childEl);
el.insertBefore(childEl, anchor) // anchor为null的时候等同于 appendChild
// 同序列尾部卸载,删除尾部多余的旧孩子
// a b c d e f
// a b c d
// 同序列头部卸载,删除头部多余的旧孩子
// e f a b c d
// a b c d
if (oldStartIndex <= oldEndIndex)
for (let i = oldStartIndex; i <= oldEndIndex; i++)
if (oldChildren[i])
let childEl = oldChildren[i].el
el.removeChild(childEl)
常见问题
为什么不建议key用索引
我们先看一段代码。其效果是:当点击按钮后,会在数组前面追加一项数据
/** template代码 */
<div id="app">
<ul class="ul-wrap">
<li v-for="(item,index) in arr" :key="index">
item.name <input type="checkbox">
</li>
</ul>
<button @click="append">追加</button>
</div>
/** js代码 */
let vm = new Vue(
el: \'#app\',
data()
return
arr: [ id: 0, name: \'柏成0号\' ,
id: 1, name: \'柏成1号\' ,
id: 2, name: \'柏成2号\' ]
,
methods:
append()
this.arr.unshift(
id: 7,
name: \'柏成7号\'
);
)
index作为key
使用index作为key时,运行结果如下:
我们会发现一个神奇的现象,虽然只unshift
了一条数据,但是所有的li标签
都更新了。并且新增的柏成7号节点
还复用了柏成0号节点
的checkbox多选框!!!
其原理就是,我们在进行头头比对时,前三项虽然可以匹配到相同节点(标签名和key都相同),但其内容并非一致,所以进行了打补丁更新操作。然后我们又创建一个key为3
的柏成2号节点
插入到列表尾部
id作为key
使用id作为key时,运行结果如下:
这次的diff更新就符合了我们的预期效果,它找到需要更新的最小单位,即只会新增key为3
的柏成7号节点
,最大限度地减少DOM操作
此时我们在进行尾尾比对时,后三项都可以匹配到相同节点(标签名和key都相同),而且会发现无需更新任何内容。然后去创建一个key为7
的柏成7号节点
插入列表头部,严格来说是插入新列表头指针下一个虚拟节点对应的真实元素newChildren[newEndIndex + 1].el
前面
参考文章
diff 算法深入一下?
聊聊 Vue 的双端 diff 算法
15张图,20分钟吃透Diff算法核心原理,我说的!!!
第三十篇 - diff 算法
Vue源码系列:DOM-Diff
前言
为了降低直接操作真实DOM带来的性能消耗。Vue内部引入了Vdom(虚拟DOM)。Vdom概念也比较简单,可以看成一个普通的JS对象,用来描述用户界面。而DOM-Diff的过程,简单来说,就是当有数据更新时,首先需要通过JS计算出Vdom的变化,然后再将变化更新到真实的用户界面。接下来,我们从源码出发,逐步分析。
_update
从「响应式原理」学习中,「了解了数据更新时重新执行render函数再次生成新的VNode的原理」。但是,真正完成视图界面的更新,还需要经过后续复杂的过程,而这个过程的入口从 vm.update()
开始。流程图如下:
观察上面流程图发现,update()
会将由 render()
生成的新VNode与旧VNode交给一个函数 patch
去处理。
另外,交给patch
处理之前,「update()」 会完成一些预处理,步骤如下:
-
缓存 「oldVNode」 到内存中 => const prevVnode = vm._vnode
-
更新 「vm._vnode」 => vm._vnode = vnode
-
判断 「oldVNode」 是否在: -
不存在:表明是组件第一次加载,通过 patch
函数,直接遍历 「newVNode」,为每个节点生成真实DOM,并挂载到每个节点的elm
属性上。 -
存在:表明此时为组件的更新操作,之前已经渲染过该组件。通过 patch
函数,对 「oldVNode」 和 「newVNode」进行对比,找出差异变化,最后完成真实DOM的最小化更新,并且保证 newVNode上每个节点对应着正确的真实DOM。
__patch__
patch
的作用:通过比较新旧VNode,找出差异变化,最后完成真实DOM的最小化更新,这个过程也就是Diff
过程。
「diff核心」
❝Diff算法的核心:「深度优先,同层比较。」
❞
我们带着上面的讲到的算法核心,一步步体会。下面重点学习下 具体的「diff」原理。
sameVnode(节点是否相同)
「diff」原理实际上就是「VNode」节点之间比较的过程。首先明确一个概念,两个「VNode」节点「相等」的条件:
-
「key」值相等 -
「tag」 (标签类型)相等 -
「input」元素的 「type」属性要相等
「判断节点是否相等」的详细逻辑如下。源码位置:core/vdom/patch.js
的 「sameVnode」 函数:
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)
)
)
)
}
patch (更新、删除、创建节点)
接下来,从 diff入口 - patch
函数开始分析。源码位置:/core/vdom/patch.js
。
function patch (oldVnode, vnode, hydrating, removeOnly) {
if (isUndef(vnode)) {
if (isDef(oldVnode)) invokeDestroyHook(oldVnode)
return
}
let isInitialPatch = false
const insertedVnodeQueue = []
if (isUndef(oldVnode)) {
// empty mount (likely as component), create new root element
isInitialPatch = true
createElm(vnode, insertedVnodeQueue)
} else {
const isRealElement = isDef(oldVnode.nodeType)
if (!isRealElement && sameVnode(oldVnode, vnode)) {
// patch existing root node
patchVnode(oldVnode, vnode, insertedVnodeQueue, null, null, removeOnly)
} else {
if (isRealElement) {
// mounting to a real element
// check if this is server-rendered content and if we can perform
// a successful hydration.
if (oldVnode.nodeType === 1 && oldVnode.hasAttribute(SSR_ATTR)) {
oldVnode.removeAttribute(SSR_ATTR)
hydrating = true
}
if (isTrue(hydrating)) {
if (hydrate(oldVnode, vnode, insertedVnodeQueue)) {
invokeInsertHook(vnode, insertedVnodeQueue, true)
return oldVnode
} else if (process.env.NODE_ENV !== 'production') {
warn(
'The client-side rendered virtual DOM tree is not matching ' +
'server-rendered content. This is likely caused by incorrect ' +
'HTML markup, for example nesting block-level elements inside ' +
'<p>, or missing <tbody>. Bailing hydration and performing ' +
'full client-side render.'
)
}
}
// either not server-rendered, or hydration failed.
// create an empty node and replace it
oldVnode = emptyNodeAt(oldVnode)
}
// replacing existing element
const oldElm = oldVnode.elm
const parentElm = nodeOps.parentNode(oldElm)
// create new node
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)
)
// update parent placeholder node element, recursively
if (isDef(vnode.parent)) {
let ancestor = vnode.parent
const patchable = isPatchable(vnode)
while (ancestor) {
for (let i = 0; i < cbs.destroy.length; ++i) {
cbs.destroy[i](ancestor)
}
ancestor.elm = vnode.elm
if (patchable) {
for (let i = 0; i < cbs.create.length; ++i) {
cbs.create[i](emptyNode, ancestor)
}
// #6513
// invoke insert hooks that may have been merged by create hooks.
// e.g. for directives that uses the "inserted" hook.
const insert = ancestor.data.hook.insert
if (insert.merged) {
// start at index 1 to avoid re-invoking component mounted hook
for (let i = 1; i < insert.fns.length; i++) {
insert.fns[i]()
}
}
} else {
registerRef(ancestor)
}
ancestor = ancestor.parent
}
}
// destroy old node
if (isDef(parentElm)) {
removeVnodes([oldVnode], 0, 0)
} else if (isDef(oldVnode.tag)) {
invokeDestroyHook(oldVnode)
}
}
}
invokeInsertHook(vnode, insertedVnodeQueue, isInitialPatch)
return vnode.elm
}
分析主干逻辑,patch
主要处理以下内容:
-
若 oldVNode 存在, newVNode 不存在。则「销毁元素」。
-
若 oldVNode 不存在,newVNode 存在。则「创建元素」,按照当前虚拟节点创建真实DOM,并挂载到
vnode.elm
。 -
若 oldVNode 和 newVNode 都存在,并且通过 sameVnode 函数 判断两者是否相等。相等,则执行后续进一步比较(自身和子节点),这部分内容是通过
patchVnode
函数处理。稍后我们详细了解。//...
patchVnode(oldVnode, vnode, insertedVnodeQueue, null, null, removeOnly)
//... -
最后,返回diff渲染后的真实
vnode.elm
。
接下来,看下 patchVnode
函数的主干逻辑。
patchVnode (更新节点)
源代码如下:
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)
}
}
patchVnode,主干逻辑:
-
若 「oldVNode」 和 「newVnode」 「完全相等」,则 直接 return,无需后续diff操作。 -
若 「oldVNode」 和 「newVnode」 「不完全相等」(仅满足 sameVnode函数的判等逻辑): -
将 oldVNode.elm
关联到newVNode.elm
上,使 「newVnode」 具有对应真实DOM的引用。 -
将 「oldVNode」 和 「newVNode」的差异变化,更新到 「当前节点」对应的真实DOM上。 -
深度diff 「当前节点」的 「子节点」。 「子节点的比较」通过 「updateChildren」 函数来完成。稍后我们详细了解。
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)) {
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)
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)
}
}
对「子节点的比较」,是「diff算法的关键」。为了「提升渲染效率」。子元素集合「diff」的「基本原则」, 如下:
-
「尽可能多的复用已经存在的DOM」 -
改变位置 -
修改属性 -
「尽可能少的创建或删除真实DOM」
具体实现,通过源码可知:比较时,会分别为「新旧子节点集合」设置「头尾两个指针」,「头尾指针」根据「「比较规则」」,向中间移动,依次比较新旧各个子节点,并更新(修改、移动、创建、删除)对应的真实DOM。
diff原理图
【「子节点diff前」】
【「子节点diff后」】
diff比较规则
结合上面「原理图」,整理「diff比较规则」如下:
-
头(旧) 不存在, oldStart ++ -
尾(旧)不存在, oldEnd - - -
头(旧)和 头(新)相等。 -
递归调用 patchVnode
、 -
oldStart ++ 、newStart ++ -
尾(旧)和 尾(新)相等。 -
递归调用 patchVnode
-
oldEnd - -、 newEnd - - -
头(旧)和 尾 (新)相等。 -
递归调用 patchVnode
-
「 「移动」」 「当前节点对应DOM」 到 「oldEnd 指针对应DOM下一个Dom」的 「前边」 —— 「moved right」 -
oldStart ++ 、newEnd - - -
尾(旧)和 头(新)相等。 -
递归调用 patchVnode
-
「 「移动」」 「当前节点对应DOM」 到 「oldStart 指针 对应DOM」 的 「前边」 —— 「moved left」 -
oldEnd - - 、newStart ++ -
遍历 「剩余oldVNodeChildren」,将 「key -> index」 的映射关系,存储到一个 map中,通过 key值, 判断 「头(新)「是否在」剩余oldVNodeChildren」中。【注意,没有key的节点,需要再次遍历 「剩余oldVNodeChildren」通过 sameVnode
函数判断】 -
「 「相同」」 -
「 「不相同」」,表明只是key相同,但不是同一个 element,需要 「 「创建元素」」 -
递归调用 patchVnode
函数 -
从 「剩余oldVNodeChildren」中删除 「匹配的旧节点」 -
「 「移动」」**当前节点对应DOM **到 「oldStart指针对应DOM」 的前边 —— 「moved left」 -
头(新)「不在」 「剩余oldVNodeChildren」 中,「 「创建元素」」 -
头 (新)的 key「在」 「剩余oldVNodeChildren」 的某一个vnode中,需要进一步通过 sameVnode
函数判断 「匹配的旧节点」和 **头(新)**是否「 「相同」」 -
头尾指针停止后,查看指针位置状态 -
若 oldStart > oldEnd, 表明 newVNodeChildren 存在未处理的节点,需要 「遍历未处理节点」,依次「 「创建元素」」 -
若 newStart > newEnd,表明 oldVNodeChildren 存在未处理的节点,需要 「遍历未处理节点」,依次「 「销毁元素」」
开发示例
列表渲染 —— key值不可缺
「示例代码」
<template>
<div class="list-key">
<h1>观察控制面板,列表渲染加不加 key 的区别?</h1>
<ul>
<!--eslint-disable-->
<!-- 不加 key -->
<!-- <li v-for="n in list">{{ n }}</li> -->
<!-- 加 key -->
<li v-for="n in list" :key="n">{{ n }}</li>
</ul>
<button @click="list.reverse()">反转数组</button>
<button @click="list.unshift(10)">头部添加</button>
</div>
</template>
<script>
export default {
data() {
return {
list: [1, 2, 3, 4, 5],
};
},
};
「图示」
列表反转 —— 不加 「key」
列表反转 —— 加 「key」
头部添加 —— 不加 「key」
头部添加 —— 加 「key」
总结
通过分析源码,可以清晰了解Vue中 DOM-Diff的过程、DOM-Diff的核心:「深度优先,同层比较」。并结合开发示例,学习了在列表渲染中,添加 key 值可以有效的复用已存在的DOM,提升渲染效率。
交流
如果这篇文章帮助到你,「点赞」和「关注」不失联,你的支持是对笔者最大的鼓励!
微信关注 「 乘风破浪大前端 」,发现更多有趣好用的前端知识和实战。
干货系列文章汇总如下,欢迎 「start」 、「follow」 交流学习 以上是关于Vue2.x源码系列08Diff算法原理的主要内容,如果未能解决你的问题,请参考以下文章