可视化搭建系统之数据源 https://www.zoo.team/article/visual-construction
接上一篇文章 前端工程实践之可视化搭建系统(一)鸽了比较久,看过的同学应该也都已经不记得了,也是又看到两年前文章下热评一位同学问的问题,两年后我们换个形式来讨论下这个问题(手动艾特水白泉同学)。
众所周知,可视化搭建系统是为了提效,从纯人工撸代码开发需求到拖拖拽拽完成业务需求,大大提高了效率,降低了开发同学的压力。我司可视化搭建系统鲁班也已投入使用两年有余,取得的效果也十分显著,但由于时间的推移,问题也逐渐暴露出来:
如何帮助运营同学提效?如何提高组件复用性同时并降低组件业务耦合度?这就是我们今天要聊的主题,可视化搭建系统中的数据源。
从字面上来看,其实就是数据的来源,告诉应用所需要的数据在什么位置。数据源保证了应用程序与目标数据之间交互的规范和协议,它可以是数据库,也可以是 Excel 等等。
上文介绍了什么是数据源以及在当前搭建系统中我们遇到的问题,下面我们就从需求入手,先充当起产品的角色,针对需求我们先做问题分析,然后我们再做详细设计。
分析:组件中的重复配置,其中以营销场景以及前台大厅为主,这两块承载了我司大量的业务场景,其中各个组件的配置复杂且配置项繁多,其中又会出现针对不同的区划做不同的数据项配置,一旦差异化配置过多,重复配置会不断变多,维护起来会非常困难。
设计:从组件配置入手,正常业务开发中我们使用接口传参来获取差异化的数据,来做动态数据展示以及控制各项配置的开关。可视化搭建中控制配置项的开关我们已经有了,缺的是不是就是一个接口,我们能不能让组件中的配置也变成一个接口,这样即使组件数据出现差异性,我们也可以通过入参的不同来下发不同的数据来决定组件应该展示什么数据。
分析:组件由各业务团队同学自行开发贡献,开发水平不一导致组件设计不同,有的同学喜欢把接口抽离成组件配置,有的同学又喜欢把接口直接写在组件内部,两者都有优缺点我们不做评价,时间久了,使用前者的组件使用难度会很高,一旦维护的同学离职,组件直接就变黑盒了,使用后者的不然,除了当时服务过的需求可以使用这个组件,其他即使视觉层面一致的需求,也由于组件内部耦合的特殊业务接口,让其他业务团队宁愿重新开发也不敢在用这个组件。两者最终得到的结果其实都是一样的,组件复用性降低。
设计:如何提高组件复用性,从上述问题点接口入手,如果我们将可以将接口外置,动态与组件配置对接,也就是组件既可以使用外部接口做配置,也可以使用自己的静态配置,是不是就可以解决上述问题。
下面是根据上述需求分析设计,产出的 PRD 简版脉络:
下面我们根据上述 PRD 脉络来看数据源的详细设计。
前面有提到,数据源我们可以使用接口,业务侧有后端同学,不用多想,数据源直接用后端同学写的接口就完事了,但是我们的搭建平台大多用户为运营同学,业务场景基本上都无后端同学投入,这个时候问题就来了:
如何不用开发同学介入创造一个接口来跟组件做绑定呢?我们继续往下看。
基于内部系统神笔,我们解决了这个问题,神笔是什么,神笔是个数据投放接口管理平台,可以让不懂代码的业务一样可以写接口。神笔中有静态化这么一个定义:
静态化:即从 0 到 1 创建一个接口,接口入参以及出参支持自由定义,数据纯静态,可以自定义高级规则来根据入参不同返回不同的数据。
哎,这不就是我们想要的嘛。使用神笔静态化,业务同学可以基于自己的需求,创造自己的接口来下发不同的数据,自给自足,妈妈再也不用担心我不会写接口啦。
进入组件管理,选择需要关联的组件,点击数据源维护。由于组件业务属性不同,对应的数据源也会存在差异性,为了避免运营同学配置数据源时,出现选择困难症,我们以组件维度关联数据源,一个组件可以关联多个数据源,搭配数据源描述,让运营同学可以最快选到需要的数据源。
新增数据源,目前我们使用最多的数据源多为 API 类型,也就是我们每天都在浏览器里看到的接口,在新增弹窗内输入我们已有的接口或者神笔注册的接口信息,配置好接口地址,请求方式,请求头,请求参数,以及最重要的接口出参字段与组件数据字段之前的映射关系,输入完成后就完成了数据源与组件的关联。
维护接口与组件内部暴露字段的映射关系,输入框会自动检测映射关系是否正确。
进入我们需要搭建的页面,选择我们已绑定数据源的组件,右侧配置面板选择我们绑定的数据源,保存页面配置,即可完成在页面组件中使用数据源。
这一块我们在搭建侧做统一收拢,对一个页面所有组件选择使用的数据源做统一处理。
为什么这么做?
其他还有很多优点不再赘述,感兴趣的同学欢迎一起讨论。
注入流程如下:
流程图如下:
数据源是搭建系统建设过程中重要的一环,为提效再进一步,他不仅降低了页面的重复搭建,还收拢了差异化配置的入口,并且让运营同学可以做一些研发同学才可以做的事:接口创建、引用、发布等。以上是我个人对搭建系统中数据源的一些总结,后续还会继续分享数据投放相关,如有错误,劳烦指正修改,感谢各位能看到这里。