update

Vue 的 _update 是实例的一个私有方法,它被调用的时机有 2 个,一个是首次渲染,一个是数据更新的时候;由于我们这一章节只分析首次渲染部分,数据更新部分会在之后分析响应式原理的时候涉及。_update 方法的作用是把 VNode 渲染成真实的 DOM,它的定义在 src/core/instance/lifecycle.js 中:

  1. Vue.prototype._update = function (vnode: VNode, hydrating?: boolean) {
  2. const vm: Component = this
  3. const prevEl = vm.$el
  4. const prevVnode = vm._vnode
  5. const prevActiveInstance = activeInstance
  6. activeInstance = vm
  7. vm._vnode = vnode
  8. // Vue.prototype.__patch__ is injected in entry points
  9. // based on the rendering backend used.
  10. if (!prevVnode) {
  11. // initial render
  12. vm.$el = vm.__patch__(vm.$el, vnode, hydrating, false /* removeOnly */)
  13. } else {
  14. // updates
  15. vm.$el = vm.__patch__(prevVnode, vnode)
  16. }
  17. activeInstance = prevActiveInstance
  18. // update __vue__ reference
  19. if (prevEl) {
  20. prevEl.__vue__ = null
  21. }
  22. if (vm.$el) {
  23. vm.$el.__vue__ = vm
  24. }
  25. // if parent is an HOC, update its $el as well
  26. if (vm.$vnode && vm.$parent && vm.$vnode === vm.$parent._vnode) {
  27. vm.$parent.$el = vm.$el
  28. }
  29. // updated hook is called by the scheduler to ensure that children are
  30. // updated in a parent's updated hook.
  31. }

update 的核心就是调用 vm._patch 方法,这个方法实际上在不同的平台,比如 web 和 weex 上的定义是不一样的,因此在 web 平台中它的定义在 src/platforms/web/runtime/index.js 中:

  1. Vue.prototype.__patch__ = inBrowser ? patch : noop

可以看到,甚至在 web 平台上,是否是服务端渲染也会对这个方法产生影响。因为在服务端渲染中,没有真实的浏览器 DOM 环境,所以不需要把 VNode 最终转换成 DOM,因此是一个空函数,而在浏览器端渲染中,它指向了 patch 方法,它的定义在 src/platforms/web/runtime/patch.js中:

  1. import * as nodeOps from 'web/runtime/node-ops'
  2. import { createPatchFunction } from 'core/vdom/patch'
  3. import baseModules from 'core/vdom/modules/index'
  4. import platformModules from 'web/runtime/modules/index'
  5. // the directive module should be applied last, after all
  6. // built-in modules have been applied.
  7. const modules = platformModules.concat(baseModules)
  8. export const patch: Function = createPatchFunction({ nodeOps, modules })

