h 函数

  • 演示 render 的 h 函数

    • h 函数就是 createElement()
      1. const vm = new Vue({
      2. el: '#app',
      3. render(h) {
      4. // h(tag, data, children)
      5. // return h('h1', this.msg)
      6. // return h('h1', { domProps: { innerHTML: this.msg } })
      7. // return h('h1', { attrs: { id: 'title' } }, this.msg)
      8. const vnode = h(
      9. 'h1',
      10. {
      11. attrs: { id: 'title' }
      12. },
      13. this.msg
      14. )
      15. console.log(vnode)
      16. return vnode
      17. },
      18. data: {
      19. msg: 'Hello Vue'
      20. }
      21. })
  • vm.$createElement(tag, data, children, normalizeChildren)

    • tag
      • 标签名称或者组件对象
    • data
      • 描述 tag,可以设置 DOM 的属性或者标签的属性
    • children
      • tag 中的文本内容或者子节点
  • VNode 的核心属性
    • tag
    • data
    • children
    • text
    • elm
    • key

整体过程分析

虚拟 DOM - 图1

createElement

功能

createElement 函数,用来创建虚拟节点 (VNode),我们的 render 函数中的参数 h,就是 createElement()

  1. render(h) {
  2. // 此处的 h 就是 vm.$createElement
  3. return h('h1', this.msg)
  4. }

定义

在 vm._render() 中调用了,用户传递的或者编译生成的 render 函数,这个时候传递了 createElement

  • src/core/instance/render.js
    1. vm._c = (a, b, c, d) => createElement(vm, a, b, c, d, false)
    2. // normalization is always applied for the public version, used in
    3. // user-written render functions.
    4. vm.$createElement = (a, b, c, d) => createElement(vm, a, b, c, d, true)
    vm._c 和 vm.$createElement 内部都调用了 createElement,不同的是最后一个参数。vm._c 在编译生成的 render 函数内部会调用,vm.$createElement 在用户传入的的 render 函数内部调用。当用户传入 render 函数的时候,要对用户传入的参数做处理。
  • src/core/vdom/create-element.js

执行完 createElement 之后创建好了 VNode,把创建好的 VNode 传递给 vm._update() 继续处理。

  1. export function createElement(
  2. context: Component,
  3. tag: any,
  4. data: any,
  5. children: any,
  6. normalizationType: any,
  7. alwaysNormalize: boolean
  8. ): VNode | Array<VNode> {
  9. // 判断第三个参数
  10. // 如果 data 是数组或者原始值的话就是 children,实现类似函数重载的机制
  11. if (Array.isArray(data) || isPrimitive(data)) {
  12. normalizationType = children
  13. children = data
  14. data = undefined
  15. }
  16. if (isTrue(alwaysNormalize)) {
  17. normalizationType = ALWAYS_NORMALIZE
  18. }
  19. return _createElement(context, tag, data, children, normalizationType)
  20. }
  21. export function _createElement(
  22. context: Component,
  23. tag?: string | Class<Component> | Function | Object,
  24. data?: VNodeData,
  25. children?: any,
  26. normalizationType?: number
  27. ): VNode | Array<VNode> {
  28. if (isDef(data) && isDef((data: any).__ob__)) {
  29. ……
  30. return createEmptyVNode()
  31. }
  32. // object syntax in v-bind
  33. if (isDef(data) && isDef(data.is)) {
  34. tag = data.is
  35. }
  36. if (!tag) {
  37. // in case of component :is set to falsy value
  38. return createEmptyVNode()
  39. }
  40. ……
  41. // support single function children as default scoped slot
  42. if (Array.isArray(children) &&
  43. typeof children[0] === 'function'
  44. ) {
  45. data = data || {}
  46. data.scopedSlots = { default: children[0] }
  47. children.length = 0
  48. }
  49. // 去处理 children
  50. if (normalizationType === ALWAYS_NORMALIZE) {
  51. // 当手写 render 函数的时候调用
  52. // 判断 children 的类型,如果是原始值的话转换成 VNode 的数组
  53. // 如果是数组的话,继续处理数组中的元素
  54. // 如果数组中的子元素又是数组(slot template),递归处理
  55. // 如果连续两个节点都是字符串会合并文本节点
  56. children = normalizeChildren(children)
  57. } else if (normalizationType === SIMPLE_NORMALIZE) {
  58. // 把二维数组转换为一维数组
  59. // 如果 children 中有函数组件的话,函数组件会返回数组形式
  60. // 这时候 children 就是一个二维数组,只需要把二维数组转换为一维数组
  61. children = simpleNormalizeChildren(children)
  62. }
  63. let vnode, ns
  64. // 判断 tag 是字符串还是组件
  65. if (typeof tag === 'string') {
  66. let Ctor
  67. ns = (context.$vnode && context.$vnode.ns) ||
  68. config.getTagNamespace(tag)
  69. // 如果是浏览器的保留标签,创建对应的 VNode
  70. if (config.isReservedTag(tag)) {
  71. // platform built-in elements
  72. vnode = new VNode(
  73. config.parsePlatformTagName(tag), data, children,
  74. undefined, undefined, context
  75. )
  76. } else if ((!data || !data.pre) && isDef(Ctor =
  77. resolveAsset(context.$options, 'components', tag))) {
  78. // component
  79. // 否则的话创建组件
  80. vnode = createComponent(Ctor, data, context, children, tag)
  81. } else {
  82. // unknown or unlisted namespaced elements
  83. // check at runtime because it may get assigned a namespace when its
  84. // parent normalizes children
  85. vnode = new VNode(
  86. tag, data, children,
  87. undefined, undefined, context
  88. )
  89. }
  90. } else {
  91. // direct component options / constructor
  92. vnode = createComponent(tag, data, context, children)
  93. }
  94. if (Array.isArray(vnode)) {
  95. return vnode
  96. } else if (isDef(vnode)) {
  97. if (isDef(ns)) applyNS(vnode, ns)
  98. if (isDef(data)) registerDeepBindings(data)
  99. return vnode
  100. } else {
  101. return createEmptyVNode()
  102. }
  103. }

