关于vue.js:Vue-源码解读5-全局-API

47次阅读

共计 12343 个字符，预计需要花费 31 分钟才能阅读完成。

当学习成为了习惯，常识也就变成了常识。 感激各位的 点赞 、 珍藏 和评论。

新视频和文章会第一工夫在微信公众号发送，欢送关注：李永宁 lyn

文章已收录到 github 仓库 liyongning/blog，欢送 Watch 和 Star。

指标

深刻了解以下全局 API 的实现原理。

  • Vue.use
  • Vue.mixin
  • Vue.component
  • Vue.filter
  • Vue.directive
  • Vue.extend
  • Vue.set
  • Vue.delete
  • Vue.nextTick

源码解读

从该系列的第一篇文章 Vue 源码解读（1）—— 前言 中的 源码目录构造 介绍中能够得悉，Vue 的泛滥全局 API 的实现大部分都放在 /src/core/global-api 目录下。这些全局 API 源码浏览入口则是在 /src/core/global-api/index.js 文件中。

入口

/src/core/global-api/index.js

/**
 * 初始化 Vue 的泛滥全局 API，比方：*   默认配置：Vue.config
 *   工具办法：Vue.util.xx
 *   Vue.set、Vue.delete、Vue.nextTick、Vue.observable
 *   Vue.options.components、Vue.options.directives、Vue.options.filters、Vue.options._base
 *   Vue.use、Vue.extend、Vue.mixin、Vue.component、Vue.directive、Vue.filter
 *   
 */
export function initGlobalAPI (Vue: GlobalAPI) {
  // config
  const configDef = {}
  // Vue 的泛滥默认配置项
  configDef.get = () => config

  if (process.env.NODE_ENV !== 'production') {configDef.set = () => {
      warn('Do not replace the Vue.config object, set individual fields instead.')
    }
  }

  // Vue.config
  Object.defineProperty(Vue, 'config', configDef)

  /**
   * 裸露一些工具办法，轻易不要应用这些工具办法，解决你很分明这些工具办法，以及晓得应用的危险
   */
  Vue.util = {
    // 正告日志
    warn,
    // 相似选项合并
    extend,
    // 合并选项
    mergeOptions,
    // 设置响应式
    defineReactive
  }

  // Vue.set / delete / nextTick
  Vue.set = set
  Vue.delete = del
  Vue.nextTick = nextTick

  // 响应式办法
  Vue.observable = <T>(obj: T): T => {observe(obj)
    return obj
  }

  // Vue.options.compoents/directives/filter
  Vue.options = Object.create(null)
  ASSET_TYPES.forEach(type => {Vue.options[type + 's'] = Object.create(null)
  })

  // 将 Vue 构造函数挂载到 Vue.options._base 上
  Vue.options._base = Vue

  // 在 Vue.options.components 中增加内置组件，比方 keep-alive
  extend(Vue.options.components, builtInComponents)

  // Vue.use
  initUse(Vue)
  // Vue.mixin
  initMixin(Vue)
  // Vue.extend
  initExtend(Vue)
  // Vue.component/directive/filter
  initAssetRegisters(Vue)
}

Vue.use

/src/core/global-api/use.js

/**
 * 定义 Vue.use，负责为 Vue 装置插件，做了以下两件事：*   1、判断插件是否曾经被装置，如果装置则间接完结
 *   2、装置插件，执行插件的 install 办法
 * @param {*} plugin install 办法 或者 蕴含 install 办法的对象
 * @returns Vue 实例
 */
Vue.use = function (plugin: Function | Object) {
  // 曾经装置过的插件列表
  const installedPlugins = (this._installedPlugins || (this._installedPlugins = []))
  // 判断 plugin 是否曾经装置，保障不反复装置
  if (installedPlugins.indexOf(plugin) > -1) {return this}

  // 将 Vue 构造函数放到第一个参数地位，而后将这些参数传递给 install 办法
  const args = toArray(arguments, 1)
  args.unshift(this)

  if (typeof plugin.install === 'function') {
    // plugin 是一个对象，则执行其 install 办法装置插件
    plugin.install.apply(plugin, args)
  } else if (typeof plugin === 'function') {
    // 执行间接 plugin 办法装置插件
    plugin.apply(null, args)
  }
  // 在 插件列表中 增加新装置的插件
  installedPlugins.push(plugin)
  return this
}

Vue.mixin

/src/core/global-api/mixin.js

