Vue原始碼探祕（四）（例項掛載$mount）

前端森林發表於2020-03-20
Vue原始碼

引言

在上一篇文章的結尾，我們提到資料渲染到DOM的關鍵就是呼叫vm.$mount方法來掛載vm。這一步是在_init函式的結尾被呼叫的:

// src/core/instance/init.js
Vue.prototype._init = function (options?: Object) {
  // ...
  if (vm.$options.el) {
    vm.$mount(vm.$options.el)
  }
}
複製程式碼

本篇文章，我們來分析一下vm.$mount內部具體發生了什麼。

例項掛載（$mount）

回顧之前的文章，我們知道$mount被定義在src/platforms/web/runtime/index.js中:

// public mount method
Vue.prototype.$mount = function (
  el?: string | Element,
  hydrating?: boolean
): Component {
  el = el && inBrowser ? query(el) : undefined
  return mountComponent(this, el, hydrating)
}
複製程式碼

其實不僅在這裡有定義$mount方法，在src/platform/web/entry-runtime-with-compiler.js、src/platform/weex/runtime/index.js都有定義。因為$mount方法的實現是和平臺、構建方式都相關的。

在執行時（Runtime Only）版本的Vue中，呼叫的就是上面的這個$mount函式。而在完整版（Runtime + Compiler）的Vue中，$mount函式在src/platform/web/entry-runtime-with-compiler.js中被重寫，這部分程式碼是我們這裡要著重分析的。先看一下整體結構:

// src/platforms/web/entry-runtime-with-compiler.js
const mount = Vue.prototype.$mount
Vue.prototype.$mount = function (
  el?: string | Element,
  hydrating?: boolean
): Component {
  el = el && query(el)

  // ...

  return mount.call(this, el, hydrating);
}
複製程式碼

這裡先拿到了Runtime Only版本的$mount方法，然後進行重寫，最後又呼叫了Runtime Only版本的$mount方法。引數的型別檢查表明el可以是字串或DOM節點。接下來又呼叫了query方法:

// src/platforms/web/util/index.js
/**
 * Query an element selector if it's not an element already.
 */
export function query (el: string | Element): Element {
  if (typeof el === 'string') {
    const selected = document.querySelector(el)
    if (!selected) {
      process.env.NODE_ENV !== 'production' && warn(
        'Cannot find element: ' + el
      )
      return document.createElement('div')
    }
    return selected
  } else {
    return el
  }
}
複製程式碼

query函式的邏輯比較簡單: 如果el是一個字串，就呼叫querySelector獲取節點並返回；如果節點不存在就丟擲警告並建立一個div節點。如果el是一個節點就直接返回。

我們接著往下分析，先來看第一小段:

  /* istanbul ignore if */
  if (el === document.body || el === document.documentElement) {
    process.env.NODE_ENV !== 'production' && warn(
      `Do not mount Vue to <html> or <body> - mount to normal elements instead.`
    )
    return this
  }
複製程式碼

這裡去檢查el是不是根節點（html）、(body)，如果是就丟擲警告並停止掛載。

Vue是不能掛載在body、html這樣的根節點上的，因為掛載實際上就是把el節點替換為元件的模版。

繼續往下看:

const options = this.$options
// resolve template/el and convert to render function
if (!options.render) {
  let template = options.template
  if (template) {
    // [1] ...
  } else if (el) {
    template = getOuterHTML(el)
  }
  // [2] ...
}
複製程式碼

首先判斷render函式是否存在，如果未定義則需做進一步處理。

從Vue2.0 開始，所有元件的渲染都需要用到render函式，無論是我們上一節的例子還是使用.vue檔案編寫。

進入if判斷後先拿到options.template，如果template存在就執行[1]處的程式碼:

if (typeof template === 'string') {
  if (template.charAt(0) === '#') {
    template = idToTemplate(template)
    /* istanbul ignore if */
    if (process.env.NODE_ENV !== 'production' && !template) {
      warn(
        `Template element not found or is empty: ${options.template}`,
        this
      )
    }
  }
} else if (template.nodeType) {
  template = template.innerHTML
} else {
  if (process.env.NODE_ENV !== 'production') {
    warn('invalid template option:' + template, this)
  }
  return this
}
複製程式碼

先判斷template是否是字串，如果是字串而且是id選擇器，通過idToTemplate方法拿到相應節點，如果拿不到會丟擲警告。如果是字串但不是選擇器，不作處理。

如果template是一個節點，那麼獲取它的innerHTML。

如果template既不是字串也不是一個節點，那麼丟擲警告並結束掛載。

如果template不存在，接著判斷el是否存在，存在則執行template = getOuterHTML(el)。來看下getOuterHTML函式:

// src/platforms/web/entry-runtime-with-compiler.js
/**
 * Get outerHTML of elements, taking care
 * of SVG elements in IE as well.
 */
function getOuterHTML (el: Element): string {
  if (el.outerHTML) {
    return el.outerHTML
  } else {
    const container = document.createElement('div')
    container.appendChild(el.cloneNode(true))
    return container.innerHTML
  }
}
複製程式碼

這裡判斷el.outerHTML是否存在，有就返回outerHTML。

IE9-11 中 SVG 標籤元素是沒有 innerHTML 和 outerHTML 這兩個屬性的。

else中就是對以上情況的相容處理: 在el的外面包裝了一層div，然後獲取該div的innerHTML。

這樣無論是 template 還是 el ，都被轉為了字串模板，然後執行[2]處的程式碼：

