浅析组件库实现按需引入的几种方式

按需加载是所有组件库都会提供的一个基础能力，本文会分析ElementUI、Vant及varlet几个组件库的实现并进行相应实践，帮助你彻底搞懂其实现原理。

先搭个简单的组件库

笔者从ElementUI里copy了两个组件：Alert和Tag，并将我们的组件库命名为XUI，当前目录结构如下：

[图片上传失败...(image-f7a7ca-1638541100556)]

组件都放在packages目录下，每个组件都是一个单独的文件夹，最基本的结构是一个js文件和一个vue文件，组件支持使用Vue.component方式注册，也支持插件方式Vue.use注册，js文件就是用来支持插件方式使用的，比如Alert的js文件内容如下：

import Alert from './src/main';

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

export default Alert;

就是给组件添加了一个install方法，这样就可以使用Vue.use(Alert)来注册。

组件的主题文件统一放在/theme-chalk目录下，也是每个组件一个样式文件，index.css包含了所有组件的样式，ElementUI的源码内是scss文件，本文为了简单，直接复制了其npm包内已经编译后的css文件。

最外层还有一个index.js文件，这个文件很明显是用来作为入口文件导出所有组件：

import Alert from './packages/alert/index.js';
import Tag from './packages/tag/index.js';

const components = [
    Alert,
    Tag
]

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

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

export default {
    install,
    Alert,
    Tag
}

首先依次引入组件库的所有组件，然后提供一个install方法，遍历所有组件，依次使用Vue.component方法注册，接下来判断是否存在全局的Vue对象，是的话代表是CDN方式使用，那么自动进行注册，最后导出install方法和所有组件。

Vue的插件就是一个带有install方法的对象，所以我们可以直接引入所有组件：

import XUI from 'xui'
import 'xui/theme-chalk/index.css'
Vue.use(XUI)

也可以单独注册某个组件：

import XUI from 'xui'
import 'xui/theme-chalk/alert.css'
Vue.use(XUI.Alert)

为什么不直接通过import { Alert } form 'xui'来引入呢，很明显，会报错。

因为我们的组件库并没有发布到NPM，所以通过npm link将我们的组件库链接到全局。

接下来笔者使用Vue CLI搭建了一个测试项目，运行npm link xui来链接到组件库。然后使用前面的方式注册组件库或某个组件，这里我们只使用Alert组件。

通过测试可以发现，无论是注册所有组件，还是只注册Alert组件，最后打包后的js里都存在Tag组件的内容：

[图片上传失败...(image-8602b6-1638541100557)]

接下来开启本文的正文，看看如何把Tag去掉。

最简单的按需引入

因为每个组件都可以单独作为一个插件，所以我们完全可以只引入某个组件，比如：

import Alert from 'xui/packages/alert'
import 'xui/theme-chalk/alert.css'

Vue.use(Alert)

这样我们只引入了alert相关的文件，当然最后只会包含alert组件的内容。这样的问题是比较麻烦，使用上成本比较高，最理想的方式还是下面这种：

import { Alert } from 'xui'

通过babel插件

使用babel插件是目前大多数组件库实现按需引入的方式，ElementUI使用的是babel-plugin-component：

[图片上传失败...(image-1dfde6-1638541100557)]

可以看到能直接使用import { Alert } form 'xui'方式来引入Alert组件，也不需要手动引入样式，那么这是怎么实现的呢，接下来我们来撸一个极简版的。

原理很简单，我们想要的是下面这种方式：

import { Alert } from 'xui'

但是实际按需使用需要这样：

import Alert from 'xui/packages/alert'

很明显，我们只要帮用户把第一种方式转换成第二种就可以了，而通过babel插件来转换对用户来说是无感的。

首先在babel.config.js同级新增一个babel-plugin-component.js文件，作为我们插件文件，然后修改一下babel.config.js文件：

module.exports = {
  // ...
  plugins: ['./babel-plugin-component.js']
}

使用相对路径引用我们的插件，接下来就可以愉快的编码了。

先来看一下import { Alert } from 'xui'对应的AST树

[图片上传失败...(image-7a2997-1638541100557)]

整体是一个ImportDeclaration，通过souce.value可以判断导入的来源，specifiers数组里可以找到导入的变量，每个变量是一个ImportSpecifier，可以看到里面有两个对象：ImportSpecifier.imported和ImportSpecifier.local，这两个有什么区别呢，在于是否使用了别名导入，比如：

