[JavaScript知识库]vue项目中plugin插件开发姿势

插件使用场景

插件通常用来为 Vue 添加全局功能。插件的功能范围没有严格的限制——一般有下面几种：

1. 添加全局方法或者 property。
2. 添加全局资源：指令/过滤器/过渡等。
3. 通过全局混入来添加一些组件选项。
4. 添加 Vue 实例方法，通过把它们添加到 Vue.prototype 上实现。
5. 一个库，提供自己的 API，同时提供上面提到的一个或多个功能。如 vue-router。

开发插件

Vue.js 的插件应该暴露一个 install 方法。这个方法的第一个参数是 Vue 构造器，第二个参数是一个可选的选项对象：

MyPlugin.install = function (Vue, options) {
  // 1. 添加全局方法或 property
  Vue.myGlobalMethod = function () {
    // 逻辑...
  }

  // 2. 添加全局资源
  Vue.directive('my-directive', {
    bind (el, binding, vnode, oldVnode) {
      // 逻辑...
    }
    ...
  })

  // 3. 注入组件选项
  Vue.mixin({
    created: function () {
      // 逻辑...
    }
    ...
  })

  // 4. 添加实例方法
  Vue.prototype.$myMethod = function (methodOptions) {
    // 逻辑...
  }
}

插件注册

在调用 new Vue() 启动应用之前, 通过全局方法 Vue.use() 注册插件。

Vue.use(MyPlugin, { someOption: true })

new Vue({
  // ...组件选项
})

企业项目中如何使用

一般企业级的开发项目，会在src文件夹下新建plugin文件夹，专门存放自定义插件。

在该文件夹中定义一个插件的结构

• plugin
  • index.js
  • backtop（文件夹）示例组件名
    • index.js
    • src（文件夹）
      • main.vue

backtop/src/main.vue 中编写组件内容

<template>
	...
</template>

<script>
export default {
 	name: 'Backtop',
	...
};
</script>

backtop/index.js 导出组件

import Backtop from './src/main';
export default Backtop;

在plugin/index.js中导入组件

import Backtop from "./backtop/index.js";

const components = [
    Backtop
]

const install = function (Vue, opts = {}) {
    console.log(Vue, opts);
    components.forEach(component => {
        Vue.component(component.name, component);
    });
}

export default {
    install
}

最后在main.js中注册plugin

import plugins from "../src/plugins/index.js";

Vue.use(plugins);

new Vue({
	...
  	render: h => h(App)
}).$mount('#app')

创作打卡挑战赛

赢取流量/现金/CSDN周边激励大奖