if (template) {
  /* istanbul ignore if */
  if (process.env.NODE_ENV !== 'production' && config.performance && mark) {
    mark('compile')
  }

  const { render, staticRenderFns } = compileToFunctions(template, {
    outputSourceRange: process.env.NODE_ENV !== 'production',
    shouldDecodeNewlines,
    shouldDecodeNewlinesForHref,
    delimiters: options.delimiters,
    comments: options.comments
  }, this)
  options.render = render
  options.staticRenderFns = staticRenderFns

  /* istanbul ignore if */
  if (process.env.NODE_ENV !== 'production' && config.performance && mark) {
    mark('compile end')
    measure(`vue ${this._name} compile`, 'compile', 'compile end')
  }
}
複製程式碼

這裡先判斷template是否存在（template可能為空字串）。可以清楚的看到進入if語句內，裡面有兩個相同的if語句，這與我們之前介紹_init函式時遇到的一樣，都是用於效能追蹤。

中間這段程式碼呼叫了compileToFunctions函式，返回的render函式將其掛載到options.render上。關於compileToFunctions的具體實現，我會在後面的章節中詳細介紹。

最後執行了:

return mount.call(this, el, hydrating)
複製程式碼

這裡是呼叫之前快取的在src/platforms/web/runtime/index.js中定義的$mount函式:

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

// public mount method
Vue.prototype.$mount = function (
  el?: string | Element,
  hydrating?: boolean
): Component {
  el = el && inBrowser ? query(el) : undefined
  return mountComponent(this, el, hydrating)
}
複製程式碼

這裡的 $mount 又把 el 從字串轉換成了節點然後傳給了 mountComponent 函式。和上面一樣，這裡把 mountComponent 函式的程式碼分成幾部分，先來看第一部分:

// src/core/instance/lifecycle.js

export function mountComponent (
  vm: Component,
  el: ?Element,
  hydrating?: boolean
): Component {
  vm.$el = el
  if (!vm.$options.render) {
    vm.$options.render = createEmptyVNode
    if (process.env.NODE_ENV !== 'production') {
      /* istanbul ignore if */
      if ((vm.$options.template && vm.$options.template.charAt(0) !== '#') ||
        vm.$options.el || el) {
        warn(
          'You are using the runtime-only build of Vue where the template ' +
          'compiler is not available. Either pre-compile the templates into ' +
          'render functions, or use the compiler-included build.',
          vm
        )
      } else {
        warn(
          'Failed to mount component: template or render function not defined.',
          vm
        )
      }
    }
  }
  callHook(vm, 'beforeMount')

  // ...
}
複製程式碼

先將el儲存到vm.$el上，然後判斷前面的template是否被正確的轉換成了render函式。如果轉換失敗，將createEmptyVNode作為render函式。createEmptyVNode函式會建立一個空的VNode物件。這部分會放在後面章節介紹。

在非生產環境下（一般是開發版本下），如果編寫了template或者el的同時又使用了Runtime Only版本的Vue，導致在$mount中不能編譯成render函式，則會丟擲警告；另外如果既沒有template也沒有render函式也會丟擲警告。

接下來呼叫的callHook函式是生命週期相關，會在後面的生命週期章節詳細介紹。繼續往下看:

let updateComponent
/* istanbul ignore if */
if (process.env.NODE_ENV !== 'production' && config.performance && mark) {
  updateComponent = () => {
    const name = vm._name
    const id = vm._uid
    const startTag = `vue-perf-start:${id}`
    const endTag = `vue-perf-end:${id}`

    mark(startTag)
    const vnode = vm._render()
    mark(endTag)
    measure(`vue ${name} render`, startTag, endTag)

    mark(startTag)
    vm._update(vnode, hydrating)
    mark(endTag)
    measure(`vue ${name} patch`, startTag, endTag)
  }
} else {
  updateComponent = () => {
    vm._update(vm._render(), hydrating)
  }
}
複製程式碼

if語句裡面是再熟悉不過的效能追蹤，我們直接跳過，看else部分。

這裡面定義了一個updateComponent函式，涉及到兩個函式:

  • _render: 呼叫 vm.$options.render 函式並返回生成的虛擬節點（VNode）
  • _update: 將 VNode 渲染成真實DOM

這裡我只是大概說明一下它的作用，具體會在後面章節中展開。

接著往下看:

// we set this to vm._watcher inside the watcher's constructor
// since the watcher's initial patch may call $forceUpdate (e.g. inside child
// component's mounted hook), which relies on vm._watcher being already defined
new Watcher(vm, updateComponent, noop, {
 before () {
   if (vm._isMounted && !vm._isDestroyed) {
     callHook(vm, 'beforeUpdate')
   }
 }
}, true /* isRenderWatcher */)
hydrating = false
複製程式碼

這裡建立了一個 Watcher 例項，顯然是與響應式資料相關的。這裡的 Watcher 也僅做了解，在後面的章節會具體分析。

Watcher 會解析表示式，收集依賴關係，並且在表示式的值發生改變時觸發回撥。Watcher 在這裡主要有兩個作用: 一個是初始化的時候會執行回撥函式；另一個是當 vm 例項中監測的資料發生變化的時候執行回撥函式，而回撥函式就是傳入的 updateComponent 函式。

回到 mountComponent 函式，還剩最後一段程式碼:

// manually mounted instance, call mounted on self
// mounted is called for render-created child components in its inserted hook
if (vm.$vnode == null) {
  vm._isMounted = true
  callHook(vm, 'mounted')
}
  return vm
複製程式碼

函式最後判斷為根節點的時候設定 vm._isMounted 為 true， 表示這個例項已經掛載了，同時執行 mounted 鉤子函式。

這裡注意 vm.$vnode 表示 Vue 例項的父虛擬 Node，所以它為 Null 則表示當前是根 Vue 的例項。

總結

這一節我們分析了 $mount 函式的大體執行流程，下一篇文章我將介紹 $mount 函式中_render 函式的實現。

相關文章