/**
 * 定义 Vue.mixin，负责全局混入选项，影响之后所有创立的 Vue 实例，这些实例会合并全局混入的选项
 * @param {*} mixin Vue 配置对象
 * @returns 返回 Vue 实例
 */
Vue.mixin = function (mixin: Object) {
  // 在 Vue 的默认配置项上合并 mixin 对象
  this.options = mergeOptions(this.options, mixin)
  return this
}

mergeOptions

src/core/util/options.js

/**
 * 合并两个选项，呈现雷同配置项时，子选项会笼罩父选项的配置
 */
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}

  // 标准化 props、inject、directive 选项，不便后续程序的解决
  normalizeProps(child, vm)
  normalizeInject(child, vm)
  normalizeDirectives(child)

  // 解决原始 child 对象上的 extends 和 mixins，别离执行 mergeOptions，将这些继承而来的选项合并到 parent
  // mergeOptions 解决过的对象会含有 _base 属性
  if (!child._base) {if (child.extends) {parent = mergeOptions(parent, child.extends, 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)
    }
  }

  // 合并选项，childVal 优先级高于 parentVal
  function mergeField (key) {
    // strat 是合并策略函数，如何 key 抵触，则 childVal 会 笼罩 parentVal
    const strat = strats[key] || defaultStrat
    // 值为如果 childVal 存在则优先应用 childVal，否则应用 parentVal
    options[key] = strat(parent[key], child[key], vm, key)
  }
  return options
}

Vue.component、Vue.filter、Vue.directive

/src/core/global-api/assets.js

这三个 API 实现比拟非凡，然而原理又很类似，所以就放在了一起实现。

const ASSET_TYPES = ['component', 'directive', 'filter']

/**
 * 定义 Vue.component、Vue.filter、Vue.directive 这三个办法
 * 这三个办法所做的事件是相似的，就是在 this.options.xx 上寄存对应的配置
 * 比方 Vue.component(compName, {xx}) 后果是 this.options.components.compName = 组件构造函数
 * ASSET_TYPES = ['component', 'directive', 'filter']
 */
ASSET_TYPES.forEach(type => {
  /**
   * 比方：Vue.component(name, definition)
   * @param {*} id name
   * @param {*} definition 组件构造函数或者配置对象 
   * @returns 返回组件构造函数
   */
  Vue[type] = function (
    id: string,
    definition: Function | Object
  ): Function | Object | void {if (!definition) {return this.options[type + 's'][id]
    } else {if (type === 'component' && isPlainObject(definition)) {
        // 如果组件配置中存在 name，则应用，否则间接应用 id
        definition.name = definition.name || id
        // extend 就是 Vue.extend，所以这时的 definition 就变成了 组件构造函数，应用时可间接 new Definition()
        definition = this.options._base.extend(definition)
      }
      if (type === 'directive' && typeof definition === 'function') {definition = { bind: definition, update: definition}
      }
      // this.options.components[id] = definition
      // 在实例化时通过 mergeOptions 将全局注册的组件合并到每个组件的配置对象的 components 中
      this.options[type + 's'][id] = definition
      return definition
    }
  }
})

Vue.extend

/src/core/global-api/extend.js

/**
 * Each instance constructor, including Vue, has a unique
 * cid. This enables us to create wrapped "child
 * constructors" for prototypal inheritance and cache them.
 */
Vue.cid = 0
let cid = 1

/**
 * 基于 Vue 去扩大子类，该子类同样反对进一步的扩大
 * 扩大时能够传递一些默认配置，就像 Vue 也会有一些默认配置
 * 默认配置如果和基类有抵触则会进行选项合并（mergeOptions)
 */
