10.1 普通插槽
插槽将<slot></slot>
作为子组件承载分发的载体,简单的用法如下
10.1.1 基础用法
var child = {
template: `<div class="child"><slot></slot></div>`
}
var vm = new Vue({
el: '#app',
components: {
child
},
template: `<div id="app"><child>test</child></div>`
})
// 最终渲染结果
<div class="child">test</div>
10.1.2 组件挂载原理
插槽的原理,贯穿了整个组件系统编译到渲染的过程,所以首先需要回顾一下对组件相关编译渲染流程,简单总结一下几点:
- 从根实例入手进行实例的挂载,如果有手写的
render
函数,则直接进入$mount
挂载流程。 - 只有
template
模板则需要对模板进行解析,这里分为两个阶段,一个是将模板解析为AST
树,另一个是根据不同平台生成执行代码,例如render
函数。 $mount
流程也分为两步,第一步是将render
函数生成Vnode
树,如果遇到子组件会先生成子组件,子组件会以vue-componet-
为tag
标记,另一步是把Vnode
渲染成真正的DOM节点。- 创建真实节点过程中,如果遇到子的占位符组件会进行子组件的实例化过程,这个过程又将回到流程的第一步。
接下来我们对slot
的分析将围绕这四个具体的流程展开。
10.1.3 父组件处理
回到组件实例流程中,父组件会优先于子组件进行实例的挂载,模板的解析和render
函数的生成阶段在处理上没有特殊的差异,这里就不展开分析。接下来是render
函数生成Vnode
的过程,在这个阶段会遇到子的占位符节点(即:child
),因此会为子组件创建子的Vnode
。createComponent
执行了创建子占位节点Vnode
的过程。我们把重点放在最终Vnode
代码的生成。
// 创建子Vnode过程
function createComponent (
Ctor, // 子类构造器
data,
context, // vm实例
children, // 父组件需要分发的内容
tag // 子组件占位符
){
···
// 创建子vnode,其中父保留的children属性会以选项的形式传递给Vnode
var vnode = new VNode(
("vue-component-" + (Ctor.cid) + (name ? ("-" + name) : '')),
data, undefined, undefined, undefined, context,
{ Ctor: Ctor, propsData: propsData, listeners: listeners, tag: tag, children: children },
asyncFactory
);
}
// Vnode构造器
var VNode = function VNode (tag,data,children,text,elm,context,componentOptions,asyncFactory) {
···
this.componentOptions = componentOptions; // 子组件的选项相关
}
createComponent
函数接收的第四个参数children
就是父组件需要分发的内容。在创建子Vnode
过程中,会以会componentOptions
配置传入Vnode
构造器中。最终Vnode
中父组件需要分发的内容以componentOptions
属性的形式存在,这是插槽分析的第一步。
10.1.4 子组件流程
父组件的最后一个阶段是将Vnode
渲染为真正的DOM节点,在这个过程中如果遇到子Vnode
会优先实例化子组件并进行一系列子组件的渲染流程。子组件初始化会先调用_init
方法,并且和父组件不同的是,子组件会调用initInternalComponent
方法拿到父组件拥有的相关配置信息,并赋值给子组件自身的配置选项。
// 子组件的初始化
Vue.prototype._init = function(options) {
if (options && options._isComponent) {
initInternalComponent(vm, options);
}
initRender(vm)
}
function initInternalComponent (vm, options) {
var opts = vm.$options = Object.create(vm.constructor.options);
var parentVnode = options._parentVnode;
opts.parent = options.parent;
opts._parentVnode = parentVnode;
// componentOptions为子vnode记录的相关信息
var vnodeComponentOptions = parentVnode.componentOptions;
opts.propsData = vnodeComponentOptions.propsData;
opts._parentListeners = vnodeComponentOptions.listeners;
// 父组件需要分发的内容赋值给子选项配置的_renderChildren
opts._renderChildren = vnodeComponentOptions.children;
opts._componentTag = vnodeComponentOptions.tag;
if (options.render) {
opts.render = options.render;
opts.staticRenderFns = options.staticRenderFns;
}
}
最终在子组件实例的配置中拿到了父组件保存的分发内容,记录在组件实例$options._renderChildren
中,这是第二步的重点。
接下来是子组件的实例化会进入initRender
阶段,在这个过程会将配置的_renderChildren
属性做规范化处理,并将他赋值给子实例上的$slot
属性,这是第三步的重点。
function initRender(vm) {
···
vm.$slots = resolveSlots(options._renderChildren, renderContext);// $slots拿到了子占位符节点的_renderchildren(即需要分发的内容),保留作为子实例的属性
}
function resolveSlots (children,context) {
// children是父组件需要分发到子组件的Vnode节点,如果不存在,则没有分发内容
if (!children || !children.length) {
return {}
}
var slots = {};
for (var i = 0, l = children.length; i < l; i++) {
var child = children[i];
var data = child.data;
// remove slot attribute if the node is resolved as a Vue slot node
if (data && data.attrs && data.attrs.slot) {
delete data.attrs.slot;
}
// named slots should only be respected if the vnode was rendered in the
// same context.
// 分支1为具名插槽的逻辑,放后分析
if ((child.context === context || child.fnContext === context) &&
data && data.slot != null
) {
var name = data.slot;
var slot = (slots[name] || (slots[name] = []));
if (child.tag === 'template') {
slot.push.apply(slot, child.children || []);
} else {
slot.push(child);
}
} else {
// 普通插槽的重点,核心逻辑是构造{ default: [children] }对象返回
(slots.default || (slots.default = [])).push(child);
}
}
return slots
}
其中普通插槽的处理逻辑核心在(slots.default || (slots.default = [])).push(child);
,即以数组的形式赋值给default
属性,并以$slot
属性的形式保存在子组件的实例中。
随后子组件也会走挂载的流程,同样会经历template
模板到render
函数,再到Vnode
,最后渲染真实DOM
的过程。解析AST
阶段,slot
标签和其他普通标签处理相同,不同之处在于AST
生成render
函数阶段,对slot
标签的处理,会使用_t函数
进行包裹。这是关键步骤的第四步
子组件渲染的大致流程简单梳理如下:
// ast 生成 render函数
var code = generate(ast, options);
// generate实现
function generate(ast, options) {
var state = new CodegenState(options);
var code = ast ? genElement(ast, state) : '_c("div")';
return {
render: ("with(this){return " + code + "}"),
staticRenderFns: state.staticRenderFns
}
}
// genElement实现
function genElement(el, state) {
// 针对slot标签的处理走```genSlot```分支
if (el.tag === 'slot') {
return genSlot(el, state)
}
}
// 核心genSlot原理
function genSlot (el, state) {
// slotName记录着插槽的唯一标志名,默认为default
var slotName = el.slotName || '"default"';
// 如果子组件的插槽还有子元素,则会递归调执行子元素的创建过程
var children = genChildren(el, state);
// 通过_t函数包裹
var res = "_t(" + slotName + (children ? ("," + children) : '');
// 具名插槽的其他处理
···
return res + ')'
}
最终子组件的render
函数为:
"with(this){return _c('div',{staticClass:"child"},[_t("default")],2)}"
第五步到了子组件渲染为Vnode
的过程。render
函数执行阶段会执行_t()
函数,_t
函数是renderSlot
函数简写,它会在Vnode
树中进行分发内容的替换,具体看看实现逻辑。
// target._t = renderSlot;
// render函数渲染Vnode函数
Vue.prototype._render = function() {
var _parentVnode = ref._parentVnode;
if (_parentVnode) {
// slots的规范化处理并赋值给$scopedSlots属性。
vm.$scopedSlots = normalizeScopedSlots(
_parentVnode.data.scopedSlots,
vm.$slots, // 记录父组件的插槽内容
vm.$scopedSlots
);
}
}
normalizeScopedSlots
的逻辑较长,但并不是本节的重点。拿到$scopedSlots
属性后会执行真正的render
函数,其中_t
的执行逻辑如下:
// 渲染slot组件内容
function renderSlot (
name,
fallback, // slot插槽后备内容(针对后备内容)
props, // 子传给父的值(作用域插槽)
bindObject
) {
// scopedSlotFn拿到父组件插槽的执行函数,默认slotname为default
var scopedSlotFn = this.$scopedSlots[name];
var nodes;
// 具名插槽分支(暂时忽略)
if (scopedSlotFn) { // scoped slot
props = props || {};
if (bindObject) {
if (!isObject(bindObject)) {
warn(
'slot v-bind without argument expects an Object',
this
);
}
props = extend(extend({}, bindObject), props);
}
// 执行时将子组件传递给父组件的值传入fn
nodes = scopedSlotFn(props) || fallback;
} else {
// 如果父占位符组件没有插槽内容,this.$slots不会有值,此时vnode节点为后备内容节点。
nodes = this.$slots[name] || fallback;
}
var target = props && props.slot;
if (target) {
return this.$createElement('template', { slot: target }, nodes)
} else {
return nodes
}
}
renderSlot
执行过程会拿到父组件需要分发的内容,最终Vnode
树将父元素的插槽替换掉子组件的slot
组件。
最后一步就是子组件真实节点的渲染了,这点没有什么特别点,和以往介绍的流程一致。
至此,一个完整且简单的插槽流程分析完毕。接下来看插槽深层次的用法。