教你搭建按需加载的Vue组件库(小结)


Posted in Javascript onJuly 29, 2019

按需加载的原理

按需加载,本质上是把一个组件库的不同组件 拆分成不同文件 ,按照需要引用对应的文件,而该文件暴露一个 install方法 ,供Vue.use使用。 比如:我只想引用element库里的一个Button组件

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

Vue.use(Button);

上面的写法比较繁琐,而且需要知道每个组件的实际路径,使用起来并不方便,所以我们还需要借助一个转换插件。

先来看看 element 是怎么做的,官方的的「快速手上」:

教你搭建按需加载的Vue组件库(小结)

element使用一个了babel插件,作用就是代码转换:

import { Button } from 'components'

// 转换为

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

到这我们可以知道,要搭建一个按需加载的组件库。 主要工作 需要两点:

  1. 组件独立打包 ,单个文件对应单个组件
  2. 引入 代码转换 的插件

组件代码的编写规范

我们在项目的跟目录建一个文件夹packages,下面放我们的组件:

教你搭建按需加载的Vue组件库(小结)

packages下每一个文件夹对应一个组件所需要的资源,在index.js定义组件的install方法。而packages/index.js存放了在全量加载时用的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>
 我是一个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配置

组件代码写好了,接下来需要配置一下webpack的打包逻辑。我们复用vue-cli生成的模板,在上面做一些必要更改:

多入口

每个组件独立生成一个对应的js和css,这就需要我们在入口处就把组件的引用定义好:

webpack.prod.conf.js:

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

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

上述配置每增加一个组件都需要修改entrys,我们可以优化一下,使其 动态生成

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的输出

默认生成的js文件并不支持ES6引入,在这里我们设置成 umd

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

配置 babel-plugin-component -D

上面的组件库打包发布到npm上之后。我们在使用的时候npm install babel-plugin-component -D之后,修改一下.babelrc.js:

"plugins": [
 [
  "component",
  {
  "libraryName": "load-on-demand", // 组件库的名字
  "camel2Dash": false, // 是否把驼峰转换成xx-xx的写法
  "styleLibrary": {
   "base": false, // 是否每个组件都默认引用base.css
   "name": "theme" // css目录的名字
  }
  }
 ]
 ],

这里提一下属性 camel2Dash ,默认是开启的,开启状态下假如你的组件名是vueCompoent,引用的css文件会变成vue-component.css。

结语

上面demo的代码放在了个人github github.com/jmx16449196… 大家如果有更好的实现方法,或者我上面还有什么需要更正的错误,欢迎交流。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
JavaScript函数模式详解
Nov 07 Javascript
javascript中HTMLDOM操作详解
Dec 11 Javascript
javascript 判断是否是微信浏览器的方法
Oct 09 Javascript
JS ES6中setTimeout函数的执行上下文示例
Apr 27 Javascript
纯js实现的积木(div层)拖动功能示例
Jul 19 Javascript
微信小程序 自定义消息提示框
Aug 06 Javascript
vue-cli下的vuex的简单Demo图解(实现加1减1操作)
Feb 26 Javascript
jQuery实现的监听导航滚动置顶状态功能示例
Jul 23 jQuery
简化版的vue-router实现思路详解
Oct 19 Javascript
vue中js判断长时间不操作界面自动退出登录(推荐)
Jan 22 Javascript
详解为element-ui的Select和Cascader添加弹层底部操作按钮
Feb 07 Javascript
基于js实现数组相邻元素上移下移
May 19 Javascript
JavaScript 继承 封装 多态实现及原理详解
Jul 29 #Javascript
Vue2.0实现简单分页及跳转效果
Jul 29 #Javascript
JavaScript面向对象程序设计中对象的定义和继承详解
Jul 29 #Javascript
js实现多张图片每隔一秒切换一张图片
Jul 29 #Javascript
javascript面向对象程序设计实践常用知识点总结
Jul 29 #Javascript
javascript中this的用法实践分析
Jul 29 #Javascript
学习LayUI时自研的表单参数校验框架案例分析
Jul 29 #Javascript
You might like
php返回相对时间(如:20分钟前,3天前)的方法
2015/04/14 PHP
php随机显示指定文件夹下图片的方法
2015/07/13 PHP
laravel model模型定义实现开启自动管理时间created_at,updated_at
2019/10/17 PHP
javascript 常用代码技巧大收集
2009/02/25 Javascript
JavaScript 设计模式学习 Factory
2009/07/29 Javascript
JAVASCRIPT实现的WEB页面跳转以及页面间传值方法
2010/05/13 Javascript
前端开发的开始---基于面向对象的Ajax类
2010/09/17 Javascript
js判断登录与否并确定跳转页面的方法
2015/01/30 Javascript
浅析javascript中的事件代理
2015/11/06 Javascript
JavaScript iframe数据共享接口实现方法
2016/01/06 Javascript
JavaScript动态生成二维码图片
2016/04/20 Javascript
JS遍历页面所有对象属性及实现方法
2016/08/01 Javascript
Bootstrap学习笔记之环境配置(1)
2016/12/07 Javascript
CSS+jQuery实现简单的折叠菜单
2016/12/20 Javascript
Webpack打包慢问题的完美解决方法
2017/03/16 Javascript
Bootstrap下拉菜单更改为悬停(hover)触发的方法
2017/05/24 Javascript
浅谈AngularJS中$http服务的简单用法
2018/05/15 Javascript
微信小程序实现的一键拨号功能示例
2019/04/24 Javascript
vue 集成 vis-network 实现网络拓扑图的方法
2019/08/07 Javascript
基于Vue中使用节流Lodash throttle详解
2019/10/30 Javascript
[02:42]DOTA2英雄基础教程 杰奇洛
2013/12/23 DOTA
python学习手册中的python多态示例代码
2014/01/21 Python
在Docker上部署Python的Flask框架的教程
2015/04/08 Python
浅谈MySQL中的触发器
2015/05/05 Python
Django实战之用户认证(初始配置)
2018/07/16 Python
python一键去抖音视频水印工具
2018/09/14 Python
Tensorflow 定义变量,函数,数值计算等名字的更新方式
2020/02/10 Python
scrapy-redis分布式爬虫的搭建过程(理论篇)
2020/09/29 Python
python自动化测试三部曲之unittest框架的实现
2020/10/07 Python
美国特价机票专家:Airfarewatchdog
2018/01/24 全球购物
2014年国庆节演讲稿精选范文1500字
2014/09/25 职场文书
2014乡镇机关党员个人对照检查材料思想汇报
2014/10/09 职场文书
联欢会开场白
2015/06/01 职场文书
法制教育主题班会
2015/08/13 职场文书
交通安全教育心得体会
2016/01/15 职场文书
如何使用vue3打造一个物料库
2021/05/08 Vue.js