该方法的定义是调用 createPatchFunction 方法的返回值,这里传入了一个对象,包含 nodeOps 参数和 modules 参数。其中,nodeOps 封装了一系列 DOM 操作的方法,modules 定义了一些模块的钩子函数的实现,我们这里先不详细介绍,来看一下 createPatchFunction 的实现,它定义在 src/core/vdom/patch.js 中:

  1. const hooks = ['create', 'activate', 'update', 'remove', 'destroy']
  2. export function createPatchFunction (backend) {
  3. let i, j
  4. const cbs = {}
  5. const { modules, nodeOps } = backend
  6. for (i = 0; i < hooks.length; ++i) {
  7. cbs[hooks[i]] = []
  8. for (j = 0; j < modules.length; ++j) {
  9. if (isDef(modules[j][hooks[i]])) {
  10. cbs[hooks[i]].push(modules[j][hooks[i]])
  11. }
  12. }
  13. }
  14. // ...
  15. return function patch (oldVnode, vnode, hydrating, removeOnly) {
  16. if (isUndef(vnode)) {
  17. if (isDef(oldVnode)) invokeDestroyHook(oldVnode)
  18. return
  19. }
  20. let isInitialPatch = false
  21. const insertedVnodeQueue = []
  22. if (isUndef(oldVnode)) {
  23. // empty mount (likely as component), create new root element
  24. isInitialPatch = true
  25. createElm(vnode, insertedVnodeQueue)
  26. } else {
  27. const isRealElement = isDef(oldVnode.nodeType)
  28. if (!isRealElement && sameVnode(oldVnode, vnode)) {
  29. // patch existing root node
  30. patchVnode(oldVnode, vnode, insertedVnodeQueue, removeOnly)
  31. } else {
  32. if (isRealElement) {
  33. // mounting to a real element
  34. // check if this is server-rendered content and if we can perform
  35. // a successful hydration.
  36. if (oldVnode.nodeType === 1 && oldVnode.hasAttribute(SSR_ATTR)) {
  37. oldVnode.removeAttribute(SSR_ATTR)
  38. hydrating = true
  39. }
  40. if (isTrue(hydrating)) {
  41. if (hydrate(oldVnode, vnode, insertedVnodeQueue)) {
  42. invokeInsertHook(vnode, insertedVnodeQueue, true)
  43. return oldVnode
  44. } else if (process.env.NODE_ENV !== 'production') {
  45. warn(
  46. 'The client-side rendered virtual DOM tree is not matching ' +
  47. 'server-rendered content. This is likely caused by incorrect ' +
  48. 'HTML markup, for example nesting block-level elements inside ' +
  49. '<p>, or missing <tbody>. Bailing hydration and performing ' +
  50. 'full client-side render.'
  51. )
  52. }
  53. }
  54. // either not server-rendered, or hydration failed.
  55. // create an empty node and replace it
  56. oldVnode = emptyNodeAt(oldVnode)
  57. }
  58. // replacing existing element
  59. const oldElm = oldVnode.elm
  60. const parentElm = nodeOps.parentNode(oldElm)
  61. // create new node
  62. createElm(
  63. vnode,
  64. insertedVnodeQueue,
  65. // extremely rare edge case: do not insert if old element is in a
  66. // leaving transition. Only happens when combining transition +
  67. // keep-alive + HOCs. (#4590)
  68. oldElm._leaveCb ? null : parentElm,
  69. nodeOps.nextSibling(oldElm)
  70. )
  71. // update parent placeholder node element, recursively
  72. if (isDef(vnode.parent)) {
  73. let ancestor = vnode.parent
  74. const patchable = isPatchable(vnode)
  75. while (ancestor) {
  76. for (let i = 0; i < cbs.destroy.length; ++i) {
  77. cbs.destroy[i](ancestor)
  78. }
  79. ancestor.elm = vnode.elm
  80. if (patchable) {
  81. for (let i = 0; i < cbs.create.length; ++i) {
  82. cbs.create[i](emptyNode, ancestor)
  83. }
  84. // #6513
  85. // invoke insert hooks that may have been merged by create hooks.
  86. // e.g. for directives that uses the "inserted" hook.
  87. const insert = ancestor.data.hook.insert
  88. if (insert.merged) {
  89. // start at index 1 to avoid re-invoking component mounted hook
  90. for (let i = 1; i < insert.fns.length; i++) {
  91. insert.fns[i]()
  92. }
  93. }
  94. } else {
  95. registerRef(ancestor)
  96. }
  97. ancestor = ancestor.parent
  98. }
  99. }
  100. // destroy old node
  101. if (isDef(parentElm)) {
  102. removeVnodes(parentElm, [oldVnode], 0, 0)
  103. } else if (isDef(oldVnode.tag)) {
  104. invokeDestroyHook(oldVnode)
  105. }
  106. }
  107. }
  108. invokeInsertHook(vnode, insertedVnodeQueue, isInitialPatch)
  109. return vnode.elm
  110. }
  111. }

createPatchFunction 内部定义了一系列的辅助方法,最终返回了一个 patch 方法,这个方法就赋值给了 vm.update 函数里调用的 vm._patch