import { Alert } from 'xui'

这种情况imported和local是一样的，但是如果使用了别名：

import { Alert as a } from 'xui'

那么是这样的：

[图片上传失败...(image-a40323-1638541100557)]

我们这里简单起见就不考虑别名情况，只使用imported。

接下来的任务就是进行转换，看一下import Alert from 'xui/packages/alert'的AST结构：

[图片上传失败...(image-e2da4a-1638541100557)]

目标AST结构也清楚了接下来的事情就简单了，遍历specifiers数组创建新的importDeclaration节点，然后替换掉原来的节点即可：

// babel-plugin-component.js
module.exports = ({
    types
}) => {
    return {
        visitor: {
            ImportDeclaration(path) {
                const {
                    node
                } = path
                const {
                    value
                } = node.source
                if (value === 'xui') {
                    // 找出引入的组件名称列表
                    let specifiersList = []
                    node.specifiers.forEach(spec => {
                        if (types.isImportSpecifier(spec)) {
                            specifiersList.push(spec.imported.name)
                        }
                    })
                    // 给每个组件创建一条导入语句
                    const importDeclarationList = specifiersList.map((name) => {
                        // 文件夹的名称首字母为小写
                        let lowerCaseName = name.toLowerCase()
                        // 构造importDeclaration节点
                        return types.importDeclaration([
                            types.importDefaultSpecifier(types.identifier(name))
                        ], types.stringLiteral('xui/packages/' + lowerCaseName))
                    })
                    // 用多节点替换单节点
                    path.replaceWithMultiple(importDeclarationList)
                }
            }
        },
    }
}

接下来打包测试结果如下：

[图片上传失败...(image-cb2699-1638541100557)]

[图片上传失败...(image-e191fd-1638541100557)]

可以看到Tag组件的内容已经没有了。

当然，以上实现只是一个最简单的demo，实际上还需要考虑样式的引入、别名、去重、在组件中引入、引入了某个组件但是实际并没有使用等各种问题，有兴趣的可以直接阅读babel-plugin-component源码。

Vant和antd也都是采用这种方式，只是使用的插件不一样，这两个使用的都是babel-plugin-import，babel-plugin-component其实也是fork自babel-plugin-import。

Tree Shaking方式

Vant组件库除了支持使用前面的Babel插件按需加载外还支持Tree Shaking方式，实现也很简单，Vant最终发布的代码里提供了三种规范的源代码，分别是commonjs、umd、esmodule，如下图：

[图片上传失败...(image-df0bdd-1638541100557)]

[图片上传失败...(image-51ae92-1638541100557)]

commonjs规范是最常见的使用方式，umd一般用于cdn方式直接在页面引入，而esmodule就是用来实现Tree Shaking的，为什么esmodule能实现Tree Shaking而commonjs规范不行呢，原因是esmodule是静态编译的，也就是在编译阶段就能确定某个模块导出了什么，引入了什么，代码执行阶段不会改变，所以打包工具在打包的时候就能分析出哪个方法被使用了，哪些没有，没有用到的就可以放心的删掉了。

接下来修改一下我们的组件库，让它也支持Tree Shaking，因为我们的组件本身就是esmodule模块，所以不需要修改，但是要修改一下导出的文件index.js，因为目前还不支持下面这种方式导出：

import { Alert } from 'xui'

增加如下代码：

// index.js
// ...

export {
    Alert,
    Tag
}

// ...

接下来需要修改package.json，我们都知道package.json里的main字段是用来指示包的入口文件，那么是不是只要把这个字段指向esmodule的入口文件就行了呢，其实是不行的，因为通常情况下它都是指向commonjs模块入口，而且一个包有可能支持nodejs和web两种环境使用，nodejs环境是有可能不支持esmodule模块的，既然不能修改旧的字段，那么就只能引入新的字段，也就是pkg.module，所以修改package.json文件如下：

// package.json
{
    // ...
    "mains": "index.js",
    "module": "index.js",// 增加该字段
    // ...
}

因为我们的组件库只有esmodule模块，所以其实这两个字段指向的是一样的，在实际开发中，需要向Vant一样编译成不同类型的模块，而且发布到npm的模块一般也需要编译成es5语法的，因为这些不是本文的重点，所以就省略了这个步骤。

