Vue 实例挂载的实现

Vue 中我们是通过 $mount 实例方法去挂载 vm 的,$mount 方法在多个文件中都有定义,如 src/platform/web/entry-runtime-with-compiler.jssrc/platform/web/runtime/index.jssrc/platform/weex/runtime/index.js。因为 $mount 这个方法的实现是和平台、构建方式都相关的。接下来我们重点分析带 compiler 版本的 $mount 实现,因为抛开 webpack 的 vue-loader,我们在纯前端浏览器环境分析 Vue 的工作原理,有助于我们对原理理解的深入。

compiler 版本的 $mount 实现非常有意思,先来看一下 src/platform/web/entry-runtime-with-compiler.js 文件中定义:

  1. const mount = Vue.prototype.$mount
  2. Vue.prototype.$mount = function (
  3. el?: string | Element,
  4. hydrating?: boolean
  5. ): Component {
  6. el = el && query(el)
  7. /* istanbul ignore if */
  8. if (el === document.body || el === document.documentElement) {
  9. process.env.NODE_ENV !== 'production' && warn(
  10. `Do not mount Vue to <html> or <body> - mount to normal elements instead.`
  11. )
  12. return this
  13. }
  14. const options = this.$options
  15. // resolve template/el and convert to render function
  16. if (!options.render) {
  17. let template = options.template
  18. if (template) {
  19. if (typeof template === 'string') {
  20. if (template.charAt(0) === '#') {
  21. template = idToTemplate(template)
  22. /* istanbul ignore if */
  23. if (process.env.NODE_ENV !== 'production' && !template) {
  24. warn(
  25. `Template element not found or is empty: ${options.template}`,
  26. this
  27. )
  28. }
  29. }
  30. } else if (template.nodeType) {
  31. template = template.innerHTML
  32. } else {
  33. if (process.env.NODE_ENV !== 'production') {
  34. warn('invalid template option:' + template, this)
  35. }
  36. return this
  37. }
  38. } else if (el) {
  39. template = getOuterHTML(el)
  40. }
  41. if (template) {
  42. /* istanbul ignore if */
  43. if (process.env.NODE_ENV !== 'production' && config.performance && mark) {
  44. mark('compile')
  45. }
  46. const { render, staticRenderFns } = compileToFunctions(template, {
  47. shouldDecodeNewlines,
  48. shouldDecodeNewlinesForHref,
  49. delimiters: options.delimiters,
  50. comments: options.comments
  51. }, this)
  52. options.render = render
  53. options.staticRenderFns = staticRenderFns
  54. /* istanbul ignore if */
  55. if (process.env.NODE_ENV !== 'production' && config.performance && mark) {
  56. mark('compile end')
  57. measure(`vue ${this._name} compile`, 'compile', 'compile end')
  58. }
  59. }
  60. }
  61. return mount.call(this, el, hydrating)
  62. }

这段代码首先缓存了原型上的 $mount 方法,再重新定义该方法,我们先来分析这段代码。首先,它对 el 做了限制,Vue 不能挂载在 bodyhtml 这样的根节点上。接下来的是很关键的逻辑 —— 如果没有定义 render 方法,则会把 el 或者 template 字符串转换成 render 方法。这里我们要牢记,在 Vue 2.0 版本中,所有 Vue 的组件的渲染最终都需要 render 方法,无论我们是用单文件 .vue 方式开发组件,还是写了 el 或者 template 属性,最终都会转换成 render 方法,那么这个过程是 Vue 的一个“在线编译”的过程,它是调用 compileToFunctions 方法实现的,编译过程我们之后会介绍。最后,调用原先原型上的 $mount 方法挂载。

原先原型上的 $mount 方法在 src/platform/web/runtime/index.js 中定义,之所以这么设计完全是为了复用,因为它是可以被 runtime only 版本的 Vue 直接使用的。

  1. // public mount method
  2. Vue.prototype.$mount = function (
  3. el?: string | Element,
  4. hydrating?: boolean
  5. ): Component {
  6. el = el && inBrowser ? query(el) : undefined
  7. return mountComponent(this, el, hydrating)
  8. }

