快上车!从零开始搭建一个属于自己的组件库!
共 10810字,需浏览 22分钟
·
2022-08-24 13:19
组件在前端开发中越来越重要了,开发者更细分、聚焦于组件层面的开发,然后像搭积木一样完成应用功能。组件库可以统一管理组件,输出文档,能提升组件复用性、避免重复造轮子。赶快搭建自己的组件库吧,这瓜保甜!
需求背景
为什么要搭建组件库?
虽然业界已经有很多成熟优秀的ui库可以供我们使用,也为我们解决了很多问题。但是基础的东西总是不能满足所有业务场景,更多时候我们需要扩展功能来满足业务的需求,好比 table
需要自定列这样的~相信这也是很多小伙伴开发时候的场景。
跨项目复用。很多时候为了方便,只是基于当前项目对组件进行二次封装(反正我是这样干的哈哈),然后做其他项目遇到同样场景时,要么copy(经常忘记之前封装在哪个项目里了🌚)、要么重新干一个...总是缺少一个统筹的地方,复用很不方便。 组件使用文档。文档产出对于一线开发来说可能相对比较欠缺,因为大家都忙于撸业务,文档这种奢侈品能省一点是一点。这样导致一个问题就是自己封装的组件别人不会用、不知道在哪里用,甚至不知道有这么个东西。 跨团队共建发展。大多B端系统都是以 element
、antd
等ui框架为主,基于各种业务场景,基本都会有自己团队的二次封装。其实类似的功能扩展肯定会有的,如果有组件库把组件都集中起来,就能减少很多重复造轮子的劳动力了!
笔者之前就经常有这样的痛点,在某个项目里二次封装了 el-select
,实现 filterable
的时搜索输入框移到下拉列表中,避免多选时多个tag
挤压了搜索框的空间。当时是写在一个项目里,然后其他项目也遇到了这样的需求...我在十几个项目里面寻找、回忆,找回当年封装的组件,人都麻了......
正好最近在搞云产品,需要提供给各中后台统一的样式、布局规范以接入,还需要统一扩展基础组件的能力。于是组件库的需求的就这么出来了!基本想做成的就是对 element-ui/plus
、 antd
一些组件进行二次封装、扩展,并集成到组件库中,笔者当仁不让把需求从大佬手上抢过来做。
目前初步搭建起来了一个简易的组件库了,可对 element-plus
、 element-ui
的组件进行开发调试,且目前已经实现几个组件的扩展了~当然,第一版还是有很多工作没做完、做好,不过没关系,毕竟不能一下吃成一个胖子。更多实现、优化、还会慢慢迭代做,到时候有空会继续分享相关的干货~
本文会从组件库的工程架构、文档、组件开发环境准备、打包、发布进行分享,组件开发环境主要是 element-ui/plus
的🤣,因为本期需求只要满足 vue2
、 vue3
的中台,所以 antd
的还没有投入,只好等下期了。与其说分享,其实更是做一个记录沉淀一下,也是回顾总结~事不宜迟!开始进入主题吧,从0-1搭建一个组件库!
一、项目架构
第一次搞组件库,仿佛走进一个新的空白领域了。作为一个没经验的小白,当然是得抄作业啦,不不不,应该是“借鉴”😜。这时候搞个开源的项目来参照参照还是挺香的,于是笔者就去“学习了” element-plus项目[1]的架构、代码组织方式,再结合自己的需求场景就开始干了。
1. Monorepo
整个工程的代码组织采用 Monorepo
的组织方式,使用工具 pnpm + workspace
来实现。所以全部项目都是放在一个仓库里的,包括文档、组件。
工程具体分为以下几块,以文档和组件库为两大类进行分块:
文档工程(docs) 安装指引 组件使用文档( elm
、elp
、antd
)组件开发文档 组件库(packages) element-plus
element-ui
ant-design
voice-components
其中 voice-components
笔者是打算用来做 adapt层 用的,因为文档工具用了 VitePress
(后面会讲),它只能支持 vue3
的组件,所以 vue2
、 react
的组件需要做一层适配,这一块是预留的,暂时可以不关注。
第一版比较简单,后续如果沉淀出一些工具、打包脚本等,也会再扩展几个项目放进去 workspace
里。所以目前就先这样吧,用着先~
2. 文档项目结构
抄作业抄作业,这部分跟 element-plus
基本是一致的。
index.md
。!!顾名思义,文档首页~.vitepress
目录:文档站点工具配置相关,这个后面再展开~zh-CN目录:文档md文件 components: 组件使用文档.md
。组件的使用demo及案例代码,相关配置说明guide: 组件库指引文档.md
。包括组件的安装指南、开发指南public目录:相关静态资源目录。 css
、image
等build目录:放点自己实现的构建脚本、vite插件啥的
3. 组件库结构
这部分跟 element-plus
也是基本一致的,具体大家可以参照他们的实现,这里就记录个大概,粗略带过吧。
每一个ui框架的结构都一样,以其中一个为例记录:
组件项目入口—— 根index
。导出当前项目需要导出的所有模块(可按需引入)。并导出全局安装方法。(Vue.use(VcComponents)
)可全局注册export * from './components'
export default {
install
}
复制代码2. components:- 入口文件:index。导出所有组件。
js
export * from '...'
export * from '...'
export * from '...'
复制代码
```
- 存放全部组件,以组件名作为文件夹名。3. 组件文件夹(以button为例):- 入口文件:index。导出当前组件,并包装 install
方法(主要用于Vue.use
调用时进行全局注册)。- 组件文件。实现组件扩展的二次封装。(这里建议扩展组件时保留组件的原来用法,这样可以降低使用时候的学习成本)
二、组件库工具
这里不会面面俱到,只记录一些用到的核心工具以及核心的用法~就算不是特别细粒度,相信大家要自己动手搞的时候也难不倒你们的!!笔者这么菜都一样搞,你们肯定都行!
1. 文档站点工具——VitePress
对于组件库来说,文档可以说是最关键的一环了,没有文档的组件库不是真的组件库~这里笔者用了几分钟去调研(根本就没怎么调研),最终决定使用 VitePress[2] 作为文档站点工具,目前用的版本是 1.0.0-alpha.4
。(哈哈哈大家不要害怕alpha版,用着没啥毛病)
使用下来基本配置用法在官方文档[3]中都能找到,已经满足当前的使用场景了~大家也要采用的话,花点时间去搓一搓就好,整个文档站点搭建不算难,毕竟只要能跑起来就可以慢慢调整慢慢搞。
核心配置(都放在 .vitepress
目录下):
配置文件:
.vitepress
根目录的config
文件。其实没有特别多的配置,主要就是导航栏和菜单栏而已。export default defineConfig({
title: 'voice-ui', description: '', base, head: [ [ 'link', { rel: 'icon', href: '/images/favicon.ico' } ] ], themeConfig: { logo: '/images/favicon.ico', nav, // 配置导航栏 sidebar, // 配置侧边菜单栏 footer // 配置页脚 } }) 复制代码 ```
nav 配置导航栏配置(文档链接[4])
export default [
{ text: '指南', link: '', activeMatch: '' }, { text: 'element-plus', link: '', activeMatch: '' }, { text: 'element-ui', link: '', activeMatch: '' }, { text: 'ant-design', link: '', activeMatch: '' } ] 复制代码 ```
sidebar 配置侧边菜单栏(文档链接[5])。具体配置太多就不全贴出来了,这里的配置在文档中都能找到。如下这样配置就是一个
nav
路由对应一个sidebar
菜单。export default {
'/zh-CN/guide/': [ { text: '安装', items: [ { text: 'element-plus', link: '' }, ... ] }, { text: '开发者指南', items: ... } ] } 复制代码 ```
大概的效果如下,不同nav对应各自的侧边栏菜单:![image.png](https://p1-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/965ca66b0c364079b9efb9e5e9113f8d~tplv-k3u1fbpfcp-zoom-in-crop-mark:3024:0:0:0.awebp?)
![image.png](https://p1-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/7723fd9b09ad4ac4b1e0507b0d3076ac~tplv-k3u1fbpfcp-zoom-in-crop-mark:3024:0:0:0.awebp?)
/theme/index
中自定义主题 & 全局注册vue3
组件
具体配置参照文档[6]。这里的仅是笔者的基本配置~ import { App } from 'vue'
import Theme from 'vitepress/theme'
import '../../public/css/customStyle.css' // 自定义的主题色文件
import 'element-plus/dist/index.css'
import 'element-plus/theme-chalk/dark/css-vars.css'
import VcComponent from '@voice-ui/voice-components' // 上文提到的adapt层,导出vue3的组件
export default {
...Theme,
enhanceApp ({ app }: {app: App}) {
app.use(VcComponent) // 进行组件注册,这样我们可以直接在 markdown 中使用组件啦!
}
}
复制代码customStyle.css
文件其实就是对VitePress
的一些 css变量 进行自定义重写👇:root {
--vc-primary-color: #295dfa;
...
}
:root {
--vp-c-brand: var(--vc-primary-color); /* 自定义 VitePress 的主题色 */
...
}
复制代码
2. 打包工具——Vite
提到这个必须提一嘴:开发真丝滑!是的,包括各项目的 dev
、 build
都是使用 Vite
完成。其实这个没什么好说的,大家可能用得比我都熟~所以这里只简单带一带用了什么功能~
用到的 vue2、 vue3 插件(官方文档戳[7]): underfin/vite-plugin-vue2
@vitejs/plugin-vue
打包配置——库模式。基本的都有了。 es
、cjs
、umd
、iife
。(官方文档戳[8],具体下文会讲)配置 alias
。各模块在dev、prod环境中相互引用(官方文档戳[9],具体下文会讲)配置 external
。(vite配置[10];rollup配置[11])
第一版差不多就这些了,配置上还是比较简单的。基本可以满足 dev开发、build打包 需求。
三、开发环境
因为使用的 VitePress
支持在 markdown
中直接使用 vue3
组件,所以 vue2
、 vue3
、 react
相关的开发环境有所不同。基于此, element-plus
的开发环境就没有单独搞了,直接在 docs
项目中进行组件开发。
1. vue3 + element-plus
开发环境
这里也是直接抄作业的,模仿 element-plus
的实现。核心做法:
包装 element-plus组件
一层install
方法在 VitePress
中进行全局注册在 md文件
中直接使用注册好的组件,可以直接在文档中进行开发调试
大概的代码思路:
给组件对象添加
install
方法import { withInstall } from '../../utils'
import Button from './button.vue'
export const VcButton = withInstall(Button)
export default VcButton
export * from './'
复制代码install方法:接收一个
Vue3
对象,用Vue.component
进行组件注册export const withInstall = comp => {
comp.install = app => { app.component(comp.name, comp) } return comp } 复制代码 ```
文档项目中,在
.vitepress/theme/index.ts
中进行全局注册(上文也有提到)export default {
enhanceApp ({ app }: {app: App}) { // 这里能拿到 app ,也就是Vue3的app // VcButton在这里进行全局注册 app.use(VcButton) // app.use 就会调用 VcButton的install方法 } } 复制代码 ```
md中直接使用注册好的组件
# Button 按钮
这是一个按钮
# Element-plus
## Button
<vc-button />
复制代码
然后就能在页面上看到了,并且是有热更新的!这样我们直接开发调试即可了。
2. vue2 + element-ui
开发环境
vue2
、 react
的开发环境实现思路大致相同(react的这次还没搞,以vue2为例就好),就是在当前项目中用vite启动一个devServer进行开发,就跟普通的项目开发是一样的。
根目录建一个
index.html
,指定入口搞个demo目录,其实就是Vue项目,newVue完后挂载到dom上。如下: 在
demo-xxx
的vue文件中导入开发的组件进行试用、调试。页面效果如下:
react的虽然还没做,但是具体思路也是跟vue2一样的,在react自己的项目中起服务进行组件的开发调试~后续做了的话会补充进这里~
四、组件打包、发布
目前的打包、发布实现得比较简单。大概是统一打包,然后进到每个目录中去进去npm发布,目前也是只发布在内部的npm中。
1. 统一打包
为了打包方便,且契合当前发布平台的特性,在整个项目的根目录中 package.json 的 scripts
中进行了命令整合。这里后续可能会用脚本的方式去实现,因为可能在打包的时候要处理一些其他的逻辑。目前第一版大概如下:
{
"scripts": {
"build": "pnpm run build:elp && pnpm run build:elu && pnpm run build:shared",
"build:elp": "pnpm run -C packages/element-plus build",
"build:elu": "pnpm run -C packages/element-ui build",
"build:shared": "pnpm run -C packages/shared build",
"release": "node scripts/release.ts"
}
}
复制代码
2. 组件库的打包配置
上文打包工具哪里有提到过,目前是最简单版的,打出 es、cjs、umd、iife 格式的包,而且要external掉第三方库。大概配置:
export default defineConfig(async ({ command, mode }) => {
return {
plugins: [ createVuePlugin() ],
build: {
rollupOptions: {
external: ['element-ui', 'vue']
},
lib: {
entry: path.resolve(__dirname, './components/index.js'),
name: 'voiceUi',
fileName: 'vc-element-ui',
formats: ['es', 'cjs', 'umd', 'iife']
}
},
resolve: {
alias: await alias()
}
}
})
复制代码
3. npm发布
其实 npm包 安装只是其中一种方式,该组件库后续还会新增模块联邦——MF的接入方式,这个会在后续进行扩展,到时候做了的话再补充一下或者再写一篇文章吧~
目前的npm发包时候用了个脚本,基本就是进到每个目录下去执行以下更新版本好,然后执行 npm publish
。(这里的脚本会结合自己发布平台的一些能力去写的,所以就不贴出来了,大致思路就是这样)
五、开发时一些注意点
1. Vue版本冲突导致启动服务、打包失败
因为是使用 Monorepo
代码组织方式,所以整个项目难免会出现依赖包重合(版本不同)的问题。就好比这整个项目中既装了 Vue3
、也装了 Vue2
,可能起项目时会报错:
Vue packages version mismatch:
- vue@3.xxx
- vue-template-compiler@2.xxx
复制代码
但是仔细检查发现当前项目的 node_modules
中的 vue
和 vue-compiler
是同版本的,而且是在当前工程中执行的启动、打包。查了个 issus ,在pnpm文档中找到了相关的解决方案:
具体文档地址:pnpm—shared-workspace-lockfile[12]
配置了这个文件后问题就解决了~
2. 配置alias解决入口问题
组件库打包后的入口跟开发时的入口其实是有点不一致的,所以如果我们开发中直接 import xxx from 组件库名称
这样导入组件是会有问题的,毕竟一般情况下我们的入口是配置打包完之后的产物的入口的(一般是dist、lib目录下的index)。
出于这点,配置个alias就很好解决问题了,因为很多地方用到,笔者直接就封成了个函数:
export async function alias (): Promise<Array<Alias>> {
const projectPath = packagesPath()
const dirArr = await fsPromises.readdir(projectPath)
return dirArr.map(packagePath => {
return {
find: new RegExp(`^@voice-ui\/${packagePath}(\/(dist))?$`),
replacement: path.join(projectPath, `/${packagePath}/index`)
}
})
}
复制代码
大概作用就是把入口从 dist 下面换到当前工程的对应项目下的index入口。
3. 样式隔离
docs项目中用的 VitePress
,他会有一些自己的样式控制,可能会影响到我们需要在文档中展示的组件。刚好笔者就遇到了这么一个情况:
如图所示,table的样式变得很奇怪。笔者并没有对样式有做什么处理,就是element-plus的table。用审查元素看了下,主要是 VitePress
也有自己的table的样式,影响到 el-table
的表现了。
我们可以通过重写样式解决,但这样在其他的如 antd
、element-ui
的组件放进来的时候也会有问题。所以最好还是把样式进行隔离。哈哈哈,其实写到这里的时候,笔者还没有实现样式隔离,毕竟给大伙写文章更重要嘛!!
笔者有个大概想法是用 webComponent
去隔离,这只好做完了再写出来了😝,让大家留个念想。
写在最后
其实组件库这个东西真是早有早好,如果当前团队还没有的话,赶紧搞一个吧。笔者以前也没意识去搞这个东西(还是太菜了),所以做了很多重复的劳动。每做一些新项目,或者参与别人的项目,经常想用一些自己之前封装的组件,都很麻烦,有时候为了不想切来切去,直接就动手写了。现在想想,要是那时候就做了个组件库该多好啊~其实做个简单版的也不是很难,如果是只需要关注一种前端框架的那就更简单了,要考虑的东西更少。把整个组件库搭出来之后,还能找其他小伙伴一起共建,一起维护,不断强大自己团队的组件库,大家一起受益~
真的!还没有的赶紧搭!这瓜保甜。
作者:井柏然
https://juejin.cn/post/7120893568553582622