在介绍 patch 的方法实现之前,我们可以思考一下为何 Vue.js 源码绕了这么一大圈,把相关代码分散到各个目录。因为前面介绍过,patch 是平台相关的,在 Web 和 Weex 环境,它们把虚拟 DOM 映射到 “平台 DOM” 的方法是不同的,并且对 “DOM” 包括的属性模块创建和更新也不尽相同。因此每个平台都有各自的 nodeOpsmodules,它们的代码需要托管在 src/platforms 这个大目录下。

而不同平台的 patch 的主要逻辑部分是相同的,所以这部分公共的部分托管在 core 这个大目录下。差异化部分只需要通过参数来区别,这里用到了一个函数柯里化的技巧,通过 createPatchFunction 把差异化参数提前固化,这样不用每次调用 patch 的时候都传递 nodeOpsmodules 了,这种编程技巧也非常值得学习。

在这里,nodeOps 表示对 “平台 DOM” 的一些操作方法,modules 表示平台的一些模块,它们会在整个 patch 过程的不同阶段执行相应的钩子函数。这些代码的具体实现会在之后的章节介绍。

回到 patch 方法本身,它接收 4个参数,oldVnode 表示旧的 VNode 节点,它也可以不存在或者是一个 DOM 对象;vnode 表示执行 _render 后返回的 VNode 的节点;hydrating 表示是否是服务端渲染;removeOnly 是给 transition-group 用的,之后会介绍。

patch 的逻辑看上去相对复杂,因为它有着非常多的分支逻辑,为了方便理解,我们并不会在这里介绍所有的逻辑,仅会针对我们之前的例子分析它的执行逻辑。之后我们对其它场景做源码分析的时候会再次回顾 patch 方法。

先来回顾我们的例子:

  1. var app = new Vue({
  2. el: '#app',
  3. render: function (createElement) {
  4. return createElement('div', {
  5. attrs: {
  6. id: 'app'
  7. },
  8. }, this.message)
  9. },
  10. data: {
  11. message: 'Hello Vue!'
  12. }
  13. })

然后我们在 vm._update 的方法里是这么调用 patch 方法的:

  1. // initial render
  2. vm.$el = vm.__patch__(vm.$el, vnode, hydrating, false /* removeOnly */)

结合我们的例子,我们的场景是首次渲染,所以在执行 patch 函数的时候,传入的 vm.$el 对应的是例子中 id 为 app 的 DOM 对象,这个也就是我们在 index.html 模板中写的 <div id="app">vm.$el 的赋值是在之前 mountComponent 函数做的,vnode 对应的是调用 render 函数的返回值,hydrating 在非服务端渲染情况下为 false,removeOnly 为 false。

确定了这些入参后,我们回到 patch 函数的执行过程,看几个关键步骤。

  1. const isRealElement = isDef(oldVnode.nodeType)
  2. if (!isRealElement && sameVnode(oldVnode, vnode)) {
  3. // patch existing root node
  4. patchVnode(oldVnode, vnode, insertedVnodeQueue, removeOnly)
  5. } else {
  6. if (isRealElement) {
  7. // mounting to a real element
  8. // check if this is server-rendered content and if we can perform
  9. // a successful hydration.
  10. if (oldVnode.nodeType === 1 && oldVnode.hasAttribute(SSR_ATTR)) {
  11. oldVnode.removeAttribute(SSR_ATTR)
  12. hydrating = true
  13. }
  14. if (isTrue(hydrating)) {
  15. if (hydrate(oldVnode, vnode, insertedVnodeQueue)) {
  16. invokeInsertHook(vnode, insertedVnodeQueue, true)
  17. return oldVnode
  18. } else if (process.env.NODE_ENV !== 'production') {
  19. warn(
  20. 'The client-side rendered virtual DOM tree is not matching ' +
  21. 'server-rendered content. This is likely caused by incorrect ' +
  22. 'HTML markup, for example nesting block-level elements inside ' +
  23. '<p>, or missing <tbody>. Bailing hydration and performing ' +
  24. 'full client-side render.'
  25. )
  26. }
  27. }
  28. // either not server-rendered, or hydration failed.
  29. // create an empty node and replace it
  30. oldVnode = emptyNodeAt(oldVnode)
  31. }
  32. // replacing existing element
  33. const oldElm = oldVnode.elm
  34. const parentElm = nodeOps.parentNode(oldElm)
  35. // create new node
  36. createElm(
  37. vnode,
  38. insertedVnodeQueue,
  39. // extremely rare edge case: do not insert if old element is in a
  40. // leaving transition. Only happens when combining transition +
  41. // keep-alive + HOCs. (#4590)
  42. oldElm._leaveCb ? null : parentElm,
  43. nodeOps.nextSibling(oldElm)
  44. )
  45. }

