在第一篇 前置准备 章节我们新建了一个 HTML 文件,里面引用并构建了一个简单的 Vue 应用。构建一个 Vue 应用是通过 new Vue 一个对象开始的,这一节我们先来看看 Vue 类是怎样定义的,以方便我们后续的学习。
/dist/vue.js 是 umd 完整版的 Vue,是 src 中源码编译打包后的一个 js 文件,这里我们随时在 vue.js 文件和 src 源码之间切换阅读,我们读的时候自己注意区分差别(虽然它们都差不多一样)。
在上一篇 构建Vue 中我们知道了 Vue 的构建入口是 /src/platforms/web/entry-runtime-with-compiler.js,我们跟入看看
/* @flow */
import config from 'core/config'
import { warn, cached } from 'core/util/index'
import { mark, measure } from 'core/util/perf'
import Vue from './runtime/index'
import { query } from './util/index'
import { compileToFunctions } from './compiler/index'
import { shouldDecodeNewlines, shouldDecodeNewlinesForHref } from './util/compat'
const idToTemplate = cached(id => {
const el = query(id)
return el && el.innerHTML
})
const mount = Vue.prototype.$mount
Vue.prototype.$mount = function (
el?: string | Element,
hydrating?: boolean
): Component {
el = el && query(el)
/* istanbul ignore if */
if (el === document.body || el === document.documentElement) {
process.env.NODE_ENV !== 'production' && warn(
`Do not mount Vue to or - mount to normal elements instead.`
)
return this
}
const options = this.$options
// resolve template/el and convert to render function
if (!options.render) {
let template = options.template
if (template) {
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
}
} else if (el) {
template = getOuterHTML(el)
}
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')
}
}
}
return mount.call(this, el, hydrating)
}
/**
* 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
}
}
Vue.compile = compileToFunctions
export default Vue
entry-runtime-with-compiler.js 导入了当前目录下的 runtime/index.js,并且把 Vue.prototype.$mount 另存到了变量 mount 后重新给 Vue.prototype.$mount 赋了新值,在这个新的值是一个最终挂载函数,它里面又调用了前面保存的 mount 函数。关于这个挂载函数,我们稍后来看。现在我们继续看导出 Vue 的 /src/platforms/web/runtime/index.js
/* @flow */
import Vue from 'core/index'
import config from 'core/config'
import { extend, noop } from 'shared/util'
import { mountComponent } from 'core/instance/lifecycle'
import { devtools, inBrowser } from 'core/util/index'
import {
query,
mustUseProp,
isReservedTag,
isReservedAttr,
getTagNamespace,
isUnknownElement
} from 'web/util/index'
import { patch } from './patch'
import platformDirectives from './directives/index'
import platformComponents from './components/index'
// install platform specific utils
Vue.config.mustUseProp = mustUseProp
Vue.config.isReservedTag = isReservedTag
Vue.config.isReservedAttr = isReservedAttr
Vue.config.getTagNamespace = getTagNamespace
Vue.config.isUnknownElement = isUnknownElement
// install platform runtime directives & components
extend(Vue.options.directives, platformDirectives)
extend(Vue.options.components, platformComponents)
// install platform patch function
Vue.prototype.__patch__ = inBrowser ? patch : noop
// public mount method
Vue.prototype.$mount = function (
el?: string | Element,
hydrating?: boolean
): Component {
el = el && inBrowser ? query(el) : undefined
return mountComponent(this, el, hydrating)
}
// devtools global hook
/* istanbul ignore next */
if (inBrowser) {
setTimeout(() => {
if (config.devtools) {
if (devtools) {
devtools.emit('init', Vue)
} else if (
process.env.NODE_ENV !== 'production' &&
process.env.NODE_ENV !== 'test'
) {
console[console.info ? 'info' : 'log'](
'Download the Vue Devtools extension for a better development experience:\n' +
'https://github.com/vuejs/vue-devtools'
)
}
}
if (process.env.NODE_ENV !== 'production' &&
process.env.NODE_ENV !== 'test' &&
config.productionTip !== false &&
typeof console !== 'undefined'
) {
console[console.info ? 'info' : 'log'](
`You are running Vue in development mode.\n` +
`Make sure to turn on production mode when deploying for production.\n` +
`See more tips at https://vuejs.org/guide/deployment.html`
)
}
}, 0)
}
export default Vue
这个文件也很简单,它从 /src/core/index.js 导入 Vue,然后给 Vue 的原型上的 __patch__ 和 $mount 属性赋值,这个 $mount 就是在上一个入口文件中被另存且供最终 $mount 调用的那个。下面我们继续看 /src/core/index.js
import Vue from './instance/index'
import { initGlobalAPI } from './global-api/index'
import { isServerRendering } from 'core/util/env'
import { FunctionalRenderContext } from 'core/vdom/create-functional-component'
initGlobalAPI(Vue)
Object.defineProperty(Vue.prototype, '$isServer', {
get: isServerRendering
})
Object.defineProperty(Vue.prototype, '$ssrContext', {
get () {
/* istanbul ignore next */
return this.$vnode && this.$vnode.ssrContext
}
})
// expose FunctionalRenderContext for ssr runtime helper installation
Object.defineProperty(Vue, 'FunctionalRenderContext', {
value: FunctionalRenderContext
})
Vue.version = '__VERSION__'
export default Vue
这里又是从其他文件 /src/core/instance/index.js 导入了 Vue,并且以 Vue 为实参调用了 initGlobalAPI(这个函数我们稍后看),然后在原型上定义了几个属性,然后导出 Vue。我们继续跟进 /src/core/instance/index.js
import { initMixin } from './init'
import { stateMixin } from './state'
import { renderMixin } from './render'
import { eventsMixin } from './events'
import { lifecycleMixin } from './lifecycle'
import { warn } from '../util/index'
function Vue (options) {
if (process.env.NODE_ENV !== 'production' &&
!(this instanceof Vue)
) {
warn('Vue is a constructor and should be called with the `new` keyword')
}
this._init(options)
}
initMixin(Vue)
stateMixin(Vue)
eventsMixin(Vue)
lifecycleMixin(Vue)
renderMixin(Vue)
export default Vue
至此,我们已经看到了 Vue 的本质,它就是一个构造函数,这这个构造函数中只做了一件事,那就是在 new Vue 实列化对象时调用了成员方法 _init 做一系列初始化。接着我们看到,定义构造函数后依次调用了 initMixin(Vue)、stateMixin(Vue)、eventsMixin(Vue)、lifecycleMixin(Vue)、renderMixin(Vue),都是把 Vue 传入给它们,这是一种混入的编程方式,能方便扩展 Vue 的功能。
我们整理一下,那么就是如下的流程:
来简单总结下整个流程
// 定义Vue构造函数
function Vue (options) {...}
// 定义Vue.prototype._init,里面初始化实例操作
initMixin(Vue);
// 定义只读$data、$props;并给$set $delete $watch赋值
// Vue.prototype.$set = set;
// Vue.prototype.$delete = del;
// Vue.prototype.$watch = function (expOrFn,cb,options){...}
stateMixin(Vue);
// 定义 事件类方法
// Vue.prototype.$on
// Vue.prototype.$once
// Vue.prototype.$off
// Vue.prototype.$emit
eventsMixin(Vue);
// 定义 _update 方法用于循环渲染用
// Vue.prototype._update
// 定义 生命周期类方法,其他生命周期钩子在mergeOptions中合并入一个options中
// Vue.prototype.$forceUpdate
// Vue.prototype.$destroy
lifecycleMixin(Vue);
// 定义 _render 方法生成模板的 Vnode
// Vue.prototype._render
// Vue.prototype.$nextTick
renderMixin(Vue);
然后 initGlobalAPI(Vue) 设置静态方法和属性
Vue.util
Vue.set
Vue.delete
Vue.nextTick
Vue.observable
Vue.options._base = Vue;
Vue.options.directives
Vue.options.components
Vue.options.filters
Vue.options._base = Vue // 指向 Vue 构造函数
// 定义静态方法 Vue.use 用于安装插件
initUse(Vue);
// 定义静态方法 Vue.mixin 用于全局混入
//(这个initMixin不同于/src/core/instance/index.js的 initMixin)
initMixin(Vue);
// 定义静态方法 Vue.extend 用于继承扩展 Vue
initExtend(Vue);
// 定义静态方法
// Vue.component 注册组件
// Vue.directive 注册指令
// Vue.filter 注册过滤器
initAssetRegisters(Vue);
最后
定义挂载方法
Vue.prototype.$mount
定义静态编译方法 用于编译模板
compileToFunctions 来自/src/platforms/web/compiler/index.js
Vue.compile = compileToFunctions;
到此就完成了整个 Vue 类的定义。这里还有很多细节我们没有深入,我们先在这了解大体的流程,里面的细节在后续的章节我们再慢慢解释。