Vue.extend = function (extendOptions: Object): Function {extendOptions = extendOptions || {}
  const Super = this
  const SuperId = Super.cid

  /**
   * 利用缓存，如果存在则间接返回缓存中的构造函数
   * 什么状况下能够利用到这个缓存？*   如果你在屡次调用 Vue.extend 时应用了同一个配置项（extendOptions），这时就会启用该缓存
   */
  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)
  }

  // 定义 Sub 构造函数，和 Vue 构造函数一样
  const Sub = function VueComponent(options) {
    // 初始化
    this._init(options)
  }
  // 通过原型继承的形式继承 Vue
  Sub.prototype = Object.create(Super.prototype)
  Sub.prototype.constructor = Sub
  Sub.cid = cid++
  // 选项合并，合并 Vue 的配置项到 本人的配置项上来
  Sub.options = mergeOptions(
    Super.options,
    extendOptions
  )
  // 记录本人的基类
  Sub['super'] = Super

  // 初始化 props，将 props 配置代理到 Sub.prototype._props 对象上
  // 在组件内通过 this._props 形式能够拜访
  if (Sub.options.props) {initProps(Sub)
  }

  // 初始化 computed，将 computed 配置代理到 Sub.prototype 对象上
  // 在组件内能够通过 this.computedKey 的形式拜访
  if (Sub.options.computed) {initComputed(Sub)
  }

  // 定义 extend、mixin、use 这三个静态方法，容许在 Sub 根底上再进一步结构子类
  Sub.extend = Super.extend
  Sub.mixin = Super.mixin
  Sub.use = Super.use

  // 定义 component、filter、directive 三个静态方法
  ASSET_TYPES.forEach(function (type) {Sub[type] = Super[type]
  })

  // 递归组件的原理，如果组件设置了 name 属性，则将本人注册到本人的 components 选项中
  if (name) {Sub.options.components[name] = Sub
  }

  // 在扩大时保留对基类选项的援用。// 稍后在实例化时，咱们能够查看 Super 的选项是否具备更新
  Sub.superOptions = Super.options
  Sub.extendOptions = extendOptions
  Sub.sealedOptions = extend({}, Sub.options)

  // 缓存
  cachedCtors[SuperId] = Sub
  return Sub
}

function initProps (Comp) {
  const props = Comp.options.props
  for (const key in props) {proxy(Comp.prototype, `_props`, key)
  }
}

function initComputed (Comp) {
  const computed = Comp.options.computed
  for (const key in computed) {defineComputed(Comp.prototype, key, computed[key])
  }
}

Vue.set

/src/core/global-api/index.js

Vue.set = set

set

/src/core/observer/index.js

/**
 * 通过 Vue.set 或者 this.$set 办法给 target 的指定 key 设置值 val
 * 如果 target 是对象，并且 key 本来不存在，则为新 key 设置响应式，而后执行依赖告诉
 */
export function set (target: Array<any> | Object, key: any, val: any): any {
  if (process.env.NODE_ENV !== 'production' &&
    (isUndef(target) || isPrimitive(target))
  ) {warn(`Cannot set reactive property on undefined, null, or primitive value: ${(target: any)}`)
  }
  // 更新数组指定下标的元素，Vue.set(array, idx, val)，通过 splice 办法实现响应式更新
  if (Array.isArray(target) && isValidArrayIndex(key)) {target.length = Math.max(target.length, key)
    target.splice(key, 1, val)
    return val
  }
  // 更新对象已有属性，Vue.set(obj, key, val)，执行更新即可
  if (key in target && !(key in Object.prototype)) {target[key] = val
    return val
  }
  const ob = (target: any).__ob__
  // 不能向 Vue 实例或者 $data 增加动静增加响应式属性，vmCount 的用途之一，// this.$data 的 ob.vmCount = 1，示意根组件，其它子组件的 vm.vmCount 都是 0
  if (target._isVue || (ob && ob.vmCount)) {
    process.env.NODE_ENV !== 'production' && warn(
      'Avoid adding reactive properties to a Vue instance or its root $data' +
      'at runtime - declare it upfront in the data option.'
    )
    return val
  }
  // target 不是响应式对象，新属性会被设置，然而不会做响应式解决
  if (!ob) {target[key] = val
    return val
  }
  // 给对象定义新属性，通过 defineReactive 办法设置响应式，并触发依赖更新
  defineReactive(ob.value, key, val)
  ob.dep.notify()
  return val
}

Vue.delete

/src/core/global-api/index.js

Vue.delete = del

del

/src/core/observer/index.js

/**
 * 通过 Vue.delete 或者 vm.$delete 删除 target 对象的指定 key
 * 数组通过 splice 办法实现，对象则通过 delete 运算符删除指定 key，并执行依赖告诉
 */
