浅谈Vue.use

先举个?

咱们先来看一个简单的事例
首先我使用官方脚手架新建一个项目vue init webpack vue-demo
而后我建立两个文件index.js plugins.js.
我将这两个文件放置在src/classes/vue-use目录下javascript

接下来对这两个文件进行编写vue

// 文件:  src/classes/vue-use/plugins.js

const Plugin1 = {
    install(a, b, c) {
        console.log('Plugin1 第一个参数:', a);
        console.log('Plugin1 第二个参数:', b);
        console.log('Plugin1 第三个参数:', c);
    },
};

function Plugin2(a, b, c) {
    console.log('Plugin2 第一个参数:', a);
    console.log('Plugin2 第二个参数:', b);
    console.log('Plugin2 第三个参数:', c);
}

export { Plugin1, Plugin2 };
// 文件: src/classes/vue-use/index.js

import Vue from 'vue';

import { Plugin1, Plugin2 } from './plugins';

Vue.use(Plugin1, '参数1', '参数2');
Vue.use(Plugin2, '参数A', '参数B');

而后咱们在入口文件main.js引用这段代码java

// 文件: src/main.js

import Vue from 'vue';

import '@/classes/vue-use';
import App from './App';
import router from './router';

Vue.config.productionTip = false;

/* eslint-disable no-new */
new Vue({
    el: '#app',
    router,
    render: h => h(App),
});

此时咱们执行npm run dev打开8080端口开启开发调试工具能够看到控制台输出如下信息
clipboard.png...]webpack

从中能够发现咱们在plugin1中的install方法编写的三个console都打印出来,第一个打印出来的是Vue对象,第二个跟第三个是咱们传入的两个参数。
plugin2没有install方法,它自己就是一个方法,也能打印三个参数,第一个是Vue对象,第二个跟第三个也是咱们传入的两个参数。web

那么如今咱们是否是大概对Vue.use有一个模糊的猜测~npm

分析源码

好咱们仍是不要猜测,直接上源码api

// Vue源码文件路径:src/core/global-api/use.js

import { toArray } from '../util/index'

export function initUse (Vue: GlobalAPI) {
  Vue.use = function (plugin: Function | Object) {
    const installedPlugins = (this._installedPlugins || (this._installedPlugins = []))
    if (installedPlugins.indexOf(plugin) > -1) {
      return this
    }

    // additional parameters
    const args = toArray(arguments, 1)
    args.unshift(this)
    if (typeof plugin.install === 'function') {
      plugin.install.apply(plugin, args)
    } else if (typeof plugin === 'function') {
      plugin.apply(null, args)
    }
    installedPlugins.push(plugin)
    return this
  }
}

从源码中咱们能够发现vue首先判断这个插件是否被注册过,不容许重复注册。
而且接收的plugin参数的限制是Function | Object两种类型。
对于这两种类型有不一样的处理。
首先将咱们传入的参数整理成数组 => const args = toArray(arguments, 1)
(toArray源码)数组

// Vue源码文件路径:src/core/shared/util.js

export function toArray (list: any, start?: number): Array<any> {
  start = start || 0
  let i = list.length - start
  const ret: Array<any> = new Array(i)
  while (i--) {
    ret[i] = list[i + start]
  }
  return ret
}

再将Vue对象添加到这个数组的起始位置args.unshift(this),这里的this 指向Vue对象
若是咱们传入的plugin(Vue.use的第一个参数)的install是一个方法。也就是说若是咱们传入一个对象,对象中包含install方法,那么咱们就调用这个plugininstall方法并将整理好的数组当成参数传入install方法中。 => plugin.install.apply(plugin, args)
若是咱们传入的plugin就是一个函数,那么咱们就直接调用这个函数并将整理好的数组当成参数传入。 => plugin.apply(null, args)
以后给这个插件添加至已经添加过的插件数组中,标示已经注册过 => installedPlugins.push(plugin)
最后返回Vue对象。app

小结

经过以上分析咱们能够知道,在咱们之后编写插件的时候能够有两种方式。
一种是将这个插件的逻辑封装成一个对象最后将最后在install编写业务代码暴露给Vue对象。这样作的好处是能够添加任意参数在这个对象上方便将install函数封装得更加精简,可拓展性也比较高。
还有一种则是将全部逻辑都编写成一个函数暴露给Vue。
其实两种方法原理都同样,无非第二种就是将这个插件直接当成install函数来处理。
我的以为第一种方式比较合理。
举个?函数

export const Plugin = {
    install(Vue) {
        Vue.component...
        Vue.mixins...
        Vue...
        // 咱们也能够在install里面执行其余函数,Vue会将this指向咱们的插件
        console.log(this)  // {install: ...,utils: ...}
        this.utils(Vue)    // 执行utils函数
        console.log(this.COUNT) // 0
    },
    utils(Vue) {
        Vue...
        console.log(Vue)  // Vue
    },
    COUNT: 0    
}
// 咱们能够在这个对象上添加参数,最终Vue只会执行install方法,而其余方法能够做为封装install方法的辅助函数

const test = 'test'
export function Plugin2(Vue) {
    Vue...
    console.log(test)  // 'test'
    // 注意若是插件编写成函数形式,那么Vue只会把this指向null,并不会指向这个函数
    console.log(this)  // null
}
// 这种方式咱们只能在一个函数中编写插件逻辑,可封装性就不是那么强了

小弟不才,对vue源码的理解暂且到这。欢迎大佬们多指教~

相关文章
相关标签/搜索