一、组件化
-
Vue.js
另一个核心思想是组件化。所谓组件化,就是把页面拆分成多个组件(component)
,每个组件依赖的CSS、JavaScript
、模板、图片等资源放在一起开发和维护。组件是资源独立的,组件在系统内部可复用,组件和组件之间可以嵌套。 -
我们在用
Vue.js
开发实际项目的时候,就是像搭积木一样,编写一堆组件拼装生成页面。在Vue.js
的官网中,也是花了大篇幅来介绍什么是组件,如何编写组件以及组件拥有的属性和特性。我们将从源码的角度来分析Vue
的组件内部是如何工作的,只有了解了内部的工作原理,才能让我们使用它的时候更加得心应手。 -
接下来我们会用
Vue-cli
初始化的代码为例,来分析一下Vue
组件初始化的一个过程,如下所示:
import Vue from 'vue'
import App from './App.vue'
var app = new Vue({
el: '#app',
// 这里的 h 是 createElement 方法
render: h => h(App)
})
和之前相同的点也是通过
render
函数去渲染的,不同的这次通过createElement
传的参数是一个组件而不是一个原生的标签,那么接下来我们就开始分析这一过程。
二、createComponent 的理解
- 我们之前在分析
createElement
的实现的时候,它最终会调用_createElement
方法,其中有一段逻辑是对参数tag
的判断,如果是一个普通的html
标签,是一个普通的 div,则会实例化一个普通VNode
节点,否则通过createComponent
方法创建一个组件VNode
,如下所示:
if (typeof tag === 'string') {
let Ctor
ns = (context.$vnode && context.$vnode.ns) || config.getTagNamespace(tag)
if (config.isReservedTag(tag)) {
// platform built-in elements
vnode = new VNode(
config.parsePlatformTagName(tag), data, children,
undefined, undefined, context
)
} else if (isDef(Ctor = resolveAsset(context.$options, 'components', tag))) {
// component
vnode = createComponent(Ctor, data, context, children, tag)
} else {
// unknown or unlisted namespaced elements
// check at runtime because it may get assigned a namespace when its
// parent normalizes children
vnode = new VNode(
tag, data, children,
undefined, undefined, context
)
}
} else {
// direct component options / constructor
vnode = createComponent(tag, data, context, children)
}
- 在这里传入的是一个
App
对象,它本质上是一个Component
类型,那么它会走到上述代码的else
逻辑,直接通过createComponent
方法来创建vnode
。所以接下来我们来看一下createComponent
方法的实现,它定义在src/core/vdom/create-component.js
文件中,如下所示:
export function createComponent (
Ctor: Class<Component> | Function | Object | void,
data: ?VNodeData,
context: Component,
children: ?Array<VNode>,
tag?: string
): VNode | Array<VNode> | void {
if (isUndef(Ctor)) {
return
}
const baseCtor = context.$options._base
// plain options object: turn it into a constructor
if (isObject(Ctor)) {
Ctor = baseCtor.extend(Ctor)
}
// if at this stage it's not a constructor or an async component factory,
// reject.
if (typeof Ctor !== 'function') {
if (process.env.NODE_ENV !== 'production') {
warn(`Invalid Component definition: ${String(Ctor)}`, context)
}
return
}
// async component
let asyncFactory
if (isUndef(Ctor.cid)) {
asyncFactory = Ctor
Ctor = resolveAsyncComponent(asyncFactory, baseCtor, context)
if (Ctor === undefined) {
// return a placeholder node for async component, which is rendered
// as a comment node but preserves all the raw information for the node.
// the information will be used for async server-rendering and hydration.
return createAsyncPlaceholder(
asyncFactory,
data,
context,
children,
tag
)
}
}
data = data || {}
// resolve constructor options in case global mixins are applied after
// component constructor creation
resolveConstructorOptions(Ctor)
// transform component v-model data into props & events
if (isDef(data.model)) {
transformModel(Ctor.options, data)
}
// extract props
const propsData = extractPropsFromVNodeData(data, Ctor, tag)
// functional component
if (isTrue(Ctor.options.functional)) {
return createFunctionalComponent(Ctor, propsData, data, context, children)
}
// extract listeners, since these needs to be treated as
// child component listeners instead of DOM listeners
const listeners = data.on
// replace with listeners with .native modifier
// so it gets processed during parent component patch.
data.on = data.nativeOn
if (isTrue(Ctor.options.abstract)) {
// abstract components do not keep anything
// other than props & listeners & slot
// work around flow
const slot = data.slot
data = {}
if (slot) {
data.slot = slot
}
}
// install component management hooks onto the placeholder node
installComponentHooks(data)
// return a placeholder vnode
const name = Ctor.options.name || tag
const vnode = new VNode(
`vue-component-${Ctor.cid}${name ? `-${name}` : ''}`,
data, undefined, undefined, undefined, context,
{ Ctor, propsData, listeners, tag, children },
asyncFactory
)
// Weex specific: invoke recycle-list optimized @render function for
// extracting cell-slot template.
// https://github.com/Hanks10100/weex-native-directive/tree/master/component
/* istanbul ignore if */
if (__WEEX__ && isRecyclableComponent(vnode)) {
return renderRecyclableComponentTemplate(vnode)
}
return vnode
}
-
从上面可以看到,
createComponent
的逻辑也会有一些复杂,但是分析源码比较推荐的是只分析核心流程,分支流程可以之后针对性的看,所以这里针对组件渲染这个 case 主要就三个关键步骤:
构造子类构造函数,安装组件钩子函数和实例化vnode
。 -
构造子类构造函数,如下所示:
const baseCtor = context.$options._base
// plain options object: turn it into a constructor
if (isObject(Ctor)) {
Ctor = baseCtor.extend(Ctor)
}
我们在编写一个组件的时候,通常都是创建一个普通对象,还是以我们的 App.vue 为例,代码如下:
import HelloWorld from './components/HelloWorld'
export default {
name: 'app',
components: {
HelloWorld
}
}
- 这里
export
的是一个对象,所以createComponent
里的代码逻辑会执行到baseCtor.extend(Ctor)
,在这里baseCtor
实际上就是Vue
,这个的定义是在最开始初始化Vue
的阶段,在src/core/global-api/index.js
中的initGlobalAPI
函数有这么一段逻辑:
// this is used to identify the "base" constructor to extend all plain-object
// components with in Weex's multi-instance scenarios.
Vue.options._base = Vue
- 这里定义的是
Vue.options
,而我们的createComponent
取的是context.$options
,实际上在src/core/instance/init.js
里Vue
原型上的_init
函数中有这么一段逻辑:
vm.$options = mergeOptions(
resolveConstructorOptions(vm.constructor),
options || {},
vm
)
-
这样就把
Vue
上的一些option
扩展到了vm.$options
上,所以我们也就能通过vm.$options._base
拿到 Vue 这个构造函数了。mergeOptions
的实现我们会在后面具体分析,现在只需要理解它的功能是把Vue
构造函数的options
和用户传入的options
做一层合并,到vm.$options
上。 -
在了解了
baseCtor
指向了Vue
之后,我们来看一下Vue.extend
函数的定义,在src/core/global-api/extend.js
中,如下所示:
/**
* Class inheritance
*/
Vue.extend = function (extendOptions: Object): Function {
extendOptions = extendOptions || {}
const Super = this
const SuperId = Super.cid
const cachedCtors = extendOptions._Ctor || (extendOptions._Ctor = {})
if (cachedCtors[SuperId]) {
return cachedCtors[SuperId]
}
const name = extendOptions.name || Super.options.name
if (process.env.NODE_ENV !== 'production' && name) {
validateComponentName(name)
}
const Sub = function VueComponent (options) {
this._init(options)
}
Sub.prototype = Object.create(Super.prototype)
Sub.prototype.constructor = Sub
Sub.cid = cid++
Sub.options = mergeOptions(
Super.options,
extendOptions
)
Sub['super'] = Super
// For props and computed properties, we define the proxy getters on
// the Vue instances at extension time, on the extended prototype. This
// avoids Object.defineProperty calls for each instance created.
if (Sub.options.props) {
initProps(Sub)
}
if (Sub.options.computed) {
initComputed(Sub)
}
// allow further extension/mixin/plugin usage
Sub.extend = Super.extend
Sub.mixin = Super.mixin
Sub.use = Super.use
// create asset registers, so extended classes
// can have their private assets too.
ASSET_TYPES.forEach(function (type) {
Sub[type] = Super[type]
})
// enable recursive self-lookup
if (name) {
Sub.options.components[name] = Sub
}
// keep a reference to the super options at extension time.
// later at instantiation we can check if Super's options have
// been updated.
Sub.superOptions = Super.options
Sub.extendOptions = extendOptions
Sub.sealedOptions = extend({}, Sub.options)
// cache constructor
cachedCtors[SuperId] = Sub
return Sub
}
-
Vue.extend
的作用就是构造一个Vue
的子类,它使用一种非常经典的原型继承的方式把一个纯对象转换一个继承于Vue
的构造器Sub
并返回,然后对Sub
这个对象本身扩展了一些属性,如扩展options
、添加全局API
等;并且对配置中的props
和computed
做了初始化工作;最后对于这个Sub
构造函数做了缓存,避免多次执行Vue.extend
的时候对同一个子组件重复构造。 -
这样当我们去实例化
Sub
的时候,就会执行this._init
逻辑再次走到了Vue
实例的初始化逻辑,如下所示:
const Sub = function VueComponent (options) {
this._init(options)
}
- 安装组件钩子函数,如下所示:
// install component management hooks onto the placeholder node
installComponentHooks(data)
- 我们之前提到
Vue.js
使用的Virtual DOM
参考的是开源库 snabbdom,它的一个特点是在VNode
的patch
流程中对外暴露了各种时机的钩子函数,方便我们做一些额外的事情,Vue.js
也是充分利用这一点,在初始化一个Component
类型的VNode
的过程中实现了几个钩子函数:
const componentVNodeHooks = {
init (vnode: VNodeWithData, hydrating: boolean): ?boolean {
if (
vnode.componentInstance &&
!vnode.componentInstance._isDestroyed &&
vnode.data.keepAlive
) {
// kept-alive components, treat as a patch
const mountedNode: any = vnode // work around flow
componentVNodeHooks.prepatch(mountedNode, mountedNode)
} else {
const child = vnode.componentInstance = createComponentInstanceForVnode(
vnode,
activeInstance
)
child.$mount(hydrating ? vnode.elm : undefined, hydrating)
}
},
prepatch (oldVnode: MountedComponentVNode, vnode: MountedComponentVNode) {
const options = vnode.componentOptions
const child = vnode.componentInstance = oldVnode.componentInstance
updateChildComponent(
child,
options.propsData, // updated props
options.listeners, // updated listeners
vnode, // new parent vnode
options.children // new children
)
},
insert (vnode: MountedComponentVNode) {
const { context, componentInstance } = vnode
if (!componentInstance._isMounted) {
componentInstance._isMounted = true
callHook(componentInstance, 'mounted')
}
if (vnode.data.keepAlive) {
if (context._isMounted) {
// vue-router#1212
// During updates, a kept-alive component's child components may
// change, so directly walking the tree here may call activated hooks
// on incorrect children. Instead we push them into a queue which will
// be processed after the whole patch process ended.
queueActivatedComponent(componentInstance)
} else {
activateChildComponent(componentInstance, true /* direct */)
}
}
},
destroy (vnode: MountedComponentVNode) {
const { componentInstance } = vnode
if (!componentInstance._isDestroyed) {
if (!vnode.data.keepAlive) {
componentInstance.$destroy()
} else {
deactivateChildComponent(componentInstance, true /* direct */)
}
}
}
}
const hooksToMerge = Object.keys(componentVNodeHooks)
function installComponentHooks (data: VNodeData) {
const hooks = data.hook || (data.hook = {})
for (let i = 0; i < hooksToMerge.length; i++) {
const key = hooksToMerge[i]
const existing = hooks[key]
const toMerge = componentVNodeHooks[key]
if (existing !== toMerge && !(existing && existing._merged)) {
hooks[key] = existing ? mergeHook(toMerge, existing) : toMerge
}
}
}
function mergeHook (f1: any, f2: any): Function {
const merged = (a, b) => {
// flow complains about extra args which is why we use any
f1(a, b)
f2(a, b)
}
merged._merged = true
return merged
}
-
整个
installComponentHooks
的过程就是把componentVNodeHooks
的钩子函数合并到data.hook
中,在VNode
执行patch
的过程中执行相关的钩子函数。这里要注意的是合并策略,在合并过程中,如果某个时机的钩子已经存在data.hook
中,那么通过执行mergeHook
函数做合并,这个逻辑很简单,就是在最终执行的时候,依次执行这两个钩子函数即可。 -
实例化
VNode
,如下所示:
const name = Ctor.options.name || tag
const vnode = new VNode(
`vue-component-${Ctor.cid}${name ? `-${name}` : ''}`,
data, undefined, undefined, undefined, context,
{ Ctor, propsData, listeners, tag, children },
asyncFactory
)
return vnode
最后一步非常简单,通过
new VNode
实例化一个vnode
并返回。需要注意的是和普通元素节点的vnode
不同,组件的vnode
是没有children
的,这点很关键,在之后的patch
过程中我们会再提。
- 总结:这里我们分析了
createComponent
的实现,了解到它在渲染一个组件的时候的三个关键逻辑:构造子类构造函数,安装组件钩子函数和实例化vnode
。createComponent
后返回的是组件vnode
,它也一样走到vm._update
方法,进而执行了patch
函数。
三、patch 的理解
-
当我们通过
createComponent
创建了组件VNode
,接下来会走到vm._update
,执行vm.__patch__
去把VNode
转换成真正的DOM
节点。针对一个普通的VNode
节点,会有哪些不一样的地方。 -
patch
的过程会调用createElm
创建元素节点,回顾一下createElm
的实现,它的定义在src/core/vdom/patch.js
中:
function createElm (
vnode,
insertedVnodeQueue,
parentElm,
refElm,
nested,
ownerArray,
index
) {
// ...
if (createComponent(vnode, insertedVnodeQueue, parentElm, refElm)) {
return
}
// ...
}
createComponent
,我们删掉多余的代码,只保留关键的逻辑,这里会判断createComponent(vnode, insertedVnodeQueue, parentElm, refElm)
的返回值,如果为true
则直接结束,那么接下来看一下createComponent
方法的实现,如下所示:
function createComponent (vnode, insertedVnodeQueue, parentElm, refElm) {
let i = vnode.data
if (isDef(i)) {
const isReactivated = isDef(vnode.componentInstance) && i.keepAlive
if (isDef(i = i.hook) && isDef(i = i.init)) {
i(vnode, false /* hydrating */)
}
// after calling the init hook, if the vnode is a child component
// it should've created a child instance and mounted it. the child
// component also has set the placeholder vnode's elm.
// in that case we can just return the element and be done.
if (isDef(vnode.componentInstance)) {
initComponent(vnode, insertedVnodeQueue)
insert(parentElm, vnode.elm, refElm)
if (isTrue(isReactivated)) {
reactivateComponent(vnode, insertedVnodeQueue, parentElm, refElm)
}
return true
}
}
}
createComponent
函数中,首先对vnode.data
做了一些判断:
let i = vnode.data
if (isDef(i)) {
// ...
if (isDef(i = i.hook) && isDef(i = i.init)) {
i(vnode, false /* hydrating */)
// ...
}
// ..
}
如果
vnode
是一个组件 VNode,那么条件会满足,并且得到i
就是init
钩子函数,回顾上节我们在创建组件 VNode 的时候合并钩子函数中就包含init
钩子函数,定义在src/core/vdom/create-component.js
中:
init (vnode: VNodeWithData, hydrating: boolean): ?boolean {
if (
vnode.componentInstance &&
!vnode.componentInstance._isDestroyed &&
vnode.data.keepAlive
) {
// kept-alive components, treat as a patch
const mountedNode: any = vnode // work around flow
componentVNodeHooks.prepatch(mountedNode, mountedNode)
} else {
const child = vnode.componentInstance = createComponentInstanceForVnode(
vnode,
activeInstance
)
child.$mount(hydrating ? vnode.elm : undefined, hydrating)
}
},
init
钩子函数执行也很简单,我们先不考虑keepAlive
的情况,它是通过createComponentInstanceForVnode
创建一个 Vue 的实例,然后调用$mount
方法挂载子组件,
先来看一下createComponentInstanceForVnode
的实现:
export function createComponentInstanceForVnode (
vnode: any, // we know it's MountedComponentVNode but flow doesn't
parent: any, // activeInstance in lifecycle state
): Component {
const options: InternalComponentOptions = {
_isComponent: true,
_parentVnode: vnode,
parent
}
// check inline-template render functions
const inlineTemplate = vnode.data.inlineTemplate
if (isDef(inlineTemplate)) {
options.render = inlineTemplate.render
options.staticRenderFns = inlineTemplate.staticRenderFns
}
return new vnode.componentOptions.Ctor(options)
}
createComponentInstanceForVnode
函数构造的一个内部组件的参数,然后执行new vnode.componentOptions.Ctor(options)
。这里的vnode.componentOptions.Ctor
对应的就是子组件的构造函数,它实际上是继承于Vue
的一个构造器Sub
,相当于new Sub(options)
这里有几个关键参数要注意几个点,_isComponent
为true
表示它是一个组件,parent
表示当前激活的组件实例。所以子组件的实例化实际上就是在这个时机执行的,并且它会执行实例的_init
方法,这个过程有一些和之前不同的地方需要挑出来说,代码在src/core/instance/init.js
中:
Vue.prototype._init = function (options?: Object) {
const vm: Component = this
// merge options
if (options && options._isComponent) {
// optimize internal component instantiation
// since dynamic options merging is pretty slow, and none of the
// internal component options needs special treatment.
initInternalComponent(vm, options)
} else {
vm.$options = mergeOptions(
resolveConstructorOptions(vm.constructor),
options || {},
vm
)
}
// ...
if (vm.$options.el) {
vm.$mount(vm.$options.el)
}
}
这里首先是合并
options
的过程有变化,_isComponent
为 true,所以走到了initInternalComponent
过程,这个函数的实现也简单看一下:
export function initInternalComponent (vm: Component, options: InternalComponentOptions) {
const opts = vm.$options = Object.create(vm.constructor.options)
// doing this because it's faster than dynamic enumeration.
const parentVnode = options._parentVnode
opts.parent = options.parent
opts._parentVnode = parentVnode
const vnodeComponentOptions = parentVnode.componentOptions
opts.propsData = vnodeComponentOptions.propsData
opts._parentListeners = vnodeComponentOptions.listeners
opts._renderChildren = vnodeComponentOptions.children
opts._componentTag = vnodeComponentOptions.tag
if (options.render) {
opts.render = options.render
opts.staticRenderFns = options.staticRenderFns
}
}
- 这个过程我们重点记住以下几个点即可:
opts.parent = options.parent
、opts._parentVnode = parentVnode
,它们是把之前我们通过createComponentInstanceForVnode
函数传入的几个参数合并到内部的选项$options
里了。再来看一下_init
函数最后执行的代码:
if (vm.$options.el) {
vm.$mount(vm.$options.el)
}
- 由于组件初始化的时候是不传
el
的,因此组件是自己接管了$mount
的过程,回到组件init
的过程,componentVNodeHooks
的init
钩子函数,在完成实例化的_init
后,接着会执行child.$mount(hydrating ? vnode.elm : undefined, hydrating)
。这里hydrating
为true
一般是服务端渲染的情况,我们只考虑客户端渲染,所以这里$mount
相当于执行child.$mount(undefined, false)
,它最终会调用mountComponent
方法,进而执行vm._render()
方法:
Vue.prototype._render = function (): VNode {
const vm: Component = this
const { render, _parentVnode } = vm.$options
// set parent vnode. this allows render functions to have access
// to the data on the placeholder node.
vm.$vnode = _parentVnode
// render self
let vnode
try {
vnode = render.call(vm._renderProxy, vm.$createElement)
} catch (e) {
// ...
}
// set parent
vnode.parent = _parentVnode
return vnode
}
-
我们只保留关键部分的代码,这里的
_parentVnode
就是当前组件的父VNode
,而render
函数生成的vnode
当前组件的渲染vnode
,vnode
的parent
指向了_parentVnode
,也就是vm.$vnode
,它们是一种父子的关系。 -
我们知道在执行完
vm._render
生成VNode
后,接下来就要执行vm._update
去渲染VNode
了。来看一下组件渲染的过程中有哪些需要注意的,vm._update
的定义在src/core/instance/lifecycle.js
中:
export let activeInstance: any = null
Vue.prototype._update = function (vnode: VNode, hydrating?: boolean) {
const vm: Component = this
const prevEl = vm.$el
const prevVnode = vm._vnode
const prevActiveInstance = activeInstance
activeInstance = vm
vm._vnode = vnode
// Vue.prototype.__patch__ is injected in entry points
// based on the rendering backend used.
if (!prevVnode) {
// initial render
vm.$el = vm.__patch__(vm.$el, vnode, hydrating, false /* removeOnly */)
} else {
// updates
vm.$el = vm.__patch__(prevVnode, vnode)
}
activeInstance = prevActiveInstance
// update __vue__ reference
if (prevEl) {
prevEl.__vue__ = null
}
if (vm.$el) {
vm.$el.__vue__ = vm
}
// if parent is an HOC, update its $el as well
if (vm.$vnode && vm.$parent && vm.$vnode === vm.$parent._vnode) {
vm.$parent.$el = vm.$el
}
// updated hook is called by the scheduler to ensure that children are
// updated in a parent's updated hook.
}
_update
过程中有几个关键的代码,首先vm._vnode = vnode
的逻辑,这个vnode
是通过vm._render()
返回的组件渲染VNode
,vm._vnode
和vm.$vnode
的关系就是一种父子关系,用代码表达就是vm._vnode.parent === vm.$vnode
,还有一段比较有意思的代码:
export let activeInstance: any = null
Vue.prototype._update = function (vnode: VNode, hydrating?: boolean) {
// ...
const prevActiveInstance = activeInstance
activeInstance = vm
if (!prevVnode) {
// initial render
vm.$el = vm.__patch__(vm.$el, vnode, hydrating, false /* removeOnly */)
} else {
// updates
vm.$el = vm.__patch__(prevVnode, vnode)
}
activeInstance = prevActiveInstance
// ...
}
- 这个
activeInstance
作用就是保持当前上下文的Vue
实例,它是在lifecycle
模块的全局变量,定义是export let activeInstance: any = null
,并且在之前我们调用createComponentInstanceForVnode
方法的时候从lifecycle
模块获取,并且作为参数传入的。因为实际上JavaScript
是一个单线程,Vue
整个初始化是一个深度遍历的过程,在实例化子组件的过程中,它需要知道当前上下文的Vue
实例是什么,并把它作为子组件的父Vue
实例。子组件的实例化过程先会调用initInternalComponent(vm, options)
合并options
,把parent
存储在vm.$options
中,在$mount
之前会调用initLifecycle(vm)
方法,如下所示:
export function initLifecycle (vm: Component) {
const options = vm.$options
// locate first non-abstract parent
let parent = options.parent
if (parent && !options.abstract) {
while (parent.$options.abstract && parent.$parent) {
parent = parent.$parent
}
parent.$children.push(vm)
}
vm.$parent = parent
// ...
}
可以看到
vm.$parent
就是用来保留当前vm
的父实例,并且通过parent.$children.push(vm)
来把当前的vm
存储到父实例的$children
中。
- 在
vm._update
的过程中,把当前的vm
赋值给activeInstance
,同时通过const prevActiveInstance = activeInstance
用prevActiveInstance
保留上一次的activeInstance
。实际上,prevActiveInstance
和当前的vm
是一个父子关系,当一个vm
实例完成它的所有子树的patch
或者update
过程后,activeInstance
会回到它的父实例,这样就完美地保证了createComponentInstanceForVnode
整个深度遍历过程中,我们在实例化子组件的时候能传入当前子组件的父Vue
实例,并在_init
的过程中,通过vm.$parent
把这个父子关系保留。
那么回到_update
,最后就是调用__patch__
渲染 VNode 了,如下所示:
vm.$el = vm.__patch__(vm.$el, vnode, hydrating, false /* removeOnly */)
function patch (oldVnode, vnode, hydrating, removeOnly) {
// ...
let isInitialPatch = false
const insertedVnodeQueue = []
if (isUndef(oldVnode)) {
// empty mount (likely as component), create new root element
isInitialPatch = true
createElm(vnode, insertedVnodeQueue)
} else {
// ...
}
// ...
}
- 这里又回到了开始的过程,之前分析过负责渲染成
DOM
的函数是createElm
,注意这里我们只传了 两个参数,所以对应的parentElm
是undefined
,我们再来看看它的定义,如下所示:
function createElm (
vnode,
insertedVnodeQueue,
parentElm,
refElm,
nested,
ownerArray,
index
) {
// ...
if (createComponent(vnode, insertedVnodeQueue, parentElm, refElm)) {
return
}
const data = vnode.data
const children = vnode.children
const tag = vnode.tag
if (isDef(tag)) {
// ...
vnode.elm = vnode.ns
? nodeOps.createElementNS(vnode.ns, tag)
: nodeOps.createElement(tag, vnode)
setScope(vnode)
/* istanbul ignore if */
if (__WEEX__) {
// ...
} else {
createChildren(vnode, children, insertedVnodeQueue)
if (isDef(data)) {
invokeCreateHooks(vnode, insertedVnodeQueue)
}
insert(parentElm, vnode.elm, refElm)
}
// ...
} else if (isTrue(vnode.isComment)) {
vnode.elm = nodeOps.createComment(vnode.text)
insert(parentElm, vnode.elm, refElm)
} else {
vnode.elm = nodeOps.createTextNode(vnode.text)
insert(parentElm, vnode.elm, refElm)
}
}
-
注意,这里我们传入的
vnode
是组件渲染的vnode
,也就是我们之前说的vm._vnode
,如果组件的根节点是个普通元素,那么vm._vnode
也是普通的vnode
,这里createComponent(vnode, insertedVnodeQueue, parentElm, refElm)
的返回值是false
。接下来的过程就和之前一样了,先创建一个父节点占位符,然后再遍历所有子VNode
递归调用createElm
,在遍历的过程中,如果遇到子VNode
是一个组件的VNode
,则重复本节开始的过程,这样通过一个递归的方式就可以完整地构建了整个组件树。 -
由于我们这个时候传入的
parentElm
是空,所以对组件的插入,在createComponent
有这么一段逻辑,如下所示:
function createComponent (vnode, insertedVnodeQueue, parentElm, refElm) {
let i = vnode.data
if (isDef(i)) {
// ....
if (isDef(i = i.hook) && isDef(i = i.init)) {
i(vnode, false /* hydrating */)
}
// ...
if (isDef(vnode.componentInstance)) {
initComponent(vnode, insertedVnodeQueue)
insert(parentElm, vnode.elm, refElm)
if (isTrue(isReactivated)) {
reactivateComponent(vnode, insertedVnodeQueue, parentElm, refElm)
}
return true
}
}
}
在完成组件的整个
patch
过程后,最后执行insert(parentElm, vnode.elm, refElm)
完成组件的 DOM 插入,如果组件patch
过程中又创建了子组件,那么DOM 的插入顺序是先子后父。
- 总结:一个组件的
VNode
是如何创建、初始化、渲染的过程也就介绍完毕了。在对组件化的实现有一个大概了解后,接下来我们来介绍一下这其中的一些细节。我们知道编写一个组件实际上是编写一个JavaScript
对象,对象的描述就是各种配置,之前我们提到在_init
的最初阶段执行的就是merge options
的逻辑,那么接下来我们从源码角度来分析合并配置的过程。
四、合并配置
-
new Vue
的过程通常有两种场景,一种是外部我们的代码主动调用new Vue(options)
的方式实例化一个Vue
对象;另一种是我们上一节分析的组件过程中内部通过new Vue(options)
实例化子组件。 -
无论哪种场景,都会执行实例的
_init(options)
方法,它首先会执行一个merge options
的逻辑,相关的代码在src/core/instance/init.js
中,如下所示:
Vue.prototype._init = function (options?: Object) {
// merge options
if (options && options._isComponent) {
// optimize internal component instantiation
// since dynamic options merging is pretty slow, and none of the
// internal component options needs special treatment.
initInternalComponent(vm, options)
} else {
vm.$options = mergeOptions(
resolveConstructorOptions(vm.constructor),
options || {},
vm
)
}
// ...
}
- 可以看到不同场景对于
options
的合并逻辑是不一样的,并且传入的options
值也有非常大的不同,接下来会从两种场景的options
合并过程。为了更直观,我们可以举个简单的示例,如下所示:
import Vue from 'vue'
let childComp = {
template: '<div>{{msg}}</div>',
created() {
console.log('child created')
},
mounted() {
console.log('child mounted')
},
data() {
return {
msg: 'Hello Vue'
}
}
}
Vue.mixin({
created() {
console.log('parent created')
}
})
let app = new Vue({
el: '#app',
render: h => h(childComp)
})
- 外部调用场景,当执行
new Vue
的时候,在执行this._init(options)
的时候,就会执行如下逻辑去合并options
:
vm.$options = mergeOptions(
resolveConstructorOptions(vm.constructor),
options || {},
vm
)
- 这里通过调用
mergeOptions
方法来合并,它实际上就是把resolveConstructorOptions(vm.constructor)
的返回值和options
做合并,resolveConstructorOptions
的实现先不考虑,在我们这个场景下,它还是简单返回vm.constructor.options
,相当于Vue.options
,那么这个值又是什么呢,其实在initGlobalAPI(Vue)
的时候定义了这个值,代码在src/core/global-api/index.js
中:
export function initGlobalAPI (Vue: GlobalAPI) {
// ...
Vue.options = Object.create(null)
ASSET_TYPES.forEach(type => {
Vue.options[type + 's'] = Object.create(null)
})
// this is used to identify the "base" constructor to extend all plain-object
// components with in Weex's multi-instance scenarios.
Vue.options._base = Vue
extend(Vue.options.components, builtInComponents)
// ...
}
- 首先通过
Vue.options = Object.create(null)
创建一个空对象,然后遍历ASSET_TYPES
,ASSET_TYPES
的定义在src/shared/constants.js
中:
export const ASSET_TYPES = [
'component',
'directive',
'filter'
]
所以上面遍历
ASSET_TYPES
后的代码相当于:
Vue.options.components = {}
Vue.options.directives = {}
Vue.options.filters = {}
-
接着执行了
Vue.options._base = Vue
,它的作用在我们上节实例化子组件的时候介绍了。 -
最后通过
extend(Vue.options.components, builtInComponents)
把一些内置组件扩展到Vue.options.components
上,Vue
的内置组件目前有<keep-alive>
、<transition>
和<transition-group>
组件,这也就是为什么我们在其它组件中使用<keep-alive>
组件不需要注册的原因。 -
那么回到
mergeOptions
这个函数,它的定义在src/core/util/options.js
中:
/**
* Merge two option objects into a new one.
* Core utility used in both instantiation and inheritance.
*/
export function mergeOptions (
parent: Object,
child: Object,
vm?: Component
): Object {
if (process.env.NODE_ENV !== 'production') {
checkComponents(child)
}
if (typeof child === 'function') {
child = child.options
}
normalizeProps(child, vm)
normalizeInject(child, vm)
normalizeDirectives(child)
const extendsFrom = child.extends
if (extendsFrom) {
parent = mergeOptions(parent, extendsFrom, vm)
}
if (child.mixins) {
for (let i = 0, l = child.mixins.length; i < l; i++) {
parent = mergeOptions(parent, child.mixins[i], vm)
}
}
const options = {}
let key
for (key in parent) {
mergeField(key)
}
for (key in child) {
if (!hasOwn(parent, key)) {
mergeField(key)
}
}
function mergeField (key) {
const strat = strats[key] || defaultStrat
options[key] = strat(parent[key], child[key], vm, key)
}
return options
}
-
mergeOptions
主要功能就是把parent
和child
这两个对象根据一些合并策略,合并成一个新对象并返回。比较核心的几步,先递归把extends
和mixins
合并到parent
上,然后遍历parent
,调用mergeField
,然后再遍历child
,如果key
不在parent
的自身属性上,则调用mergeField
。 -
这里有意思的是
mergeField
函数,它对不同的key
有着不同的合并策略。举例来说,对于生命周期函数,它的合并策略是这样的,如下所示:
function mergeHook (
parentVal: ?Array<Function>,
childVal: ?Function | ?Array<Function>
): ?Array<Function> {
return childVal
? parentVal
? parentVal.concat(childVal)
: Array.isArray(childVal)
? childVal
: [childVal]
: parentVal
}
LIFECYCLE_HOOKS.forEach(hook => {
strats[hook] = mergeHook
})
这其中的
LIFECYCLE_HOOKS
的定义在src/shared/constants.js
中:
export const LIFECYCLE_HOOKS = [
'beforeCreate',
'created',
'beforeMount',
'mounted',
'beforeUpdate',
'updated',
'beforeDestroy',
'destroyed',
'activated',
'deactivated',
'errorCaptured'
]
-
这里定义了
Vue.js
所有的钩子函数名称,所以对于钩子函数,他们的合并策略都是mergeHook
函数。这个函数的实现也非常有意思,用了一个多层三元运算符,逻辑就是如果不存在childVal
,就返回parentVal
;否则再判断是否存在parentVal
,如果存在就把childVal
添加到parentVal
后返回新数组;否则返回childVal
的数组。所以回到mergeOptions
函数,一旦parent
和child
都定义了相同的钩子函数,那么它们会把两个钩子函数合并成一个数组。 -
通过执行
mergeField
函数,把合并后的结果保存到options
对象中,最终返回它。因此,在我们当前这个case
下,执行完如下合并后:
vm.$options = mergeOptions(
resolveConstructorOptions(vm.constructor),
options || {},
vm
)
vm.$options
的值差不多是如下这样:
vm.$options = {
components: { },
created: [
function created() {
console.log('parent created')
}
],
directives: { },
filters: { },
_base: function Vue(options) {
// ...
},
el: "#app",
render: function (h) {
//...
}
}
- 组件场景,由于组件的构造函数是通过
Vue.extend
继承自Vue
的,先回顾一下这个过程,代码定义在src/core/global-api/extend.js
中:
/**
* Class inheritance
*/
Vue.extend = function (extendOptions: Object): Function {
// ...
Sub.options = mergeOptions(
Super.options,
extendOptions
)
// ...
// keep a reference to the super options at extension time.
// later at instantiation we can check if Super's options have
// been updated.
Sub.superOptions = Super.options
Sub.extendOptions = extendOptions
Sub.sealedOptions = extend({}, Sub.options)
// ...
return Sub
}
我们只保留关键逻辑,这里的
extendOptions
对应的就是前面定义的组件对象,它会和Vue.options
合并到Sub.opitons
中。
- 接下来子组件的初始化过程,代码定义在
src/core/vdom/create-component.js
中:
export function createComponentInstanceForVnode (
vnode: any, // we know it's MountedComponentVNode but flow doesn't
parent: any, // activeInstance in lifecycle state
): Component {
const options: InternalComponentOptions = {
_isComponent: true,
_parentVnode: vnode,
parent
}
// ...
return new vnode.componentOptions.Ctor(options)
}
- 这里的
vnode.componentOptions.Ctor
就是指向Vue.extend
的返回值Sub
, 所以 执行new vnode.componentOptions.Ctor(options)
接着执行this._init(options)
,因为options._isComponent
为 true,那么合并options
的过程走到了initInternalComponent(vm, options)
逻辑。先来看一下它的代码实现,在src/core/instance/init.js
中:
export function initInternalComponent (vm: Component, options: InternalComponentOptions) {
const opts = vm.$options = Object.create(vm.constructor.options)
// doing this because it's faster than dynamic enumeration.
const parentVnode = options._parentVnode
opts.parent = options.parent
opts._parentVnode = parentVnode
const vnodeComponentOptions = parentVnode.componentOptions
opts.propsData = vnodeComponentOptions.propsData
opts._parentListeners = vnodeComponentOptions.listeners
opts._renderChildren = vnodeComponentOptions.children
opts._componentTag = vnodeComponentOptions.tag
if (options.render) {
opts.render = options.render
opts.staticRenderFns = options.staticRenderFns
}
}
-
initInternalComponent
方法首先执行const opts = vm.$options = Object.create(vm.constructor.options)
,这里的vm.constructor
就是子组件的构造函数Sub
,相当于vm.$options = Object.create(Sub.options)
。 -
接着又把实例化子组件传入的子组件父
VNode
实例parentVnode
、子组件的父Vue
实例parent
保存到vm.$options
中,另外还保留了parentVnode
配置中的如propsData
等其它的属性。这么看来,initInternalComponent
只是做了简单一层对象赋值,并不涉及到递归、合并策略等复杂逻辑。因此,在我们当前这个case
下,执行完如下合并后:
initInternalComponent(vm, options)
vm.$options
的值差不多是如下这样:
vm.$options = {
parent: Vue /*父Vue实例*/,
propsData: undefined,
_componentTag: undefined,
_parentVnode: VNode /*父VNode实例*/,
_renderChildren:undefined,
__proto__: {
components: { },
directives: { },
filters: { },
_base: function Vue(options) {
//...
},
_Ctor: {},
created: [
function created() {
console.log('parent created')
}, function created() {
console.log('child created')
}
],
mounted: [
function mounted() {
console.log('child mounted')
}
],
data() {
return {
msg: 'Hello Vue'
}
},
template: '<div>{{msg}}</div>'
}
}
- 总结:
Vue
初始化阶段对于options
的合并过程就介绍完了,我们需要知道对于options
的合并有两种方式,子组件初始化过程通过initInternalComponent
方式要比外部初始化 Vue 通过mergeOptions
的过程要快,合并完的结果保留在vm.$options
中。纵观一些库、框架的设计几乎都是类似的,自身定义了一些默认配置,同时又可以在初始化阶段传入一些定义配置,然后去merge
默认配置,来达到定制化不同需求的目的。只不过在Vue
的场景下,会对merge
的过程做一些精细化控制,虽然我们在开发自己的JSSDK
的时候并没有Vue
这么复杂,但这个设计思想是值得我们借鉴的。