export function del (target: Array<any> | Object, key: any) {
  if (process.env.NODE_ENV !== 'production' &&
    (isUndef(target) || isPrimitive(target))
  ) {warn(`Cannot delete reactive property on undefined, null, or primitive value: ${(target: any)}`)
  }

  // target 为数组，则通过 splice 办法删除指定下标的元素
  if (Array.isArray(target) && isValidArrayIndex(key)) {target.splice(key, 1)
    return
  }
  const ob = (target: any).__ob__

  // 防止删除 Vue 实例的属性或者 $data 的数据
  if (target._isVue || (ob && ob.vmCount)) {
    process.env.NODE_ENV !== 'production' && warn(
      'Avoid deleting properties on a Vue instance or its root $data' +
      '- just set it to null.'
    )
    return
  }
  // 如果属性不存在间接完结
  if (!hasOwn(target, key)) {return}
  // 通过 delete 运算符删除对象的属性
  delete target[key]
  if (!ob) {return}
  // 执行依赖告诉
  ob.dep.notify()}

Vue.nextTick

/src/core/global-api/index.js

Vue.nextTick = nextTick

nextTick

/src/core/util/next-tick.js

对于 nextTick 办法更加具体解析，能够查看上一篇文章 Vue 源码解读（4）—— 异步更新。

const callbacks = []
/**
 * 实现两件事：*   1、用 try catch 包装 flushSchedulerQueue 函数，而后将其放入 callbacks 数组
 *   2、如果 pending 为 false，示意当初浏览器的工作队列中没有 flushCallbacks 函数
 *     如果 pending 为 true，则示意浏览器的工作队列中曾经被放入了 flushCallbacks 函数，*     待执行 flushCallbacks 函数时，pending 会被再次置为 false，示意下一个 flushCallbacks 函数能够进入
 *     浏览器的工作队列了
 * pending 的作用：保障在同一时刻，浏览器的工作队列中只有一个 flushCallbacks 函数
 * @param {*} cb 接管一个回调函数 => flushSchedulerQueue
 * @param {*} ctx 上下文
 * @returns 
 */
export function nextTick (cb?: Function, ctx?: Object) {
  let _resolve
  // 用 callbacks 数组存储通过包装的 cb 函数
  callbacks.push(() => {if (cb) {
      // 用 try catch 包装回调函数，便于谬误捕捉
      try {cb.call(ctx)
      } catch (e) {handleError(e, ctx, 'nextTick')
      }
    } else if (_resolve) {_resolve(ctx)
    }
  })
  if (!pending) {
    pending = true
    // 执行 timerFunc，在浏览器的工作队列中（首选微工作队列）放入 flushCallbacks 函数
    timerFunc()}
  // $flow-disable-line
  if (!cb && typeof Promise !== 'undefined') {
    return new Promise(resolve => {_resolve = resolve})
  }
}

