noForm - 基于 React 的表单解决方案


Apache
跨平台
JavaScript

软件简介

表单在前端可谓是非常常见的场景,而且通常需要花费开发非常多的时间来处理各种复杂的逻辑。特别是在企业中后台的业务中,存在着大量的表单,比如客户的订单,投诉的问题单,服务跟进过程每个流程的流转。凡是存在用户输入的地方都存在着各种各样的表单,字段或多或少,逻辑或繁或简。需求一旦变动,造成的代码变动(代码量或者逻辑分支)可能是非常恐怖的。比如当A字段选择了x的时候,增加B,C,D三个字段。相信这是非常多前端开发非常苦恼的问题。

NoForm

NoForm是阿里巴巴外综服前端团队在外综服(外贸综合服务)场景下,经过长期的思考和打磨产出的一款基于React的表单解决方案。可能有人不理解,可能会问:表单嘛,能有多复杂?
可能你从没见过一个表单需要填写150+个字段。可能你也没有见过一个表单实际是由10+个子表单组合出来的。可能你也没见过一个表单的字段是后端动态配置的。
NoForm从解决业务复杂性的角度出发,找到了几个抓手,将表单方案进行了优化和开源。

官网链接官方文档

框架特点

  • 状态管理

  • 核心控制

  • 组件标准

  • 场景定制

  • 工具方法

状态管理

大家开发过程中肯定遇到过一个实体,增改查操作,每个操作都需要一个页面来实现功能,可能还各有差异,但差异又不大。这样的琐事非常耗费精力,新增的表单所有字段都可以展示编辑,修改的表单部分字段不能编辑,而详情的表单都不可以编辑。
在 NoForm 中,使用了状态来解决这一问题,状态包括编辑 预览 禁用
隐藏。通过这样的状态可以快速切换表单,使一份表单代码不仅可以做表单,也可以做详情,也可以做编辑。写一份代码相当于写多分状态页。
而状态的粒度是可以单独控制的,你可以控制整个表单切换状态,也可以控制某个字段的状态。这样在应对 当性别为男性的时候,三围字段不展示
这样的需求时,就不会非常棘手了。文档

核心控制

上面提到了状态管理,而核心则是控制状态以及其他功能的手段。NoForm 对外暴露的一切只有一个 formCore 的对象,所有对表单进行操控的方法都在这个
formCore 对象上面。表单的核心具体做了哪些事情呢?文档

  • core 对值的管理主要体现在 onChange 上,当有 onChange 时,抛出一个事件。其他需要监听值变化的组件能能够收到。value 的默认值为 null。

  • 状态 当值变化时,或直接对状态进行操作时,状态会变化。这个变化会传递给字段的组件,组件会根据不同的状态进行展示的切换。

  • 错误 当手动操作校验,或启用了自动校验时,会使用配置的校验规则进行校验,把校验结果放到 错误

  • 属性 属性是指需要透传到React组件的其他属性,比如Select组件,可以通过props传递过去。props可以写成一个function,最终的结果会传递给组件。这对于动态显示Select的场景非常有帮助

  • 校验规则 校验规则使用了开源的 async-validator 校验库

组件标准

关于表单组件, 我们常见的 Input Radio Checkbox Select TextArea,那什么是组件标准?这里的组件标准是拥有 value
属性和 onChange 回调(当值变化时把值作为第一个参数回传)的组件都可以在NoForm中作为字段组件使用。目前绝大部分的组件库也都是这样设计的,所以
NoForm
其实可以跟绝大部分的组件库混合使用。而对于不兼容的组件库或者单个的组件,可以通过一个wrapper来做一个简单的封装。最简单的封装是input,input的onChange里面的参数是event,而
NoForm 实际期望是 value ,这时就需要一个wrapper。文档

场景定制

表单并不是简单的字段的罗列,还有可能是有组织的。这里主要提炼了两个表单场景 Repeater,Accordion。
Repeater,拿收货地址来举个例子,收货地址能能有多个,我们需要维护一个收货地址的列表,可以添加,更新,删除。这就是Repeater大展实力的场景。参见文档
Accordion,当一个表单字段非常多时,Accordion能够很棒的将表单按照设定好的类别进行步骤切分,并且给用户一种按步填写就完成的引导。不会一次将所有字段展示给用户(那会吓到用户),而是分步骤的展示。

工具方法

目前提供的工具方法主要是校验规则的工具方法,通过工具方法可以非常方便的编写校验规则。例如

import rules from 'noform/validate';
const validateConfig={
    name: rules.required('name', '名称不能为空'),
    email: [rules.required('email', '邮箱不能为空'), rules.email('email', '邮箱格式不正确')]
}

未来还有更多,敬请期待~