添加了pkg.module字段，如果打包工具能识别这个字段，那么会优先使用esmodule规范的代码，但是到这里并没有结束，此时打包后发现Tag组件的内容依然在，这是为什么呢，不妨看看下面几种导入场景：

import 'core-js'
import 'style.css'

这两个文件都只引入了，但是并没有明显的进行使用，可以把它们删了吗，显然是不行的，这被称为存在“副作用”，所以我们需要告诉打包工具哪些文件是没有副作用的，可以删掉，哪些是有的，给我留着，Vue CLI使用的是webpack，对应的我们需要在package.json文件里新增一个sideEffects字段：

// package.json
{
    // ...
    "sideEffects": ["**/*.css"],
    // ...
}

我们的组件库里只有样式文件是存在副作用的。

接下来再打包测试，发现没有引入的Tag组件的内容已经被去除了：

[图片上传失败...(image-b0407-1638541100557)]

更多关于Tree Shaking的内容可以阅读Tree Shaking。

使用unplugin-vue-components插件

varlet组件库官方文档上按需引入一节里提到使用的是unplugin-vue-components插件：

[图片上传失败...(image-6e507a-1638541100557)]

这种方式的优点是完全不需要自己来引入组件，直接在模板里使用，由插件来扫描引入并注册，这个插件内置支持了很多市面上流行的组件库，对于已经内置支持的组件库，直接参考上图引入对应的解析函数配置一下即可，但是我们的小破组件库它并不支持，所以需要自己来写这个解析器。

首先这个插件做的事情只是帮我们引入组件并注册，实际上按需加载的功能还是得靠前面两种方式。

Tree Shaking

我们先在上一节的基础上进行修改，保留package.json的module和sideEffects的配置，然后从main.js里删除组件引入和注册的代码，然后修改vue.config.js文件。因为这个插件的官方文档比较简洁，看不出个所以然，所以笔者是参考内置的vant解析器来修改的：

[图片上传失败...(image-833bb9-1638541100557)]

返回的三个字段含义应该是比较清晰的，importName表示引入的组件名，比如Alert，path表示从哪里引入，对于我们的组件库就是xui，sideEffects就是存在副作用的文件，基本就是配置对应的样式文件路径，所以我们修改如下：

// vue.config.js
const Components = require('unplugin-vue-components/webpack')

module.exports = {
    configureWebpack: {
        plugins: [
            Components({
                resolvers: [{
                    type: "component",
                    resolve: (name) => {
                        if (name.startsWith("X")) {
                            const partialName = name.slice(1);
                            return {
                                importName: partialName,
                                path: "xui",
                                sideEffects: 'xui/theme-chalk/' + partialName.toLowerCase() + '.css'
                            };
                        }
                    }
                }]
            })
        ]
    }
}

笔者怕前缀和ElementUI重合，所以组件名称前缀都由El改成了X，比如ElAlert改成了XAlert，当然模板里也需要改成x-alert，接下来进行测试：

[图片上传失败...(image-9436ba-1638541100557)]

[图片上传失败...(image-a5fd01-1638541100557)]

可以看到运行正常，打包后也成功去除了未使用的Tag组件的内容。

单独引入

最后让我们再看一下单独引入的方式，先把pkg.module和pkg.sideEffects字段都移除，然后修改每个组件的index.js文件，让其支持如下方式引入：

import { Alert } from 'xui/packages/alert'

Alert组件修改如下：

// index.js
import Alert from './src/main';

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

// 新增下面两行
export {
  Alert
}

export default Alert;

接下来再修改我们的解析器：

const Components = require('unplugin-vue-components/webpack')

module.exports = {
    configureWebpack: {
        mode: 'production',
        plugins: [
            Components({
                resolvers: [{
                    type: "component",
                    resolve: (name) => {
                        if (name.startsWith("X")) {
                            const partialName = name.slice(1);
                            return {
                                importName: partialName,
                                // 修改path字段，指向每个组件的index.js
                                path: "xui/packages/" + partialName.toLowerCase(),
                                sideEffects: 'xui/theme-chalk/' + partialName.toLowerCase() + '.css'
                            };
                        }
                    }
                }]
            })
        ]
    }
}

其实就是修改了path字段，让其指向每个组件的index.js文件，运行测试和打包测试后结果也是符合要求的。

小节

本文简单分析了一下组件库实现按需引入的几种方式，有组件库开发需求的朋友可以自行抉择，示例代码请移步：https://github.com/wanglin2/ComponentLibraryImport。