$mount 方法支持传入 2 个参数,第一个是 el,它表示挂载的元素,可以是字符串,也可以是 DOM 对象,如果是字符串在浏览器环境下会调用 query 方法转换成 DOM 对象的。第二个参数是和服务端渲染相关,在浏览器环境下我们不需要传第二个参数。

$mount 方法实际上会去调用 mountComponent 方法,这个方法定义在 src/core/instance/lifecycle.js 文件中:

  1. export function mountComponent (
  2. vm: Component,
  3. el: ?Element,
  4. hydrating?: boolean
  5. ): Component {
  6. vm.$el = el
  7. if (!vm.$options.render) {
  8. vm.$options.render = createEmptyVNode
  9. if (process.env.NODE_ENV !== 'production') {
  10. /* istanbul ignore if */
  11. if ((vm.$options.template && vm.$options.template.charAt(0) !== '#') ||
  12. vm.$options.el || el) {
  13. warn(
  14. 'You are using the runtime-only build of Vue where the template ' +
  15. 'compiler is not available. Either pre-compile the templates into ' +
  16. 'render functions, or use the compiler-included build.',
  17. vm
  18. )
  19. } else {
  20. warn(
  21. 'Failed to mount component: template or render function not defined.',
  22. vm
  23. )
  24. }
  25. }
  26. }
  27. callHook(vm, 'beforeMount')
  28. let updateComponent
  29. /* istanbul ignore if */
  30. if (process.env.NODE_ENV !== 'production' && config.performance && mark) {
  31. updateComponent = () => {
  32. const name = vm._name
  33. const id = vm._uid
  34. const startTag = `vue-perf-start:${id}`
  35. const endTag = `vue-perf-end:${id}`
  36. mark(startTag)
  37. const vnode = vm._render()
  38. mark(endTag)
  39. measure(`vue ${name} render`, startTag, endTag)
  40. mark(startTag)
  41. vm._update(vnode, hydrating)
  42. mark(endTag)
  43. measure(`vue ${name} patch`, startTag, endTag)
  44. }
  45. } else {
  46. updateComponent = () => {
  47. vm._update(vm._render(), hydrating)
  48. }
  49. }
  50. // we set this to vm._watcher inside the watcher's constructor
  51. // since the watcher's initial patch may call $forceUpdate (e.g. inside child
  52. // component's mounted hook), which relies on vm._watcher being already defined
  53. new Watcher(vm, updateComponent, noop, {
  54. before () {
  55. if (vm._isMounted) {
  56. callHook(vm, 'beforeUpdate')
  57. }
  58. }
  59. }, true /* isRenderWatcher */)
  60. hydrating = false
  61. // manually mounted instance, call mounted on self
  62. // mounted is called for render-created child components in its inserted hook
  63. if (vm.$vnode == null) {
  64. vm._isMounted = true
  65. callHook(vm, 'mounted')
  66. }
  67. return vm
  68. }

从上面的代码可以看到,mountComponent 核心就是先调用 vm._render 方法先生成虚拟 Node,再实例化一个渲染Watcher,在它的回调函数中会调用 updateComponent 方法,最终调用 vm._update 更新 DOM。

Watcher 在这里起到两个作用,一个是初始化的时候会执行回调函数,另一个是当 vm 实例中的监测的数据发生变化的时候执行回调函数,这块儿我们会在之后的章节中介绍。

函数最后判断为根节点的时候设置 vm._isMountedtrue, 表示这个实例已经挂载了,同时执行 mounted 钩子函数。 这里注意 vm.$vnode 表示 Vue 实例的父虚拟 Node,所以它为 Null 则表示当前是根 Vue 的实例。

总结

mountComponent 方法的逻辑也是非常清晰的,它会完成整个渲染工作,接下来我们要重点分析其中的细节,也就是最核心的 2 个方法:vm._rendervm._update

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