update

功能

内部调用 vm.patch() 把虚拟 DOM 转换成真实 DOM

定义

  • src/core/instance/lifecycle.js ```javascript export function initLifecycle (vm: Component) { const options = vm.$options

    // locate first non-abstract parent let parent = options.parent if (parent && !options.abstract) { while (parent.$options.abstract && parent.$parent) { parent = parent.$parent } parent.$children.push(vm) }

    vm.$parent = parent vm.$root = parent ? parent.$root : vm

    vm.$children = [] vm.$refs = {}

    vm._watcher = null vm._inactive = null vm._directInactive = false vm._isMounted = false vm._isDestroyed = false vm._isBeingDestroyed = false }

export function lifecycleMixin (Vue: Class) { // update 方法的作用是把 VNode 渲染成真实的 DOM // 首次渲染会调用,数据更新会调用 Vue.prototype.update = function (vnode: VNode, hydrating?: boolean) { const vm: Component = this const prevEl = vm.$el const prevVnode = vm.vnode const restoreActiveInstance = setActiveInstance(vm) vm.vnode = vnode // Vue.prototype.patch is injected in entry points // based on the rendering backend used. if (!prevVnode) { // initial render vm.$el = vm.patch(vm.$el, vnode, hydrating, false / removeOnly /) } else { // updates vm.$el = vm.patch(prevVnode, vnode) } restoreActiveInstance() // update vue reference if (prevEl) { prevEl.__vue = null } if (vm.$el) { vm.$el.__vue = vm } // if parent is an HOC, update its $el as well if (vm.$vnode && vm.$parent && vm.$vnode === vm.$parent._vnode) { vm.$parent.$el = vm.$el } // updated hook is called by the scheduler to ensure that children are // updated in a parent’s updated hook. } }

  1. <a name="SlB9i"></a>
  2. # patch 函数
  3. <a name="mttoj"></a>
  4. ## 功能
  5. 对比两个 VNode 的差异,把差异更新到真实 DOM。如果是首次渲染的话,会把真实 DOM 先转换成 VNode。
  6. <a name="PhHkz"></a>
  7. ## Snabbdom 中 patch 函数的初始化
  8. - src/snabbdom.ts
  9. ```typescript
  10. export function init (modules: Array<Partial<Module>>, domApi?: DOMAPI) {
  11. return function patch (oldVnode: VNode | Element, vnode: VNode): VNode {
  12. }
  13. }
  • vnode
    1. export function vnode (sel: string | undefined,
    2. data: any | undefined,
    3. children: Array<VNode | string> | undefined,
    4. text: string | undefined,
    5. elm: Element | Text | undefined): VNode {
    6. const key = data === undefined ? undefined : data.key
    7. return { sel, data, children, text, elm, key }
    8. }

