教你搭建按需加載的Vue組件庫

宋華發布于2019-08-02 15:39 / 3495人閱讀

摘要：先來看看是怎么做的，官方的的快速手上使用一個了插件，作用就是代碼轉換轉換為到這我們可以知道，要搭建一個按需加載的組件庫。

按需加載的原理

按需加載，本質上是把一個組件庫的不同組件拆分成不同文件，按照需要引用對應的文件，而該文件暴露一個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輪播組件

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/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