总结

  • 面试官 问：Vue.use(plugin) 做了什么？

    答：

    负责装置 plugin 插件，其实就是执行插件提供的 install 办法。

    • 首先判断该插件是否曾经装置过
    • 如果没有，则执行插件提供的 install 办法装置插件，具体做什么有插件本人决定

  • 面试官 问：Vue.mixin(options) 做了什么？

    答：

    负责在 Vue 的全局配置上合并 options 配置。而后在每个组件生成 vnode 时会将全局配置合并到组件本身的配置上来。

    • 标准化 options 对象上的 props、inject、directive 选项的格局
    • 解决 options 上的 extends 和 mixins，别离将他们合并到全局配置上
    • 而后将 options 配置和全局配置进行合并，选项抵触时 options 配置会笼罩全局配置

  • 面试官 问：Vue.component(compName, Comp) 做了什么？

    答：

    负责注册全局组件。其实就是将组件配置注册到全局配置的 components 选项上（options.components），而后各个子组件在生成 vnode 时会将全局的 components 选项合并到部分的 components 配置项上。

    • 如果第二个参数为空，则示意获取 compName 的组件构造函数
    • 如果 Comp 是组件配置对象，则应用 Vue.extend 办法失去组件构造函数，否则间接进行下一步
    • 在全局配置上设置组件信息，this.options.components.compName = CompConstructor

  • 面试官 问：Vue.directive(‘my-directive’, {xx}) 做了什么？

    答：

    在全局注册 my-directive 指令，而后每个子组件在生成 vnode 时会将全局的 directives 选项合并到部分的 directives 选项中。原理同 Vue.component 办法：

    • 如果第二个参数为空，则获取指定指令的配置对象
    • 如果不为空，如果第二个参数是一个函数的话，则生成配置对象 {bind: 第二个参数, update: 第二个参数}
    • 而后将指令配置对象设置到全局配置上，this.options.directives['my-directive'] = {xx}

  • 面试官 问：Vue.filter(‘my-filter’, function(val) {xx}) 做了什么？

    答：

    负责在全局注册过滤器 my-filter，而后每个子组件在生成 vnode 时会将全局的 filters 选项合并到部分的 filters 选项中。原理是：

    • 如果没有提供第二个参数，则获取 my-filter 过滤器的回调函数
    • 如果提供了第二个参数，则是设置 this.options.filters['my-filter'] = function(val) {xx}。

  • 面试官 问：Vue.extend(options) 做了什么？

    答：

    Vue.extend 基于 Vue 创立一个子类，参数 options 会作为该子类的默认全局配置，就像 Vue 的默认全局配置一样。所以通过 Vue.extend 扩大一个子类，一大用处就是内置一些公共配置，供子类的子类应用。

    • 定义子类构造函数，这里和 Vue 一样，也是调用 _init(options)
    • 合并 Vue 的配置和 options，如果选项抵触，则 options 的选项会笼罩 Vue 的配置项
    • 给子类定义全局 API，值为 Vue 的全局 API，比方 Sub.extend = Super.extend，这样子类同样能够扩大出其它子类
    • 返回子类 Sub

  • 面试官 问：Vue.set(target, key, val) 做了什么

    答：

    因为 Vue 无奈探测一般的新增 property (比方 this.myObject.newProperty = ‘hi’)，所以通过 Vue.set 为向响应式对象中增加一个 property，能够确保这个新 property 同样是响应式的，且触发视图更新。

    • 更新数组指定下标的元素：Vue.set(array, idx, val)，外部通过 splice 办法实现响应式更新
    • 更新对象已有属性：Vue.set(obj, key ,val)，间接更新即可 => obj[key] = val
    • 不能向 Vue 实例或者 $data 动静增加根级别的响应式数据
    • Vue.set(obj, key, val)，如果 obj 不是响应式对象，会执行 obj[key] = val，然而不会做响应式解决
    • Vue.set(obj, key, val)，为响应式对象 obj 减少一个新的 key，则通过 defineReactive 办法设置响应式，并触发依赖更新

  • 面试官 问：Vue.delete(target, key) 做了什么？

    答：

    删除对象的 property。如果对象是响应式的，确保删除能触发更新视图。这个办法次要用于避开 Vue 不能检测到 property 被删除的限度，然而你应该很少会应用它。当然同样不能删除根级别的响应式属性。

    • Vue.delete(array, idx)，删除指定下标的元素，外部是通过 splice 办法实现的
    • 删除响应式对象上的某个属性：Vue.delete(obj, key)，外部是执行 delete obj.key，而后执行依赖更新即可

  • 面试官 问：Vue.nextTick(cb) 做了什么？

    答：

    Vue.nextTick(cb) 办法的作用是提早回调函数 cb 的执行，个别用于 this.key = newVal 更改数据后，想立刻获取更改过后的 DOM 数据：

    this.key = 'new val'

Vue.nextTick(function() {// DOM 更新了})

    其外部的执行过程是：

    • this.key = 'new val，触发依赖告诉更新，将负责更新的 watcher 放入 watcher 队列
    • 将刷新 watcher 队列的函数放到 callbacks 数组中
    • 在浏览器的异步工作队列中放入一个刷新 callbacks 数组的函数
    • Vue.nextTick(cb) 来插队，将 cb 函数放入 callbacks 数组
    • 待未来的某个时刻执行刷新 callbacks 数组的函数
    • 而后执行 callbacks 数组中的泛滥函数，触发 watcher.run 的执行，更新 DOM
    • 因为 cb 函数是在前面放到 callbacks 数组，所以这就保障了先实现的 DOM 更新，再执行 cb 函数

链接

  • 配套视频，微信公众号回复：” 精通 Vue 技术栈源码原理视频版 ” 获取
  • 精通 Vue 技术栈源码原理 专栏
  • github 仓库 liyongning/Vue 欢送 Star

感激各位的：点赞 、 珍藏 和评论，咱们下期见。

当学习成为了习惯，常识也就变成了常识。 感激各位的 点赞 、 珍藏 和评论。

新视频和文章会第一工夫在微信公众号发送，欢送关注：李永宁 lyn

文章已收录到 github 仓库 liyongning/blog，欢送 Watch 和 Star。

正文完
vue.js
发表至： vue.js
2022-02-25
 0
关于vue.js:vue-appjs-venderjs过大优化
关于vue.js:vue-routerview使用详解
关于vue.js:🚀vue3封装一个符合思维简单实用的弹出层
关于vue.js:关于vue2的Ref的特点