时间:2023-01-15 11:42:55 | 栏目:vue | 点击:次
Vue项目能够使用很多插件来丰富自己的功能,例如Vue-Router
、Vuex……,这么多插件供我们使用,节省了我们大量的人力和物力,那这些插件是开发出来的呢?是不是我们自己也想拥有一个属于自己的vue插件,下面就展示一下如何写一个自己的Vue插件。
Vue插件可以是一个包含install
方法的Object
对象,此时插件被调用时会调用install方法,
如下所示:
export default { // 接收两个参数 // app: 应用上下文的实例 // options:插件输入的选项 install: (app, options) => { console.log('app', app); console.log('options', options); // 做一些处理 // …… } }
Vue插件也可以是一个function
函数,此时插件被调用时会调用function
函数本身,
如下所示:
export default function TestPlugin(app, options) { console.log('app', app); console.log('options', options); }
上述已经阐述了如何编写自己的插件,插件编写完了之后就需要使用这些插件了,那这些插件应该如何使用呢?其实用起来很简单,应用上下文的实例上提供了对应的use方法。
app.use(plugin, [options]); // 返回一个应用实例,所以其可以链式添加新的插件
为什么app.use()
可以使用这些插件呢?本着“知其然而知其所以然”的精神,一起来扒一扒为什么。如下是对应的源码:
function createApp(rootComponent, rootProps = null) { // …… const installedPlugins = new Set(); const app = (context.app = { // …… use(plugin, ...options) { if (installedPlugins.has(plugin)) { warn(`Plugin has already been applied to target app.`); } else if (plugin && shared.isFunction(plugin.install)) { installedPlugins.add(plugin); plugin.install(app, ...options); } else if (shared.isFunction(plugin)) { installedPlugins.add(plugin); plugin(app, ...options); } else { warn(`A plugin must either be a function or an object with an "install" ` + `function.`); } return app; }, // …… }); return app; };
上述代码读起来很简单,其实现了以下几件事情:
Set
结构存储插件,当存在该插件时抛出异常;install
方法或是否是函数,执行对应的插件;app
上下文实例和options
作为参数传入;