• 从入口开始
    • Vue 的入口
      • Vue 的定义
      • initGlobalAPI
    • 总结

    从入口开始

    我们之前提到过 Vue.js 构建过程,在 web 应用下,我们来分析 Runtime + Compiler 构建出来的 Vue.js,它的入口是 src/platforms/web/entry-runtime-with-compiler.js

    1. /* @flow */
    2. import config from 'core/config'
    3. import { warn, cached } from 'core/util/index'
    4. import { mark, measure } from 'core/util/perf'
    5. import Vue from './runtime/index'
    6. import { query } from './util/index'
    7. import { compileToFunctions } from './compiler/index'
    8. import { shouldDecodeNewlines, shouldDecodeNewlinesForHref } from './util/compat'
    9. const idToTemplate = cached(id => {
    10. const el = query(id)
    11. return el && el.innerHTML
    12. })
    13. const mount = Vue.prototype.$mount
    14. Vue.prototype.$mount = function (
    15. el?: string | Element,
    16. hydrating?: boolean
    17. ): Component {
    18. el = el && query(el)
    19. /* istanbul ignore if */
    20. if (el === document.body || el === document.documentElement) {
    21. process.env.NODE_ENV !== 'production' && warn(
    22. `Do not mount Vue to <html> or <body> - mount to normal elements instead.`
    23. )
    24. return this
    25. }
    26. const options = this.$options
    27. // resolve template/el and convert to render function
    28. if (!options.render) {
    29. let template = options.template
    30. if (template) {
    31. if (typeof template === 'string') {
    32. if (template.charAt(0) === '#') {
    33. template = idToTemplate(template)
    34. /* istanbul ignore if */
    35. if (process.env.NODE_ENV !== 'production' && !template) {
    36. warn(
    37. `Template element not found or is empty: ${options.template}`,
    38. this
    39. )
    40. }
    41. }
    42. } else if (template.nodeType) {
    43. template = template.innerHTML
    44. } else {
    45. if (process.env.NODE_ENV !== 'production') {
    46. warn('invalid template option:' + template, this)
    47. }
    48. return this
    49. }
    50. } else if (el) {
    51. template = getOuterHTML(el)
    52. }
    53. if (template) {
    54. /* istanbul ignore if */
    55. if (process.env.NODE_ENV !== 'production' && config.performance && mark) {
    56. mark('compile')
    57. }
    58. const { render, staticRenderFns } = compileToFunctions(template, {
    59. shouldDecodeNewlines,
    60. shouldDecodeNewlinesForHref,
    61. delimiters: options.delimiters,
    62. comments: options.comments
    63. }, this)
    64. options.render = render
    65. options.staticRenderFns = staticRenderFns
    66. /* istanbul ignore if */
    67. if (process.env.NODE_ENV !== 'production' && config.performance && mark) {
    68. mark('compile end')
    69. measure(`vue ${this._name} compile`, 'compile', 'compile end')
    70. }
    71. }
    72. }
    73. return mount.call(this, el, hydrating)
    74. }
    75. /**
    76. * Get outerHTML of elements, taking care
    77. * of SVG elements in IE as well.
    78. */
    79. function getOuterHTML (el: Element): string {
    80. if (el.outerHTML) {
    81. return el.outerHTML
    82. } else {
    83. const container = document.createElement('div')
    84. container.appendChild(el.cloneNode(true))
    85. return container.innerHTML
    86. }
    87. }
    88. Vue.compile = compileToFunctions
    89. export default Vue

    那么,当我们的代码执行 import Vue from 'vue' 的时候,就是从这个入口执行代码来初始化 Vue,那么 Vue 到底是什么,它是怎么初始化的,我们来一探究竟。

    Vue 的入口

    在这个入口 JS 的上方我们可以找到 Vue 的来源:import Vue from './runtime/index',我们先来看一下这块儿的实现,它定义在 src/platforms/web/runtime/index.js 中:

    1. import Vue from 'core/index'
    2. import config from 'core/config'
    3. import { extend, noop } from 'shared/util'
    4. import { mountComponent } from 'core/instance/lifecycle'
    5. import { devtools, inBrowser, isChrome } from 'core/util/index'
    6. import {
    7. query,
    8. mustUseProp,
    9. isReservedTag,
    10. isReservedAttr,
    11. getTagNamespace,
    12. isUnknownElement
    13. } from 'web/util/index'
    14. import { patch } from './patch'
    15. import platformDirectives from './directives/index'
    16. import platformComponents from './components/index'
    17. // install platform specific utils
    18. Vue.config.mustUseProp = mustUseProp
    19. Vue.config.isReservedTag = isReservedTag
    20. Vue.config.isReservedAttr = isReservedAttr
    21. Vue.config.getTagNamespace = getTagNamespace
    22. Vue.config.isUnknownElement = isUnknownElement
    23. // install platform runtime directives & components
    24. extend(Vue.options.directives, platformDirectives)
    25. extend(Vue.options.components, platformComponents)
    26. // install platform patch function
    27. Vue.prototype.__patch__ = inBrowser ? patch : noop
    28. // public mount method
    29. Vue.prototype.$mount = function (
    30. el?: string | Element,
    31. hydrating?: boolean
    32. ): Component {
    33. el = el && inBrowser ? query(el) : undefined
    34. return mountComponent(this, el, hydrating)
    35. }
    36. // ...
    37. export default Vue

    这里关键的代码是 import Vue from 'core/index',之后的逻辑都是对 Vue 这个对象做一些扩展,可以先不用看,我们来看一下真正初始化 Vue 的地方,在 src/core/index.js 中:

    1. import Vue from './instance/index'
    2. import { initGlobalAPI } from './global-api/index'
    3. import { isServerRendering } from 'core/util/env'
    4. import { FunctionalRenderContext } from 'core/vdom/create-functional-component'
    5. initGlobalAPI(Vue)
    6. Object.defineProperty(Vue.prototype, '$isServer', {
    7. get: isServerRendering
    8. })
    9. Object.defineProperty(Vue.prototype, '$ssrContext', {
    10. get () {
    11. /* istanbul ignore next */
    12. return this.$vnode && this.$vnode.ssrContext
    13. }
    14. })
    15. // expose FunctionalRenderContext for ssr runtime helper installation
    16. Object.defineProperty(Vue, 'FunctionalRenderContext', {
    17. value: FunctionalRenderContext
    18. })
    19. Vue.version = '__VERSION__'
    20. export default Vue

    这里有 2 处关键的代码,import Vue from './instance/index'initGlobalAPI(Vue),初始化全局 Vue API(我们稍后介绍),我们先来看第一部分,在 src/core/instance/index.js 中:

    Vue 的定义

    1. import { initMixin } from './init'
    2. import { stateMixin } from './state'
    3. import { renderMixin } from './render'
    4. import { eventsMixin } from './events'
    5. import { lifecycleMixin } from './lifecycle'
    6. import { warn } from '../util/index'
    7. function Vue (options) {
    8. if (process.env.NODE_ENV !== 'production' &&
    9. !(this instanceof Vue)
    10. ) {
    11. warn('Vue is a constructor and should be called with the `new` keyword')
    12. }
    13. this._init(options)
    14. }
    15. initMixin(Vue)
    16. stateMixin(Vue)
    17. eventsMixin(Vue)
    18. lifecycleMixin(Vue)
    19. renderMixin(Vue)
    20. export default Vue

    在这里,我们终于看到了 Vue 的庐山真面目,它实际上就是一个用 Function 实现的类,我们只能通过 new Vue 去实例化它。

    有些同学看到这不禁想问,为何 Vue 不用 ES6 的 Class 去实现呢?我们往后看这里有很多 xxxMixin 的函数调用,并把 Vue 当参数传入,它们的功能都是给 Vue 的 prototype 上扩展一些方法(这里具体的细节会在之后的文章介绍,这里不展开),Vue 按功能把这些扩展分散到多个模块中去实现,而不是在一个模块里实现所有,这种方式是用 Class 难以实现的。这么做的好处是非常方便代码的维护和管理,这种编程技巧也非常值得我们去学习。

    initGlobalAPI

    Vue.js 在整个初始化过程中,除了给它的原型 prototype 上扩展方法,还会给 Vue 这个对象本身扩展全局的静态方法,它的定义在 src/core/global-api/index.js 中:

    1. export function initGlobalAPI (Vue: GlobalAPI) {
    2. // config
    3. const configDef = {}
    4. configDef.get = () => config
    5. if (process.env.NODE_ENV !== 'production') {
    6. configDef.set = () => {
    7. warn(
    8. 'Do not replace the Vue.config object, set individual fields instead.'
    9. )
    10. }
    11. }
    12. Object.defineProperty(Vue, 'config', configDef)
    13. // exposed util methods.
    14. // NOTE: these are not considered part of the public API - avoid relying on
    15. // them unless you are aware of the risk.
    16. Vue.util = {
    17. warn,
    18. extend,
    19. mergeOptions,
    20. defineReactive
    21. }
    22. Vue.set = set
    23. Vue.delete = del
    24. Vue.nextTick = nextTick
    25. Vue.options = Object.create(null)
    26. ASSET_TYPES.forEach(type => {
    27. Vue.options[type + 's'] = Object.create(null)
    28. })
    29. // this is used to identify the "base" constructor to extend all plain-object
    30. // components with in Weex's multi-instance scenarios.
    31. Vue.options._base = Vue
    32. extend(Vue.options.components, builtInComponents)
    33. initUse(Vue)
    34. initMixin(Vue)
    35. initExtend(Vue)
    36. initAssetRegisters(Vue)
    37. }

    这里就是在 Vue 上扩展的一些全局方法的定义,Vue 官网中关于全局 API 都可以在这里找到,这里不会介绍细节,会在之后的章节我们具体介绍到某个 API 的时候会详细介绍。有一点要注意的是,Vue.util 暴露的方法最好不要依赖,因为它可能经常会发生变化,是不稳定的。

    总结

    那么至此,Vue 的初始化过程基本介绍完毕。这一节的目的是让同学们对 Vue 是什么有一个直观的认识,它本质上就是一个用 Function 实现的 Class,然后它的原型 prototype 以及它本身都扩展了一系列的方法和属性,那么 Vue 能做什么,它是怎么做的,我们会在后面的章节一层层帮大家揭开 Vue 的神秘面纱。

    原文: https://ustbhuangyi.github.io/vue-analysis/prepare/entrance.html