由于我们传入的 oldVnode 实际上是一个 DOM container,所以 isRealElement 为 true,接下来又通过 emptyNodeAt 方法把 oldVnode 转换成 VNode 对象,然后再调用 createElm 方法,这个方法在这里非常重要,来看一下它的实现:

  1. function createElm (
  2. vnode,
  3. insertedVnodeQueue,
  4. parentElm,
  5. refElm,
  6. nested,
  7. ownerArray,
  8. index
  9. ) {
  10. if (isDef(vnode.elm) && isDef(ownerArray)) {
  11. // This vnode was used in a previous render!
  12. // now it's used as a new node, overwriting its elm would cause
  13. // potential patch errors down the road when it's used as an insertion
  14. // reference node. Instead, we clone the node on-demand before creating
  15. // associated DOM element for it.
  16. vnode = ownerArray[index] = cloneVNode(vnode)
  17. }
  18. vnode.isRootInsert = !nested // for transition enter check
  19. if (createComponent(vnode, insertedVnodeQueue, parentElm, refElm)) {
  20. return
  21. }
  22. const data = vnode.data
  23. const children = vnode.children
  24. const tag = vnode.tag
  25. if (isDef(tag)) {
  26. if (process.env.NODE_ENV !== 'production') {
  27. if (data && data.pre) {
  28. creatingElmInVPre++
  29. }
  30. if (isUnknownElement(vnode, creatingElmInVPre)) {
  31. warn(
  32. 'Unknown custom element: <' + tag + '> - did you ' +
  33. 'register the component correctly? For recursive components, ' +
  34. 'make sure to provide the "name" option.',
  35. vnode.context
  36. )
  37. }
  38. }
  39. vnode.elm = vnode.ns
  40. ? nodeOps.createElementNS(vnode.ns, tag)
  41. : nodeOps.createElement(tag, vnode)
  42. setScope(vnode)
  43. /* istanbul ignore if */
  44. if (__WEEX__) {
  45. // ...
  46. } else {
  47. createChildren(vnode, children, insertedVnodeQueue)
  48. if (isDef(data)) {
  49. invokeCreateHooks(vnode, insertedVnodeQueue)
  50. }
  51. insert(parentElm, vnode.elm, refElm)
  52. }
  53. if (process.env.NODE_ENV !== 'production' && data && data.pre) {
  54. creatingElmInVPre--
  55. }
  56. } else if (isTrue(vnode.isComment)) {
  57. vnode.elm = nodeOps.createComment(vnode.text)
  58. insert(parentElm, vnode.elm, refElm)
  59. } else {
  60. vnode.elm = nodeOps.createTextNode(vnode.text)
  61. insert(parentElm, vnode.elm, refElm)
  62. }
  63. }

createElm 的作用是通过虚拟节点创建真实的 DOM 并插入到它的父节点中。 我们来看一下它的一些关键逻辑,createComponent 方法目的是尝试创建子组件,这个逻辑在之后组件的章节会详细介绍,在当前这个 case 下它的返回值为 false;接下来判断 vnode 是否包含 tag,如果包含,先简单对 tag 的合法性在非生产环境下做校验,看是否是一个合法标签;然后再去调用平台 DOM 的操作去创建一个占位符元素。

  1. vnode.elm = vnode.ns
  2. ? nodeOps.createElementNS(vnode.ns, tag)
  3. : nodeOps.createElement(tag, vnode)