Vue.js 中 patch 函数的初始化

  • src/platforms/web/runtime/index.js

    1. import { patch } from './patch'
    2. Vue.prototype.__patch__ = inBrowser ? patch : noop
  • 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 })
  • src/core/vdom/patch.js

    1. export function createPatchFunction(backend) {
    2. let i, j
    3. const cbs = {}
    4. const { modules, nodeOps } = backend
    5. // 把模块中的钩子函数全部设置到 cbs 中,将来统一触发
    6. // cbs --> { 'create': [fn1, fn2], ... }
    7. for (i = 0; i < hooks.length; ++i) {
    8. cbs[hooks[i]] = []
    9. for (j = 0; j < modules.length; ++j) {
    10. if (isDef(modules[j][hooks[i]])) {
    11. cbs[hooks[i]].push(modules[j][hooks[i]])
    12. }
    13. }
    14. }
    15. ……
    16. ……
    17. ……
    18. return function patch(oldVnode, vnode, hydrating, removeOnly) {
    19. }
    20. }

patch 函数执行过程

  1. function patch(oldVnode, vnode, hydrating, removeOnly) {
  2. // 如果没有 vnode 但是有 oldVnode,执行销毁的钩子函数
  3. if (isUndef(vnode)) {
  4. if (isDef(oldVnode)) invokeDestroyHook(oldVnode)
  5. return
  6. }
  7. let isInitialPatch = false
  8. const insertedVnodeQueue = []
  9. if (isUndef(oldVnode)) {
  10. // 如果没有 oldVnode,创建 vnode 对应的真实 DOM
  11. // empty mount (likely as component), create new root element
  12. isInitialPatch = true
  13. createElm(vnode, insertedVnodeQueue)
  14. } else {
  15. // 判断当前 oldVnode 是否是 DOM 元素(首次渲染)
  16. const isRealElement = isDef(oldVnode.nodeType)
  17. if (!isRealElement && sameVnode(oldVnode, vnode)) {
  18. // 如果不是真实 DOM,并且两个 VNode 是 sameVnode,这个时候开始执行 Diff
  19. // patch existing root node
  20. patchVnode(oldVnode, vnode, insertedVnodeQueue, null, null,
  21. removeOnly)
  22. } else {
  23. if (isRealElement) {
  24. // mounting to a real element
  25. // check if this is server-rendered content and if we can perform
  26. // a successful hydration.
  27. if (oldVnode.nodeType === 1 && oldVnode.hasAttribute(SSR_ATTR)) {
  28. oldVnode.removeAttribute(SSR_ATTR)
  29. hydrating = true
  30. }
  31. ……
  32. // either not server-rendered, or hydration failed.
  33. // create an empty node and replace it
  34. oldVnode = emptyNodeAt(oldVnode)
  35. }
  36. // replacing existing element
  37. const oldElm = oldVnode.elm
  38. const parentElm = nodeOps.parentNode(oldElm)
  39. // create new node
  40. createElm(
  41. vnode,
  42. insertedVnodeQueue,
  43. // extremely rare edge case: do not insert if old element is in a
  44. // leaving transition. Only happens when combining transition +
  45. // keep-alive + HOCs. (#4590)
  46. oldElm._leaveCb ? null : parentElm,
  47. nodeOps.nextSibling(oldElm)
  48. )
  49. // update parent placeholder node element, recursively
  50. if (isDef(vnode.parent)) {
  51. let ancestor = vnode.parent
  52. const patchable = isPatchable(vnode)
  53. while (ancestor) {
  54. for (let i = 0; i < cbs.destroy.length; ++i) {
  55. cbs.destroy[i](ancestor)
  56. }
  57. ancestor.elm = vnode.elm
  58. if (patchable) {
  59. for (let i = 0; i < cbs.create.length; ++i) {
  60. cbs.create[i](emptyNode, ancestor)
  61. }
  62. // #6513
  63. // invoke insert hooks that may have been merged by create
  64. hooks.
  65. // e.g. for directives that uses the "inserted" hook.
  66. const insert = ancestor.data.hook.insert
  67. if (insert.merged) {
  68. // start at index 1 to avoid re-invoking component mounted
  69. hook
  70. for (let i = 1; i < insert.fns.length; i++) {
  71. insert.fns[i]()
  72. }
  73. }
  74. } else {
  75. registerRef(ancestor)
  76. }
  77. ancestor = ancestor.parent
  78. }
  79. }
  80. // destroy old node
  81. if (isDef(parentElm)) {
  82. removeVnodes(parentElm, [oldVnode], 0, 0)
  83. } else if (isDef(oldVnode.tag)) {
  84. invokeDestroyHook(oldVnode)
  85. }
  86. }
  87. }
  88. invokeInsertHook(vnode, insertedVnodeQueue, isInitialPatch)
  89. return vnode.elm
  90. }

