Vue.js源码分析——Slots是如何实现的

见贤思齐

今天主要分析Vue.js中常用的Slots功能是如何设计和实现的。本文将分为普通插槽、作用域插槽以及Vue.js 2.6.x版本的 v-slot语法三部分进行讨论。本文属于进阶内容，如果有还不懂Slots用法的同学，建议先移步 Vue.js 官网进行学习。1普通插槽首先举一个Slots使用的简单例子。      this is slot default content text.  直接在页面上渲染这个组件，效果如下图所示：接着，我们对Slots 里的内容进行覆盖。thisisslotcustomcontent.重新渲染后，效果如下图所示：Slots的用法大家肯定都很清楚了，那么这背后Vue.js执行了怎样的逻辑呢？接下来我们一起看看Vue.js底层对Slots的具体实现。1.1vm.$slots首先看看Vue.js的Component接口上对$slots属性的定义。$slots:{[key:string]:Array};多的咱不说，咱直接在控制台打印一下上面例子中的$slots ：接下来讲解Slots内容渲染以及转换成上图对象的过程。1.2renderSlot看完了具体实例中Slots渲染后的vm.$slots对象，我们来解析一下renderSlot这块的逻辑，首先我们先看看renderSlot函数的参数都有哪些：export function renderSlot (  name: string, // 插槽名 slotName  fallback: ?Array, // 插槽默认内容生成的 vnode 数组  props: ?Object, // props 对象  bindObject: ?Object // v-bind 绑定对象): ?Array {}这里我们先不看scoped-slot的逻辑，只看普通slot的逻辑：const slotNodes = this.$slots[name]nodes = slotNodes || fallbackreturn nodes这里拿到this.$slots[name]的值后做了一个空值判断，若存在则直接返回其对应的vnode数组，否则返回fallback。1.3resolveSlots看到这，很多人可能不知道this.$slots在哪定义的，解释这个之前，我们要先了解另外一个方法resolveSlots 。export function resolveSlots (  children: ?Array, // 父节点的 children  context: ?Component // 父节点的上下文，即父组件的 vm 实例): { [key: string]: Array } {}看完resolveSlots的定义后我们接着往后看其中的具体逻辑。这里先定义了一个slots的空对象，如果参数children不存在，直接返回。const slots = {}if (!children) {  return slots}如果存在，则对children进行遍历操作。for (let i = 0, l = children.length; i  `${camelize(a.name)}{a.value}`).join(',')}}` // 将 attrs 转换成对象形式  const bind = el.attrsMap['v-bind'] // 获取 slot 上的 v-bind 属性    // 若 attrs 或者 bind 属性存在但是 children 却木得，直接赋值第二参数为 null  if ((attrs || bind) & !children) {    res += `,null`  }    // 若 attrs 存在，则将 attrs 作为 `_t()` 的第三个参数(普通插槽的逻辑处理)  if (attrs) {    res += `,${attrs}`  }    // 若 bind 存在，这时如果 attrs 存在，则 bind 作为第三个参数，否则 bind 作为第四个参数(scoped-slot 的逻辑处理)  if (bind) {    res += `${attrs ? '' : ',null'},${bind}`  }  return res + ')'}上面的slotName在processSlot函数中进行了赋值，并且父组件编译阶段用到的slotTarget也在这里进行了处理。// src/compiler/parser/index.jsfunction processSlot (el) {  if (el.tag === 'slot') {    // 直接获取 attr 里面 name 的值    el.slotName = getBindingAttr(el, 'name')    // ...  }  // ...  const slotTarget = getBindingAttr(el, 'slot')  if (slotTarget) {    // 如果 slotTarget 存在则直接取命名插槽的 slot 值，否则直接为 'default'    el.slotTarget = slotTarget === '""' ? '"default"' : slotTarget    if (el.tag !== 'template' & !el.slotScope) {      addAttr(el, 'slot', slotTarget)    }  }}随即在genData函数中使用slotTarget进行data的数据拼接。if (el.slotTarget & !el.slotScope) {  data += `slot{el.slotTarget},`}此时父组件将生成以下代码：with(this) {  return _c('div', [    _c('slot-demo'),    {      attrs: { slot: 'default' },      slot: 'default'    },    [ _v('this is slot custom content.') ]  ])}然后当el.tag为slot的情况，直接执行genSlot函数：else if (el.tag === 'slot') {  return genSlot(el, state)}按照我们举出的例子，子组件最终会生成以下代码：with(this) {  // _c => createElement ; _t => renderSlot ; _v => createTextVNode  return _c(    'div',    {      staticClass: 'slot-demo'    },    [ _t('default', [ _v('this is slot default content text.') ]) ]  )}2作用域插槽上面我们已经了解到Vue.js对于普通的Slots 是如何进行处理和转换的。接下来我们来分析下作用域插槽的实现逻辑。2.1vm.$scopedSlots老规矩，先看看Vue.js的Component接口上对$scopedSlots 属性的定义。$scopedSlots: { [key: string]: () => VNodeChildren };其中的VNodeChildren定义如下：declare type VNodeChildren = Array | string;先来个相关的例子：        然后进行使用：                     {{ scope.text }}         {{ scope.msg }}            效果如下：从例子中我们能看出用法，子组件的slot标签上绑定text以及:msg属性。然后父组件在使用插槽用slot-scope属性去读取插槽属性对应的值。2.2processSlot提及一下processSlot函数对于slot-scope的处理逻辑：let slotScopeif (el.tag === 'template') {    slotScope = getAndRemoveAttr(el, 'scope')  // 兼容 2.5 以前版本 slot scope 的用法(这块有个警告，我直接忽略掉了)    el.slotScope = slotScope || getAndRemoveAttr(el, 'slot-scope')} else if ((slotScope = getAndRemoveAttr(el, 'slot-scope'))) {    el.slotScope = slotScope }从上面的代码我们能看出，Vue.js 直接读取slot-scope属性并赋值给AST抽象语法树的slotScope属性，而拥有slotScope属性的节点，会直接以插槽名称name为key、本身为value的对象形式挂载在父节点的scopedSlots属性上。else if (element.slotScope) {     currentParent.plain = false    const name = element.slotTarget || '"default"'    (currentParent.scopedSlots || (currentParent.scopedSlots = {}))[name] = element}然后在renderMixin函数中对vm.$scopedSlots进行了如下赋值：// src/core/instance/render.jsif (_parentVnode) {  vm.$scopedSlots = _parentVnode.data.scopedSlots || emptyObject}然后genData函数里会进行以下逻辑处理：if (el.scopedSlots) {  data += `${genScopedSlots(el, el.scopedSlots, state)},`}2.3genScopedSlots&genScopedSlot紧接着我们来看看genScopedSlots函数中的逻辑：function genScopedSlots (  slots: { [key: string]: ASTElement },  state: CodegenState): string {  // 对 el.scopedSlots 对象进行遍历，执行 genScopedSlot，且将结果用逗号进行拼接  // _u => resolveScopedSlots (具体逻辑下面一个小节进行分析)  return `scopedSlots:_u([${    Object.keys(slots).map(key => {      return genScopedSlot(key, slots[key], state)    }).join(',')  }])`}然后我们再来看看genScopedSlot函数是如何生成renderfunction字符串的：function genScopedSlot (  key: string,  el: ASTElement,  state: CodegenState): string {  if (el.for & !el.forProcessed) {    return genForScopedSlot(key, el, state)  }  // 函数参数为标签上 slot-scope 属性对应的值 (getAndRemoveAttr(el, 'slot-scope'))  const fn = `function(${String(el.slotScope)}){` +    `return ${el.tag === 'template'      ? el.if        ? `${el.if}?${genChildren(el, state) || 'undefined'}:undefined`        : genChildren(el, state) || 'undefined'      : genElement(el, state)    }}`  // key 为插槽名称，fn 为生成的函数代码  return `{key{key},fn{fn}}`}我们把上面例子的$scopedSlots在控制台打印一下，结果如下：上面例子中父组件最终会生成如下代码：with(this){  // _c => createElement ; _u => resolveScopedSlots  // _v => createTextVNode ; _s => toString  return _c('div',    { staticClass: 'parent-slot' },    [_c('slot-demo',      { scopedSlots: _u([        {          key: 'default',          fn: function(scope) {            return [              _c('p', [ _v(_s(scope.text)) ]),              _c('p', [ _v(_s(scope.msg)) ])            ]          }        }])      }    )]  )}2.4renderSlot(slot-scope)&renderSlot上面我们提及对于插槽渲染逻辑的时候忽略了slot-scope的相关逻辑，这里我们来看看这部分内容：export function renderSlot (  name: string,  fallback: ?Array,  props: ?Object,  bindObject: ?Object): ?Array {  const scopedSlotFn = this.$scopedSlots[name]  let nodes  if (scopedSlotFn) { // scoped slot    props = props || {}    // ...    nodes = scopedSlotFn(props) || fallback  } // ... return nodes}resolveScopedSlots()这里renderHelps函数里面的_u，即resolveScopedSlots，其逻辑如下：export function resolveScopedSlots (  fns: ScopedSlotsData, // Array  res?: Object): { [key: string]: Function } {  res = res || {}  // 遍历 fns 数组，生成一个 `key 为插槽名称，value 为函数` 的对象  for (let i = 0; i       this is demo slot.      然后：      this is custom slot.           {{ scope.text }}{{ scope.msg }}      3.2相同与区别3.2.1$slots&$scopedSlots$slots这块逻辑没变，还是沿用的以前的代码：// $slotsconst options = vm.$optionsconst parentVnode = vm.$vnode = options._parentVnodeconst renderContext = parentVnode & parentVnode.contextvm.$slots = resolveSlots(options._renderChildren, renderContext)$scopedSlots 这块则进行了改造，执行了 normalizeScopedSlots() 并接收其返回值为 $scopedSlots 的值if (_parentVnode) {  vm.$scopedSlots = normalizeScopedSlots(    _parentVnode.data.scopedSlots,    vm.$slots,    vm.$scopedSlots  )}接着，我们来会一会normalizeScopedSlots，首先我们先看看它的定义：export function normalizeScopedSlots (  slots: { [key: string]: Function } | void,  // 某节点 data 属性上 scopedSlots  normalSlots: { [key: string]: Array }, // 当前节点下的普通插槽  prevSlots?: { [key: string]: Function } | void // 当前节点下的特殊插槽): any {}首先，如果slots不存在，则直接返回一个空对象{} ：if (!slots) {  res = {}}若prevSlots存在，且满足系列条件的情况，则直接返回prevSlots ：const hasNormalSlots = Object.keys(normalSlots).length > 0 // 是否拥有普通插槽const isStable = slots ? !!slots.$stable : !hasNormalSlots // slots 上的 $stable 值const key = slots & slots.$key // slots 上的 $key 值else if (  isStable &  prevSlots &  prevSlots !== emptyObject &  key === prevSlots.$key & // slots $key 值与 prevSlots $key 相等  !hasNormalSlots & // slots 中没有普通插槽  !prevSlots.$hasNormal // prevSlots 中没有普通插槽) {  return prevSlots}注：这里的key,hasNormal,$stable是直接使用Vue.js内部对Object.defineProperty封装好的def方法进行赋值的。def(res, '$stable', isStable)def(res, '$key', key)def(res, '$hasNormal', hasNormalSlots)//否则，则对 slots 对象进行遍历，操作 normalSlots ，赋值给 key 为 key，value 为 normalizeScopedSlot 返回的函数 的对象 reslet reselse {  res = {}  for (const key in slots) {    if (slots[key] & key[0] !== ') {      res[key] = normalizeScopedSlot(normalSlots, key, slots[key])    }  }}随后再次对normalSlots进行遍历，若normalSlots中的key在res找不到对应的key，则直接进行proxyNormalSlot代理操作，将normalSlots中的slot挂载到res对象上。for (const key in normalSlots) {  if (!(key in res)) {    res[key] = proxyNormalSlot(normalSlots, key)  }}function proxyNormalSlot(slots, key) {  return () => slots[key]}接着，我们看看normalizeScopedSlot函数都做了些什么事情。该方法接收三个参数，第一个参数为normalSlots，第二个参数为key，第三个参数为fn。function normalizeScopedSlot(normalSlots, key, fn) {  const normalized = function () {    // 若参数为多个，则直接使用 arguments 作为 fn 的参数，否则直接传空对象作为 fn 的参数    let res = arguments.length ? fn.apply(null, arguments) : fn({})    // fn 执行返回的 res 不是数组，则是单 vnode 的情况，赋值为 [res] 即可    // 否则执行 normalizeChildren 操作，这块主要对针对 slot 中存在 v-for 操作    res = res & typeof res === 'object' & !Array.isArray(res)      ? [res] // single vnode      : normalizeChildren(res)    return res & (      res.length === 0 ||      (res.length === 1 & res[0].isComment) // slot 上 v-if 相关处理    ) ? undefined      : res  }  // v-slot 语法糖处理  if (fn.proxy) {    Object.defineProperty(normalSlots, key, {      get: normalized,      enumerable: true,      configurable: true    })  }  return normalized}3.2.2renderSlot这块逻辑处理其实和之前是一样的，只是删除了一些警告的代码而已。这点这里就不展开叙述了。3.2.3processSlot首先，这里解析 slot 的方法名从processSlot变成了processSlotContent ，但其实前面的逻辑和以前是一样的。只是新增了一些对于v-slot的逻辑处理，下面我们就来捋捋这块。过具体逻辑前，我们先看一些相关的正则和方法。相关正则&functions//dynamicArgRE 动态参数匹配const dynamicArgRE = /^\[.*\]$/ // 匹配到 '[]' 则为 true，如 '[ item ]'//slotRE 匹配 v-slot 语法相关正则const slotRE = /^v-slot(:|$)|^#/ // 匹配到 'v-slot' 或 'v-slot:' 则为 true//getAndRemoveAttrByRegex 通过正则匹配绑定的 attr 值export function getAndRemoveAttrByRegex (  el: ASTElement,  name: RegExp // ) {  const list = el.attrsList // attrsList 类型为 Array