每天學點Vue原始碼: vm.$mount掛載函式

小諾哥發表於2019-03-10

$mount函式執行位置

new Vue()

_init這個私有方法是在執行initMixin時候繫結到Vue原型上的。

mount

$mount函式是如如何把元件掛在到指定元素

$mount函式定義位置

$mount函式定義位置有兩個:

第一個是在src/platforms/web/runtime/index.js

第一個

這裡的$mount是一個public mount method。之所以這麼說是因為Vue有很多構建版本, 有些版本會依賴此方法進行有些功能定製, 後續會解釋。

// public mount method
// el: 可以是一個字串或者Dom元素
// hydrating 是Virtual DOM 的補丁演算法引數
Vue.prototype.$mount = function (
  el?: string | Element,
  hydrating?: boolean
): Component {
  // 判斷el, 以及宿主環境, 然後通過工具函式query重寫el。
  el = el && inBrowser ? query(el) : undefined
  // 執行真正的掛載並返回
  return mountComponent(this, el, hydrating)
}
複製程式碼

src/platforms/web/runtime/index.js 檔案是執行時版 Vue 的入口檔案,所以這個方法是執行時版本Vue執行的$mount。

關於Vue不同構建版本可以看Vue對不同構建版本的解釋

關於這個作者封裝的工具函式query也可以學習下:

/**
 * 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
  }
}
複製程式碼

第二個定義 $mount 函式的地方是src/platforms/web/entry-runtime-with-compiler.js 檔案,這個檔案是完整版Vue(執行時+編譯器)的入口檔案。

關於執行時與編譯器不清楚的童鞋可以看官網執行時 + 編譯器 vs. 只包含執行時

// 快取執行時候定義的公共$mount方法
const mount = Vue.prototype.$mount
Vue.prototype.$mount = function (
  el?: string | Element,
  hydrating?: boolean
): Component {
  // 通過query方法重寫el(掛載點: 元件掛載的佔位符)
  el = el && query(el)

  /* istanbul ignore if */
  // 提示不能把body/html作為掛載點, 開發環境下給出錯誤提示
  // 因為掛載點是會被元件模板自身替換點, 顯然body/html不能被替換
  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
  }
  // $options是在new Vue(options)時候_init方法內執行.
  // $options可以訪問到options的所有屬性如data, filter, components, directives等
  const options = this.$options
  // resolve template/el and convert to render function
  
  // 如果包含render函式則執行跳出,直接執行執行時版本的$mount方法
  if (!options.render) {
    // 沒有render函式時候優先考慮template屬性
    let template = options.template
    if (template) {
      // template存在且template的型別是字串
      if (typeof template === 'string') {
        if (template.charAt(0) === '#') {
          // template是ID
          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 的型別是元素節點,則使用該元素的 innerHTML 作為模板
        template = template.innerHTML
      } else {
        // 若 template既不是字串又不是元素節點,那麼在開發環境會提示開發者傳遞的 template 選項無效
        if (process.env.NODE_ENV !== 'production') {
          warn('invalid template option:' + template, this)
        }
        return this
      }
    } else if (el) {
      // 如果template選項不存在,那麼使用el元素的outerHTML 作為模板內容
      template = getOuterHTML(el)
    }
    // template: 儲存著最終用來生成渲染函式的字串
    if (template) {
      /* istanbul ignore if */
      if (process.env.NODE_ENV !== 'production' && config.performance && mark) {
        mark('compile')
      }
      // 獲取轉換後的render函式與staticRenderFns,並掛在$options上
      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 */
      // 用來統計編譯器效能, config是全域性配置物件
      if (process.env.NODE_ENV !== 'production' && config.performance && mark) {
        mark('compile end')
        measure(`vue ${this._name} compile`, 'compile', 'compile end')
      }
    }
  }
  // 呼叫之前說的公共mount方法
  // 重寫$mount方法是為了新增模板編譯的功能
  return mount.call(this, el, hydrating)
}
複製程式碼

關於idToTemplate方法: 通過query獲取該ID獲取DOM並把該元素的innerHTML 作為模板

const idToTemplate = cached(id => {
  const el = query(id)
  return el && el.innerHTML
})

複製程式碼

getOuterHTML方法:

/**
 * 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 {
    // fix IE9-11 中 SVG 標籤元素是沒有 innerHTML 和 outerHTML 這兩個屬性
    const container = document.createElement('div')
    container.appendChild(el.cloneNode(true))
    return container.innerHTML
  }
}
複製程式碼

關於compileToFunctions函式, 在src/platforms/web/entry-runtime-with-compiler.js中可以看到會掛載到Vue上作為一個全域性方法。

Vue.compile( template )

mountComponent方法: 真正執行繫結元件

mountComponent函式中是出現在src/core/instance/lifecycle.js。

export function mountComponent (
  vm: Component, // 元件例項vm
  el: ?Element, // 掛載點
  hydrating?: boolean
): Component {
  // 在元件例項物件上新增$el屬性
  // $el的值是元件模板根元素的引用
  vm.$el = el
  if (!vm.$options.render) {
    // 渲染函式不存在, 這時將會建立一個空的vnode物件
    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
        )
      }
    }
  }
  // 觸發 beforeMount 生命週期鉤子
  callHook(vm, 'beforeMount')

  // vm._render 函式的作用是呼叫 vm.$options.render 函式並返回生成的虛擬節點(vnode)。template => render => vnode
  
  // vm._update 函式的作用是把 vm._render 函式生成的虛擬節點渲染成真正的 DOM。 vnode => real dom node
  
  let updateComponent // 把渲染函式生成的虛擬DOM渲染成真正的DOM
  /* 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)
    }
  }

  // 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
  // 建立一個Render函式的觀察者, 關於watcher後續再講述.
  new Watcher(vm, updateComponent, noop, {
    before () {
      if (vm._isMounted && !vm._isDestroyed) {
        callHook(vm, 'beforeUpdate')
      }
    }
  }, true /* isRenderWatcher */)
  hydrating = false

  // 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
}
複製程式碼

相關文章