createElm

把 VNode 转换成真实 DOM,插入到 DOM 树上。

  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. }

patchVnode

  1. function patchVnode(
  2. oldVnode,
  3. vnode,
  4. insertedVnodeQueue,
  5. ownerArray,
  6. index,
  7. removeOnly
  8. ) {
  9. // 如果新旧节点是完全相同的节点,直接返回
  10. if (oldVnode === vnode) {
  11. return
  12. }
  13. if (isDef(vnode.elm) && isDef(ownerArray)) {
  14. // clone reused vnode
  15. vnode = ownerArray[index] = cloneVNode(vnode)
  16. }
  17. const elm = vnode.elm = oldVnode.elm
  18. ……
  19. // 触发 prepatch 钩子函数
  20. let i
  21. const data = vnode.data
  22. if (isDef(data) && isDef(i = data.hook) && isDef(i = i.prepatch)) {
  23. i(oldVnode, vnode)
  24. }
  25. // 获取新旧 VNode 的子节点
  26. const oldCh = oldVnode.children
  27. const ch = vnode.children
  28. // 触发 update 钩子函数
  29. if (isDef(data) && isPatchable(vnode)) {
  30. for (i = 0; i < cbs.update.length; ++i) cbs.update[i](oldVnode,
  31. vnode)
  32. if (isDef(i = data.hook) && isDef(i = i.update)) i(oldVnode, vnode)
  33. }
  34. // 如果 vnode 没有 text 属性(说明有可能有子元素)
  35. if (isUndef(vnode.text)) {
  36. if (isDef(oldCh) && isDef(ch)) {
  37. // 如果新旧节点都有子节点并且不相同,这时候对比和更新子节点
  38. if (oldCh !== ch) updateChildren(elm, oldCh, ch,
  39. insertedVnodeQueue, removeOnly)
  40. } else if (isDef(ch)) {
  41. if (process.env.NODE_ENV !== 'production') {
  42. checkDuplicateKeys(ch)
  43. }
  44. // 如果新节点有子节点,并且旧节点有 text
  45. // 清空旧节点对应的真实 DOM 的文本内容
  46. if (isDef(oldVnode.text)) nodeOps.setTextContent(elm, '')
  47. // 把新节点的子节点添转换成真实 DOM,添加到 elm
  48. addVnodes(elm, null, ch, 0, ch.length - 1, insertedVnodeQueue)
  49. } else if (isDef(oldCh)) {
  50. // 如果旧节点有子节点,新节点没有子节点
  51. // 移除所有旧节点对应的真实 DOM
  52. removeVnodes(elm, oldCh, 0, oldCh.length - 1)
  53. } else if (isDef(oldVnode.text)) {
  54. // 如果旧节点有 text,新节点没有子节点和 text
  55. nodeOps.setTextContent(elm, '')
  56. }
  57. } else if (oldVnode.text !== vnode.text) {
  58. // 如果新节点有 text,并且和旧节点的 text 不同
  59. // 直接把新节点的 text 更新到 DOM 上
  60. nodeOps.setTextContent(elm, vnode.text)
  61. }
  62. // 触发 postpatch 钩子函数
  63. if (isDef(data)) {
  64. if (isDef(i = data.hook) && isDef(i = i.postpatch)) i(oldVnode,
  65. vnode)
  66. }
  67. }

key 的作用

  • 当没有设置 key 的时候
    • 在 updateChildren 中比较子节点的时候,会做三次更新 DOM 操作和一次插入 DOM 的操作
  • 当设置 key 的时候
    • 在 updateChildren 中比较子节点的时候,因为 oldVnode 的子节点的 b,c,d 和 newVnode 的 x,b,c 的 key 相同,所以只做比较,没有更新 DOM 的操作,当遍历完毕后,会再把 x 插入到 DOM 上DOM 操 作只有一次插入操作。