接下来调用 createChildren 方法去创建子元素:

  1. createChildren(vnode, children, insertedVnodeQueue)
  2. function createChildren (vnode, children, insertedVnodeQueue) {
  3. if (Array.isArray(children)) {
  4. if (process.env.NODE_ENV !== 'production') {
  5. checkDuplicateKeys(children)
  6. }
  7. for (let i = 0; i < children.length; ++i) {
  8. createElm(children[i], insertedVnodeQueue, vnode.elm, null, true, children, i)
  9. }
  10. } else if (isPrimitive(vnode.text)) {
  11. nodeOps.appendChild(vnode.elm, nodeOps.createTextNode(String(vnode.text)))
  12. }
  13. }

createChildren 的逻辑很简单,实际上是遍历子虚拟节点,递归调用 createElm,这是一种常用的深度优先的遍历算法,这里要注意的一点是在遍历过程中会把 vnode.elm 作为父容器的 DOM 节点占位符传入。

接着再调用 invokeCreateHooks 方法执行所有的 create 的钩子并把 vnode push 到 insertedVnodeQueue 中。

  1. if (isDef(data)) {
  2. invokeCreateHooks(vnode, insertedVnodeQueue)
  3. }
  4. function invokeCreateHooks (vnode, insertedVnodeQueue) {
  5. for (let i = 0; i < cbs.create.length; ++i) {
  6. cbs.create[i](emptyNode, vnode)
  7. }
  8. i = vnode.data.hook // Reuse variable
  9. if (isDef(i)) {
  10. if (isDef(i.create)) i.create(emptyNode, vnode)
  11. if (isDef(i.insert)) insertedVnodeQueue.push(vnode)
  12. }
  13. }

最后调用 insert 方法把 DOM 插入到父节点中,因为是递归调用,子元素会优先调用 insert,所以整个 vnode 树节点的插入顺序是先子后父。来看一下 insert 方法,它的定义在 src/core/vdom/patch.js 上。

  1. insert(parentElm, vnode.elm, refElm)
  2. function insert (parent, elm, ref) {
  3. if (isDef(parent)) {
  4. if (isDef(ref)) {
  5. if (ref.parentNode === parent) {
  6. nodeOps.insertBefore(parent, elm, ref)
  7. }
  8. } else {
  9. nodeOps.appendChild(parent, elm)
  10. }
  11. }
  12. }

insert 逻辑很简单,调用一些 nodeOps 把子节点插入到父节点中,这些辅助方法定义在 src/platforms/web/runtime/node-ops.js 中:

  1. export function insertBefore (parentNode: Node, newNode: Node, referenceNode: Node) {
  2. parentNode.insertBefore(newNode, referenceNode)
  3. }
  4. export function appendChild (node: Node, child: Node) {
  5. node.appendChild(child)
  6. }

其实就是调用原生 DOM 的 API 进行 DOM 操作,看到这里,很多同学恍然大悟,原来 Vue 是这样动态创建的 DOM。

createElm 过程中,如果 vnode 节点不包含 tag,则它有可能是一个注释或者纯文本节点,可以直接插入到父元素中。在我们这个例子中,最内层就是一个文本 vnode,它的 text 值取的就是之前的 this.message 的值 Hello Vue!

再回到 patch 方法,首次渲染我们调用了 createElm 方法,这里传入的 parentElmoldVnode.elm 的父元素,在我们的例子是 id 为 #app div 的父元素,也就是 Body;实际上整个过程就是递归创建了一个完整的 DOM 树并插入到 Body 上。

最后,我们根据之前递归 createElm 生成的 vnode 插入顺序队列,执行相关的 insert 钩子函数,这部分内容我们之后会详细介绍。

总结

那么至此我们从主线上把模板和数据如何渲染成最终的 DOM 的过程分析完毕了,我们可以通过下图更直观地看到从初始化 Vue 到最终渲染的整个过程。
update - 图1
我们这里只是分析了最简单和最基础的场景,在实际项目中,我们是把页面拆成很多组件的,Vue 另一个核心思想就是组件化。那么下一章我们就来分析 Vue 的组件化过程。

原文: https://ustbhuangyi.github.io/vue-analysis/data-driven/update.html