vue组件库如何按需引入之babel-plugin-import

组件库的按需引用可以精简项目资源大小,提升项目性能。目前使用广泛的组件库,如element、iview、antd等都可以按需引入了。那如何实现组件库的按需引入呢?

需求解析

比如一个vue项目的组件库:ComponentsDemo,全局引入组件库的代码为:

import vsuite from "vsuite";
Vue.use(vsuite);

需要按需引入的时候,代码为:

import  ComponentA   from "ComponentsDemo/src/components/component-a ";
vue.component("ComponentA ", ComponentA );

这样写,其实已经满足了我们的需求。但是这样写不是很优雅,那么,怎么简化import ComponentA from "ComponentsDemo/src/components/component-a ";呢?这就设计到对import语句的解析转化了。
由此想到了Babel,我们知道Babel 是一个 JavaScript 编译器,主要用于将 ECMAScript 2015+ 版本的代码转换为向后兼容的 JavaScript 语法,以便能够运行在当前和旧版本的浏览器或其他环境中。而Babel插件可以在输入源码 => 输出编译后的代码的过程中做一些操作,比如实现以下代码:

import { ComponentA, ComponentB } from 'ComponentsDemo';

↓ ↓ ↓ ↓ ↓ ↓

import  ComponentA   from "ComponentsDemo/src/components/component-a ";
import  ComponentB   from "ComponentsDemo/src/components/component-b ";

能实现这一步骤的babel插件之中,babel-plugin-import使用的比较多。

babel-plugin-import

babel-plugin-import是阿里开源的一款babel插件,其主要用于组件的按需引入。
babel-plugin-import npm链接
关于babel-plugin-import的制作思路可以看这篇文章:手把手教你开发一个babel-plugin

vue组件库按需引入设置

自定义的vue组件库ComponentsDemo,想要让它可以被按需引入,需要注意目录等的构成方式。
根据babel-plugin-import.babelrc中的设置,如果.babelrc设置如下:

{
  "plugins": [
    [
      "import",
      {
        "libraryName": "ComponentsDemo",
        "libraryDirectory": "src/components"
      }
    ]
  ]
}

babel-plugin-import在读取以下代码时:

import { ComponentA } from "ComponentsDemo";
vue.component("ComponentA ", ComponentA );

查找引入组件库中的组件的代码解析如下:

import  ComponentA   from "ComponentsDemo/src/components/component-a ";

根据查找的规则,ComponentA 是ComponentsDemo组件库下src/components/目录下的文件名或者目录名,第一个字母大写会被转成小写(如ComponentA 为Icon,找的文件名就是icon),驼峰命名会被转成-来连接(如ComponentA 为MenuItem,会查找名为menu-item的文件)。
故此,我们的组件库的结构可以为:

...
- src
    - components
        - component-a
            - index.vue
        - component-b
            - index.vue
        - component-c
            - index.vue
-- -- index.js
...

组件的导出文件index.js的结构:

import ComponentA from './components/component-a';
import ComponentB from './components/component-b';
import ComponentC from './components/component-c';

export default {
    ComponentA ,
    ComponentB ,
    ComponentC 
}

需要注意components目录下的文件名需要和组件名对应,需要能对应解析到。

按需引入组件库

在需要引入组件库的项目Test中,首先安装babel-plugin-import:

npm i babel-plugin-import -D

根目录下新建文件.babelrc

{
  "plugins": [
    [
      "import",
      {
        "libraryName": "ComponentsDemo",
        "libraryDirectory": "src/components"
      }
    ]
  ]
}

入口文件中按需引入组件:

import { ComponentA , ComponentB } from "ComponentsDemo";
vue.component("ComponentA", ComponentA);
vue.component("ComponentB", ComponentB);

注意如果你的组件库的样式没有跟组件放在一起时,需要额外引入组件样式:

import "~A/src/styles/index.scss";

此时npm run build --report时,可以打开report.html查看到组件库的引入已经是按需引入了。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,736评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,167评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,442评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,902评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,302评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,573评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,847评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,562评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,260评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,531评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,021评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,367评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,016评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,068评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,827评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,610评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,514评论 2 269

推荐阅读更多精彩内容