解释
Vue.use
其实就是一个 Vue
提供的全局 api
, 我们在做项目的时候经常遇到要用一些不管是官方推荐的或者是第三方的插件, 例如 Vue-Router
, Vuex
, Element-UI
等等
这些第三方库和插件一般都是在项目的 main.js
文件中进行初始化, 且初始化的方法就是使用 Vue.use(插件名)
我们先来从使用到分析 Vue.use
是怎么实现的
语法
Vue.use(plugin, arguments)
参数:
{Object | Function} plugin
用法:
安装
Vue.js
插件。如果插件是一个对象,必须提供install
方法。如果插件是一个函数,它会被作为install
方法。install
方法调用时,会将 Vue 作为参数传入。该方法需要在调用
new Vue()
之前被调用。当
install
方法被同一个插件多次调用,插件将只会被安装一次参考 插件
举个🌰
首先新建两个文件
plugin.js
:
1 | // 文件: src/plugins.js |
index.js
:
1 | // 文件: src/use/index.js |
然后在入口文件 main.js
里面引入 index.js
1 | // 文件: src/main.js |
此时我们执行 npm run dev
打开 8080
端口开启开发调试工具可以看到控制台输出以下信息
从中可以发现我们在 plugin1
中的 install
方法编写的三个 console
都打印出来,第一个打印出来的是 Vue
对象,第二个跟第三个是我们传入的两个参数。
而 plugin2
没有 install
方法,它本身就是一个方法,也能打印三个参数,第一个是 Vue
对象,第二个跟第三个也是我们传入的两个参数。
分析源码
1 | // Vue源码文件路径:src/core/global-api/use.js |
从源码中我们可以发现 Vue
首先判断这个插件是否被注册过,不允许重复注册。
并且接收的 plugin
参数的限制是 Function | Object
两种类型。
对于这两种类型有不同的处理。
首先将我们传入的参数整理成数组 => const args = toArray(arguments, 1)
。
再将 Vue
对象添加到这个数组的起始位置 args.unshift(this) ,这里的this 指向 Vue
对象
如果我们传入的 plugin(Vue.use的第一个参数)
的 install
是一个方法。也就是说如果我们传入一个对象,对象中包含 install
方法,那么我们就调用这个 plugin
的 install
方法并将整理好的数组当成参数传入 install
方法中。 => plugin.install.apply(plugin, args)
如果我们传入的 plugin
就是一个函数,那么我们就直接调用这个函数并将整理好的数组当成参数传入。 => plugin.apply(null, args)
之后给这个插件添加至已经添加过的插件数组中,标示已经注册过 => installedPlugins.push(plugin)
最后返回 Vue
对象。
小结
通过以上分析我们可以知道,在我们以后编写插件的时候可以有两种方式。
一种是将这个插件的逻辑封装成一个对象最后将最后在 install
编写业务代码暴露给Vue对象。这样做的好处是可以添加任意参数在这个对象上方便将 install
函数封装得更加精简,可拓展性也比较高。
还有一种则是将所有逻辑都编写成一个函数暴露给 Vue
其实两种方法原理都一样,无非第二种就是将这个插件直接当成 install
函数来处理。
个人推荐第一种。