优雅管理Vue全局组件和插件

随着项目的不断变大，可能有些人会把插件的引入和全局组件的注册都放到main.js中，致使后面main.js里面一大坨引入代码，看起来杂乱无比，也不利于后期进行维护，因此咱们尽量的让main.js看起来整洁些。此处就用到webpack的require.context功能，实现Vue自动注册全局组件及插件，方便全局组件和插件的管理。

全局插件管理

1. 项目中新建plugins目录，和components目录保持同级。
2. plugins目录中新建index.js，以引入element-ui为例：
3. 再plugins目录中新建element.js，写入官方的引用方法（暂不考虑按需引入问题）

import Vue from 'vue'
import Element from 'element-ui'
import 'element-ui/lib/theme-chalk/index.css'

Vue.use(Element, {
 size: 'small'
})
复制代码

4. index.js中引入element.js

import './element'
复制代码

5. main.js中引入plugins中的index.js

import Vue from 'vue'
import App from './App.vue'

// 引入插件，放在此处引用是为了下面的router和store中可能会用到某些插件的功能。
import './plugins/index'

import router from './router'
import store from './store'

Vue.config.productionTip = false

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

复制代码

这样main.js看起来就清爽不少了，后面有新增的插件，只须要再plugins目录下新建相应的插件名称，而后在index.js中引入便可，再多的插件也能够很方便的进行维护。

自动注册全局组件

官网文档参考：点击前往

1. 先安装lodash

npm install i lodash
复制代码

2. components目录中新建globals目录，后面须要全局注册的组件所有放这个里面
3. plugins目中新建auto-regist.js（文件名可随意），写入如下内容

import Vue from 'vue'
import upperFirst from 'lodash/upperFirst'
import camelCase from 'lodash/camelCase'

const requireComponent = require.context(
  // 其组件目录的相对路径
  '../components/globals',
  // 是否查询其子目录
  true,
  // 匹配基础组件文件名的正则表达式
  /\w+\.vue$/
)

requireComponent.keys().forEach(fileName => {
  // 获取组件配置
  const componentConfig = requireComponent(fileName)

  // 获取组件的 PascalCase 命名
  const componentName = upperFirst(
    camelCase(
      // 获取和目录深度无关的文件名
      fileName
        .split('/')
        .pop()
        .replace(/\.\w+$/, '')
    )
  )

  // 全局注册组件
  Vue.component(
    componentName,
    // 若是这个组件选项是经过 `export default` 导出的，
    // 那么就会优先使用 `.default`，
    // 不然回退到使用模块的根。
    componentConfig.default || componentConfig
  )
})
复制代码

4. plugins中index.js引入

import './auto-regist'
import './element'
复制代码

最后能够components/globals中放一个测试组件进行测试。

更优雅加载插件

每次在plugins中新增了一个插件后都须要在index.js中引用，假若有100个这样的插件，咱们就得写100个，这里须要的和全局组件同样，在index.js中自动引入plugins中的插件，原理和上面的自动注册全局组件相似。 改造下index.js的代码：

const requirePlugin = require.context(
  // 当前plugins目录
  '/',
  // 是否查询其子目录
  false,
  // 匹配当前plugins目录下的js文件
  /.+\.js$/
)
requirePlugin.keys().forEach(fileName => {
  requirePlugin(fileName)
})


复制代码

这样就能自动加载引入plugins中的全部插件了。 可是这样会存在一个插件引入顺序问题，由于webpack是根据你文件夹中文件的位置排序的，若有A、B、C三个插件，A插件须要用到B插件提供的某个功能，这种状况下因为A插件被先引用，B后引用，致使A插件代码报错状况，这里用个取巧的方法，将A、B插件命名成如下形式：

a-2-A.js、a-1-B.js，这样B插件就会排在前面优先加载。 若是不存在依赖关系，可随意。

目录结构图

参考