快捷導(dǎo)航

教你搭建按需加載的Vue組件庫(kù)(小結(jié))

更新時(shí)間：2019年07月29日 10:25:33 作者：墨工

這篇文章主要介紹了教你搭建按需加載的Vue組件庫(kù)(小結(jié))，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

按需加載的原理

按需加載，本質(zhì)上是把一個(gè)組件庫(kù)的不同組件 拆分成不同文件 ，按照需要引用對(duì)應(yīng)的文件，而該文件暴露一個(gè) install方法 ，供Vue.use使用。比如：我只想引用element庫(kù)里的一個(gè)Button組件

import Button from 'element-ui/lib/Button.js'
import Button from 'element-ui/lib/theme-chalk/Button.css'

Vue.use(Button);

上面的寫(xiě)法比較繁瑣，而且需要知道每個(gè)組件的實(shí)際路徑，使用起來(lái)并不方便，所以我們還需要借助一個(gè)轉(zhuǎn)換插件。

先來(lái)看看 element 是怎么做的，官方的的「快速手上」：

element使用一個(gè)了babel插件，作用就是代碼轉(zhuǎn)換：

import { Button } from 'components'

// 轉(zhuǎn)換為

var button = require('components/lib/button')
require('components/lib/button/style.css')

到這我們可以知道，要搭建一個(gè)按需加載的組件庫(kù)。 主要工作 需要兩點(diǎn)：

組件獨(dú)立打包 ，單個(gè)文件對(duì)應(yīng)單個(gè)組件
引入 代碼轉(zhuǎn)換 的插件

組件代碼的編寫(xiě)規(guī)范

我們?cè)陧?xiàng)目的跟目錄建一個(gè)文件夾packages，下面放我們的組件:

packages下每一個(gè)文件夾對(duì)應(yīng)一個(gè)組件所需要的資源，在index.js定義組件的install方法。而packages/index.js存放了在全量加載時(shí)用的install方法

packages/Button/index.js:

import Button from './src/main';

Button.install = function(Vue) {
 Vue.component(Button.name, Button);
};

export default Button;

packages/Button/src/main.vue:

<template>
 <div>
 我是一個(gè)Button組件
 </div>
</template>

packages/index.js:

import Button from './Button';
import Loading from './Loading';
import LoadMore from './LoadMore';

const components = [
 Button,
 LoadMore,
 Loading
];

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

if (typeof window !== 'undefined' && window.Vue) {
 install(window.Vue)
}

export default {
 install, // 全量引入
 Button,
 LoadMore,
 Loading
};

webpack配置

組件代碼寫(xiě)好了，接下來(lái)需要配置一下webpack的打包邏輯。我們復(fù)用vue-cli生成的模板，在上面做一些必要更改：

多入口

每個(gè)組件獨(dú)立生成一個(gè)對(duì)應(yīng)的js和css，這就需要我們?cè)谌肟谔幘桶呀M件的引用定義好：

webpack.prod.conf.js:

const entrys = {
 Button: path.resolve(__dirname, '../packages/Button'),
 index: path.resolve(__dirname, '../packages')
};

const webpackConfig = merge(baseWebpackConfig, {
 entry: entrys,
 // ......
});

上述配置每增加一個(gè)組件都需要修改entrys，我們可以?xún)?yōu)化一下，使其 動(dòng)態(tài)生成 ：

webpack.prod.conf.js:

const entrys = require(./getComponents.js)([組件目錄入口]);
const webpackConfig = merge(baseWebpackConfig, {
 entry: entrys,
 ......
});

getComponents.js:

const fs = require('fs');
const path = require('path');

/**
 * 判斷剛路徑是否含有index.js
 * @param {String} dir 
 */
function hasIndexJs(dir) {
 let dirs = [];
 try {
  dirs = fs.readdirSync(dir);
 } catch(e) {
  dirs = null;
 }
 return dirs && dirs.includes('index.js');
}

/**
 * 獲取指定入口和入口下包含index.js的文件夾的路徑
 * @param {String} entryDir 
 */
const getPath = function(entryDir) {
 let dirs = fs.readdirSync(entryDir);
 
 const result = {
  index: entryDir
 };
 dirs = dirs.filter(dir => {
  return hasIndexJs(path.resolve(entryDir, dir));
 }).forEach(dir => {
  result[dir] = path.resolve(entryDir, dir); 
 });
 return result;
}

module.exports = getPath;

修改webpack的輸出

默認(rèn)生成的js文件并不支持ES6引入，在這里我們?cè)O(shè)置成 umd

output: {
 path: config.build.assetsRoot,
 filename: utils.assetsPath('[name].js'),
 library: 'LoadOnDemand',
 libraryTarget: 'umd'
},

配置 babel-plugin-component -D

上面的組件庫(kù)打包發(fā)布到npm上之后。我們?cè)谑褂玫臅r(shí)候npm install babel-plugin-component -D之后，修改一下.babelrc.js:

"plugins": [
 [
  "component",
  {
  "libraryName": "load-on-demand", // 組件庫(kù)的名字
  "camel2Dash": false, // 是否把駝峰轉(zhuǎn)換成xx-xx的寫(xiě)法
  "styleLibrary": {
   "base": false, // 是否每個(gè)組件都默認(rèn)引用base.css
   "name": "theme" // css目錄的名字
  }
  }
 ]
 ],

這里提一下屬性 camel2Dash ，默認(rèn)是開(kāi)啟的，開(kāi)啟狀態(tài)下假如你的組件名是vueCompoent，引用的css文件會(huì)變成vue-component.css。

結(jié)語(yǔ)

上面demo的代碼放在了個(gè)人github github.com/jmx16449196… 大家如果有更好的實(shí)現(xiàn)方法，或者我上面還有什么需要更正的錯(cuò)誤，歡迎交流。

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: