前端配置化真香~上班又多了60%的摸🐟时间


theme: vuepress

本文从 场景介绍设计&实现性能优化 三个部分进行讲解。笔者当时的技术栈是 vue2 + element-ui,文章案例也是(其实大家不必纠结于技术栈,掌握设计的思路和理念,什么框架都是一样的)。主要能解决的问题就是 提高代码复用能力、提升开发效率,特别是需要开发多个大型表单系统的,配置化可以极大的提升效率,让你上班摸鱼不再是梦想!为了早点下班,我们接着往下看吧!

一、场景介绍

1. 业务场景

如何定义「巨型」表单,这个因人而异。但如果只是一些:收货人信息、登陆、注册的这种比较简单的表单,那肯定算不上巨型,直接常规开发写模版就好了,没有必要为了配置化而配置化~

从笔者的理解出发,表单项非常多,比如笔者曾经负责的「投放系统」,随随便便提交时都会涉及几十甚至上百个字段,这样整个表单会有几十、上百个表单项组成,这就算得上是巨型表单了。

先给大家看看成品的其中的一小块截图~
image.png

别看到截图好像表单项也就那样,根据右栏数起来共40+个,但是这个只是初期版的,还有很多字段是没接进来的;而且很多表单项之间有联动、可增删,还有很多表单项是隐藏的

相信你很难想象,其实你只要进行简单的配置,就能实现上图的界面。比如下图的 js对象 就是上图的其中几个表单项的配置:
image.png

大家已经不难看出,配置化思路其实就是对表单项进行了抽象,制定了一份协议去描述每个表单项。具体对象中的每个属性有什么用,这个笔者稍后讲自己的设计思路时再详细介绍~

这时候你一定会有疑问,为什么要抽象、为什么配置化的方案更好,我们接着往下看~

2. 配置化想法萌生

高复用、好维护。是的,笔者用配置化方式开发表单,完完全全就是为了高复用、可维护性,然后提升开发效率,解放生产力。

  • 高复用:相似的业务逻辑进行统一处理,复用在相似领域的业务场景。如果说投放系统只需要接入一个渠道,那真的写 template 一把梭就完了。但事实上却不是这样的,当你接入了第一个 facebook ,你发现后面还有 tiktok巨量引擎广点通 等各种媒体渠道…
  • 可维护:实现配置代替开发。即使把配置抽离,交到非技术人员处,其根据协议一样能实现表单项的增删,完成业务。并不是把东西做出来就完事了。首先,渠道方会有新配置功能推出,这个是不可控的。其次,系统开发时并不是全字段接入,而是先接入业务方所需要的核心配置,所以后期会有很多接入新的字段需求。

接下来举两个例子来说说,高复用、好维护体现在哪里

  1. 表单1。代码如下:
    1. <el-form ref="form" :model="form">
    2. <!-- 当活动区域的值为 “area1” 时, 活动名称才展示 -->
    3. <el-form-item label="活动名称" v-if="form.area === area1">
    4. <el-input v-model="form.name"></el-input>
    5. </el-form-item>
    6. <el-form-item label="活动区域">
    7. <el-select v-model="form.area" multiple>...</el-input>
    8. </el-form-item>
    9. </el-form>
  2. 表单2。虽然跟 表单1 很相似,但又存在不同。比如 表单2 的活动区域不叫 “活动区域” ,且 表单项 之间的联动关系有所不同,我们接着使用 copy大法 来做,代码如下:
    1. <el-form ref="form" :model="form">
    2. <el-form-item label="活动名称">
    3. <el-input v-model="form.name"></el-input>
    4. </el-form-item>
    5. <!-- label变成 “活动2”,且需要填写name后才能操作,且是多选 -->
    6. <el-form-item label="活动2">
    7. <el-select
    8. v-model="form.area"
    9. :disable="form.name"
    10. multiple
    11. >...</el-input>
    12. </el-form-item>
    13. </el-form>

copy大法虽然好使,但是我们的复用能力基本就没了,所有功能都近乎是重新开发,这使得非常的被动。别看上面举例好像很轻松就能实现,笔者说过了,我们将要开发的是一个上百项表单项的系统,当模版的量堆积到一定程度时,你会想吐血。好不容写了上千行模版,以为完事了,结果再接一个新的媒体,又是从一个新的开始……并且,你要再写一个上千行的 template 和各种表单项之间的联动逻辑,也是很痛苦的…

所以,怎么 提升复用能力 , 怎么让复杂的表单 变得清晰好维护,就是笔者的出发点的~

二、设计 & 实现

1. 设计协议

首先我们思考下我们的每个表单项目需要一些什么:

  1. type 类型。比如 inputselectradio 等等
  2. label 表单项的名称/描述。
  3. formKey 字段名。我们提交数据到后段的字段名,比如 form.namename
  4. value 存放表单值。表单上 v-model 所绑定的值
  5. options 配置项。比如配置 multipledisabled是否显示 等等

好了,有了以上这些点,我们试着把案例中的 表单1 用协议表达出来:

  1. <el-form-item label="活动名称" v-if="form.area === area1">
  2. <el-input v-model="form.name"></el-input>
  3. </el-form-item>
  4. <el-form-item label="活动区域">
  5. <el-select v-model="form.area">...</el-input>
  6. </el-form-item>

我们可以用协议这样去描述它

  1. [
  2. {
  3. type: el-input,
  4. label: 活动名称,
  5. formKey: name,
  6. value: , // 默认值为空字符串
  7. options: {
  8. vIf: [
  9. // 表示:当 form.area === area1,才显示
  10. { relationKey: area, value: area1 }
  11. ]
  12. }
  13. },
  14. {
  15. type: el-select,
  16. label: 活动区域,
  17. formKey: area,
  18. value: area1,
  19. options: {
  20. multiple: true
  21. }
  22. }
  23. ]

是不是有点内意思了?如果把 开发巨型表单系统 转换成 编写JSON ,是不是很爽?

2. 实现渲染器

配置是有了,但是怎么把配置转换成我们真实的表单呢?如果直接开干,我想大部分可能会先这样下手,比如:

  1. <template>
  2. <el-form-item :label="props.label">
  3. <el-input
  4. v-if="props.type === el-input && ...业务联动逻辑"
  5. :disabled="props.disabled"
  6. v-model="props.value"
  7. ...
  8. />
  9. <el-select
  10. v-if="props.type === el-select && ...业务联动逻辑"
  11. :disabled="props.disabled"
  12. multiple="props.multiple"
  13. v-model="props.value"
  14. ...
  15. >...</el-select>
  16. </el-form-item>
  17. </template>

好了,大家观察一下上面的 template 中,有没发现很多冗余的代码。如果我们需要给组件传入 props 比如例子中的 disabledmultiple ;控制 v-if 等等。。我们有多少个组件,这些重复的代码就要写多少次。如果以后有需要给所有组件传多一个 props,我们就要编辑n次~记住!我们配置化就是要提高效率的,所以这样是不行的~

在此,笔者就建议编写 render函数render函数 的场景 & 对应的好处,大家可以看看 官方文档 对其的讲解~

  • 这里不会深入介绍 render函数 ,如果还不知道的,大家只需要记住:Vue 只认 render函数,平时我们 .vue文件 写的 template ,经过编译之后就是 render函数
  • render函数 作用就是返回一个 vNode。我们 vue2 初始化项目时写的: render (h) => h(App)是不是就似曾相识了呢?

都说 ReactjsxVuetemplate 更好写逻辑,那我们也用 render函数 ,好写逻辑~ 😝 (当然,如果你对render函数不是特别熟悉,那么写template也是可以的)

接下来,我们看看,如何通过render函数,把我们的表单项做出来,以上述案例其中一个为例子:

  1. <el-form-item label="活动名称">
  2. <el-input v-model="form.name"></el-input>
  3. </el-form-item>

这一段要怎么通过render函数表述出来?根据官方文档,我们理清三个参数是什么就可以了:

  1. createElement(
  2. div, // {String | Object | Function},一个 HTML 标签名、组件选项对象,或者...
  3. {}, // 一个与模板中 attribute 对应的数据对象
  4. [] // {String | Array},可以理解成时 children 节点
  5. )

接着,我们直接开干:

  1. <script>
  2. export default {
  3. name: "FormItemDemo",
  4. render(createElement) {
  5. return createElement(el-form-item, {
  6. props: {
  7. label: 活动名称
  8. }
  9. }, [
  10. createElement(el-input) // input组件
  11. ])
  12. }
  13. }
  14. </script>

App组件 中引用这个 FormItemDemo组件,代码如下

  1. <template>
  2. <div>
  3. <el-form label-width="100px">
  4. <FormItemDemo />
  5. </el-form>
  6. </div>
  7. </template>
  8. <script>
  9. import FormItemDemo from "./components/FormItemDemo.vue";
  10. export default {
  11. name: App,
  12. components: { FormItemDemo }
  13. }
  14. </script>

这时候,页面上就出现了我们的 input表单项 了
image.png

初始工作已经做完了,接下来的就是让我们把 render函数 的一些动态数据用变量代替,跟我们的 配置config 结合起来。

❗️❗️❗️注意,render函数很灵活,第一个参数可以是字符串、组件对象、function。大家不要被demo所局限,很多场景是需要我们定制一些组件,然后应用到我们的配置化中,而不是直接使用element-ui的原生组件。笔者项目中用的组件都是经过业务场景封装后export出来的组件对象,再配置到type中,最后render函数接收的是一个组件对象,具备业务能力的组件。因此,我们可以在自己实现的组件中定制自己的业务逻辑

3. render函数 & 配置数据

要说 render函数 也不是真的完美,毕竟要自己去实现譬如 v-ifv-model 这种指令,但是没问题,它带给我的便利给大,所以我能接受。

正式演示配置化的实现时,笔者先声明一点:这里的只是 demo 级别的,具体实战到项目要根据业务场景。笔者做业务时,是对 selectcascader 等组件都封装了一层。因为很多时候我们的下拉数据要去后端拿,封装后组件可以通过传入的 paramsurlPath 去获取数据。所以,大家更要关注思路,然后根据业务场景自己去思考、实现即可

首先配置数据如下:

  1. export default [
  2. {
  3. type: el-input,
  4. label: 活动名称,
  5. formKey: name,
  6. value: , // 默认值为空字符串
  7. options: {
  8. vIf: [
  9. // 表示:当 form.area === area1,才显示
  10. { relationKey: area, value: area1 }
  11. ]
  12. }
  13. },
  14. {
  15. type: el-select,
  16. label: 活动区域,
  17. formKey: area,
  18. value: area1,
  19. options: {
  20. multiple: true
  21. },
  22. optionData: [ // 这里模拟去后端拉回数据
  23. { label: 区域1, value: area1 },
  24. { label: 区域2, value: area2 }
  25. ]
  26. }
  27. ]

我们把 render函数 改造后,变成这样

  1. <script>
  2. export default {
  3. name: "FormItemDemo",
  4. props: {
  5. itemConfig: Object // 接收配置,外部传入
  6. },
  7. render(createElement) {
  8. return createElement(el-form-item, {
  9. props: {
  10. label: this.itemConfig.label // 表单项的label
  11. }
  12. }, [
  13. // 表单组件
  14. createElement(this.itemConfig.type, {
  15. props: {
  16. value: this.itemConfig.value // 这里是自己实现一个 v-model
  17. },
  18. on: {
  19. change: (nVal) => { // 这里是自己实现一个 v-model
  20. this.itemConfig.value = nVal
  21. }
  22. }
  23. }, this.itemConfig.optionData && this.itemConfig.optionData.map(option => {
  24. // 这里只是 本demo 处理 el-select 的 option 数据,实际大家根据具体业务来实现即可
  25. return createElement(el-option, { props: { label: option.label, value: option.value } })
  26. }))
  27. ])
  28. }
  29. }
  30. </script>

接下来我们在 app组件 中同时应用我们的 配置 + FormItemDemo 组件:

  1. <template>
  2. <div>
  3. <el-form label-width="100px">
  4. <FormItemDemo v-for="item in config" :item-config="item" />
  5. </el-form>
  6. </div>
  7. </template>
  8. <script>
  9. import FormItemDemo from "./components/FormItemDemo.vue";
  10. import config from "./config";
  11. export default {
  12. name: App,
  13. components: { FormItemDemo },
  14. data () {
  15. return {
  16. config
  17. }
  18. }
  19. }
  20. </script>

这时候我们看下页面长什么样?

image.png

ok!!!实现了,接下来,我们只需要根据业务需求不断丰富我们的 FormItemDemo 组件即可。这里,笔者会带着大家一起实现一个 联动显示隐藏下拉框多选 的功能~相信看完后,你一定有醍醐灌顶的感受,然后就可以自己根据业务去实现需求了。

4.丰富组件能力,实现业务

  1. 我们先来看第一个需求:
    • 当活动区域的值为 “area1” 时, 活动名称才展示

分析一下这个需求,我们的 input组件select组件 联动,所以 input组件 要获取 select组件 的值,这时候,我们可以在 app组件 中,将整个 config 传入 FormItemDemo组件

再回看一下我们的配置,我们把显示隐藏的配置放在 options.vIf 中(这里笔者设计成了一个数组,因为碰到的业务经常存在一个表单会受到好几个表单值联动的),所以 FormItemDemo组件 需要用这个来判断是否执行本次 render 以此来实现 v-if。如图所示:
image.png

笔者用了一个 computed 去实现这个需求。大家可以不用仔细深入,只要知道 componentShow 的作用就是,找到联动的 relationKeyconfig 中的 value 值,判断是否跟配置的一致。

  1. computed: {
  2. componentShow () {
  3. const vIfArr = this.itemConfig?.options.vIf
  4. if (!vIfArr) return true
  5. const relationArr = this.config.filter(config => vIfArr.find(vIf => vIf.relationKey === config.formKey))
  6. for (const relationItem of relationArr) {
  7. const vIfItem = vIfArr.find(_ => _.relationKey === relationItem.formKey)
  8. // 这里就是判断 联动的表单值 是否不满足 可以显示 的条件,不满足则不显示
  9. if (relationItem.value !== vIfItem.value) return false
  10. }
  11. return true
  12. }
  13. }

模拟实现 v-if,只需要把上述计算属性在 render 的开头进行判断即可
image.png

ok,直接看下结果!两个表单项之间的联动完成了
屏幕录制2022-05-15-15.24.05.gif

  1. 接下来的需求,大家自行思考下怎么实现即可。其实都是异曲同工的
    • 控制 select 多选 、 单选
    • 添加 filter 属性 …

好了,这样子,基本上就大功告成了,只要我们把 FormItemDemo 的业务逻辑都实现了,后续不管开发N个表单系统,我们只需要配置就完事了,摸鱼也就是板上定钉的事情了~但是,一个优秀的前端,怎么能这么算了呢?我们好歹也要做一点优化是吧?

三、配置静态化

细心的朋友可能已经发现了,我们上述实现配置化的时候,直接把整个 config 赋值给 data ,然后在 App组件 的 el-formv-for 使用,那这样避免不了就会出现一些尴尬的事情,比如我们看下图:

image.png

没错,就如大家所见,所有的属性都带上了 gettersetter,这意味着,他们都被初始化成了响应式的。由于我们的业务是非常复杂的,所以当我们真的要用一个 config 去描述整个表单时,config 的规模远不止以上这么点,并且整个配置对象的层级可能还会比较深,如果这样的话就可能会有性能问题了。

熟悉 Vue2 的同学都知道,初始化的时候,会对 data 做一个深度遍历添加 getset 变成响应时数据,并且在组件执行 render函数 时,会访问到这些对象的属性。一旦访问到,就会触发 data属性 的依赖收集动作,如果无脑多的属性时,这个 get方法 将被无脑执行。

这肯定不符合我们这种优秀的前端的作风的是吧?怎么搞,优化呗。思路我们也不自己想了,直接拿 尤大 的处理来耍吧哈哈哈。😝

有深入看过 Vue2 源码的同学,对 __ob__ 这个属性一定不陌生,上面截图也有这个属性,但是大家发现没,这个 ob属性 却没有对应的 getset 。让我们打开源码,看看 尤大 做了什么?

首先,在进行响应式处理之前,调用了一个 def 的方法,这里 第四个参数 是没传的
image.png

看看 def 的具体实现,其实就是重新定义这个对象的属性。由于没传 enumerable,所以此时 __ob__enumerablefalse
image.png

这样有什么用?一句话概括就是无法遍历到这个属性,后续响应式初始化时也会跳过这个属性。不清楚的伙伴可以看看笔者写的一个 demo 来加深理解:

image.png

没错,我们这里也是采用同样的方式对我们的 config 进行 非响应式 优化。其实整个 config 数据,我们只是需要保证 value 是响应式的即可,其他很多描述性数据都是大可不必的。那我们就把其他字段进行一个优化~

  1. // 优化函数
  2. function optimize (array) {
  3. return array.reduce((acc, cur) => {
  4. for (const key of Object.keys(cur)) {
  5. if (key === value) continue
  6. // 将不是 value 的属性都进行非响应式优化
  7. Object.defineProperty(cur, [key], { enumerable: false })
  8. }
  9. acc.push(cur)
  10. return acc
  11. }, [])
  12. }

具体就不展开介绍函数实现了,大家 get 到思路就 ok 了(有兴趣的可以细看一下)~

此时,我们再打印 config 来看看变成什么样了:

image.png

ok,这下就舒服了~终于大功告成了!!!


写在最后,其实这个是我差不多一年前的实践了,一直在分享与不分享之间徘徊。因为这类型的文章,不会引起很多共鸣,也不会为我带来流量和影响力,但是嘛,说不定有跟我之前遇到一样境况的小伙伴,又或者是大家有更好的见解建议能为我带来提升,所以我还是决定分享出来。

平时更多的开发伙伴都会吐槽天天在业务中摸爬打滚,项目没有亮点,这个是不可否认也不可避免的现状吧~企业本就是为了盈利生产,不可能每时每刻都能有技术挑战的活下来,更多时候我们可能是平庸的业务中度过。但是,我们能否在平庸的业务中再拓展出更高效、更便捷的方式,说不定这就是一种突破和亮点吧。

虽然你们可能不会认可,但是这的的确确是让我开发效率提升大半以上的方案,并且出去面试我也是把这一条放在第一点去写。它可能不是特别亮点,不是特别完善,但对我个人而言,我从 设计 - 实现 - 优化 的每一步都有自我的思考且落地,对我自己而言,它就是亮点了。最后,希望能帮助到有需要的大🔥,大家可以早点下班,留给多的时间给自己去享受生活!

关注我,我是励志成为一个宝藏前端的小开发~


5.22更新:

看了掘友评论,笔者感觉需要强调一下本文的主旨思路:业务定制化的配置开发方案。说白了,就是为了解决相似度较高的业务场景带来的代码冗余重复工作量的问题。

文章给的案例只是很基础的demo,投产要比这个复杂得多。不要给当前的 demo 困住想法了,也不要给评论先入为主带走了。如果不想定制化实现业务逻辑,可以把业务逻辑再包装到一层组件里,然后通过 type 传入,render函数 处笔者有说明 render函数 可以接受组件对象。也可以在demo的基础上扩充几个 slot 来实现更多的场景需求。大家只要能把思路 get 到,自己玩起来其实可以创造很多种实现方式的。

本文不是以组件封装、基础建设为出发点的,全文主旨完全无关。请大家一定要注意“基础开发”和“业务开发”的区别。基础具备强大的可拓展、通用性;而业务,往往是分领域、分场景、分用户…偏向定制化的。本文针对的是后者,业务场景。

其实整方案的逻辑就是:配置 -> 集成业务逻辑的renderer -> 前端。提升的点就在于我们相似业务的开发不再需要解决业务逻辑问题,直接配置。所以千万不要往“基础”去靠,简直牛头不对马嘴,这就是针对业务的思路。

技术和方案,肯定不是最完美的。你甚至可能觉得漏洞百出,难以为继。即使是当初我在设计和实现这套方案的时候,也是有这样的想法,但是问题就是这么被一个个解决的。如果不是我成功应用到生产的技术方案,我压根也不会拿来分享。所以,没有绝对完美的技术方案和设计,只有适不适合。根据场景选择合适的技术方案很重要

很多持反对、怀疑态度的掘友,笔者认为这是很正常的,因为可能没有自己实践过,解决实际的问题。有时候只靠想真的不行,必须得去做。我一开始也是想各种场景,很难实现,但真正的去做,去解决问题,还是可以做成的。所以,办法总比困难多,而且真的得自己动手

强调一点,笔者属于实干型,有问题就解决。像“我们支持不了”这种,我还真的从没有过这样的想法。能这么想的、说的人,到底是真的实现不了还是自己能力不行?甚至不是能力的问题,简直是态度的问题了。

如果硬是要用基础的眼光看待这个思路,自己在那YY场景批判可拓性,我只想说:没必要。真的要从基础出发,如果我说:“我写一行div,拓展性够强了吧?”可拓性够强了吧?爱怎么拓展怎么拓展,想干嘛干嘛,还只需要一行代码呢。但是能解决当前的业务场景吗?

笔者见识短浅、存在短板这不假,不过方案绝对是能解决问题才拿出来分享的,绝对不是一时口嗨来写的文章。还是那句,各路大神各取所需。评论区还是很多中肯的评判和很多方案的建议,笔者也打开了眼界,很挺是开心的。

不过嘛,不管你是支持这个方案,还是反对这个方案,大家都理性看待,评论区还是以技术为主导展开讨论,不要到撕逼了。这里笔者带了个坏头,在此跟大伙道个歉,对不起,笔者一定更加专注于技术和反思自己的问题,给大家分享更多好玩的前端方案。

ending:没有绝对完美的技术和方案,只有合适与否,就到这里吧。


文章标签:

原文连接:https://juejin.cn/post/7098211898990002207

相关推荐

中杯超大杯中间的新选择——vue2.7+vite+ts实践

Vue详解知识概括

使用vuepress从零开始搭建我的技术文档|已部署到线上

JavaScript中一些流行的模块、vite快速搭建、vue3简梳理

从0搭建Vue3组件库之Icon组件

什么?都2022年了,你还在一遍又一遍重复写form表单?

Vue3 中如何加载动态菜单?

vue源码解读十: 响应式对象

vue|运行 npm run xxx 的时候发生了什么?

【一库】semver:语义版本号标准 + npm的版本控制器🧲

试着换个角度理解低代码平台设计的本质

Vite 也可以模块联邦

vue3 写个task list,带你了解基础用法

The Last Naruto

从零开始搭建一个VUE项目 三种方式

Vue3+Node实现一个WebSocket即时通讯聊天室

Vue与React对比(基础篇) : 一、Hello World

Vue3 + TypeScript 开发一个 ProTable(第二弹)

Vue中怎么自动注册组件、过滤器?

理论+实践,彻底掌握Vue自定义指令