教你搭建按需加载的Vue组件库

宋华发布于2019-08-02 15:39 / 3458人阅读

摘要：先来看看是怎么做的，官方的的快速手上使用一个了插件，作用就是代码转换转换为到这我们可以知道，要搭建一个按需加载的组件库。

按需加载的原理

按需加载，本质上是把一个组件库的不同组件拆分成不同文件，按照需要引用对应的文件，而该文件暴露一个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是怎么做的，官方的的「快速手上」：

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

import { Button } from "components"

// 转换为

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

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

组件独立打包，单个文件对应单个组件

引入代码转换的插件

组件代码的编写规范

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

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:

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
https://github.com/jmx164491960/load-on-demand
大家如果有更好的实现方法，或者我上面还有什么需要更正的错误，欢迎交流。

云服务器 GPU云服务器 vue组件 vue组件开发 vue父子组件通讯 vue轮播组件

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/54269.html

教你搭建按需加载的Vue组件库

摘要：先来看看是怎么做的，官方的的快速手上使用一个了插件，作用就是代码转换转换为到这我们可以知道，要搭建一个按需加载的组件库。按需加载的原理按需加载，本质上是把一个组件库的不同组件拆分成不同文件，按照需要引用对应的文件，而该文件暴露一个install方法，供Vue.use使用。比如：我只想引用element库里的一个Button组件 import Button from element-...

callmewhy 2019-08-26 10:26 评论0 收藏0
个人分享--web前端学习资源分享

摘要：前言月份开始出没社区，现在差不多月了，按照工作的说法，就是差不多过了三个月的试用期，准备转正了一般来说，差不多到了转正的时候，会进行总结或者分享会议那么今天我就把看过的一些学习资源主要是博客，博文推荐分享给大家。 1.前言 6月份开始出没社区，现在差不多9月了，按照工作的说法，就是差不多过了三个月的试用期，准备转正了！一般来说，差不多到了转正的时候，会进行总结或者分享会议！那么今天我就...

sherlock221 2019-08-20 18:59 评论0 收藏0
webpack 基础与项目优化实践总结

摘要：前言本文基于，主要涉及基本概念基本配置和实际项目打包优化。关于概念方面参考官网，常用配置来自于网络资源，在文末有相关参考链接，实践部分基于自己的项目进行优化配置。同一文件中，修改某个影响其他。前言：本文基于weboack4.x，主要涉及webpack4 基本概念、基本配置和实际项目打包优化。关于概念方面参考官网，常用配置来自于网络资源，在文末有相关参考链接，实践部分基于自己的项目进行...

Scorpion 2019-08-23 18:15 评论0 收藏0
一文教你构建自己的library、webpack优化和npm版本控制

摘要：地址点个，给我们一点动力中文文档地址交流地址点个，谢谢这套费了几个月时间和很多心血，现在已经趋于完善，你完全可以在你的生产环境中试着使用。介绍构建自己的UI库，你必须要对一款打包工具熟悉(webpack, gulp或者grunt), 本文以webpack为例。 github 地址: https://github.com/reming0227... (点个 star，给我们一点动力 ...

刘玉平 2019-08-26 13:53 评论0 收藏0