最近使用React Hooks结合zarm组件库,基于js对象配置方式开发了大量的h5表单页面。大家都知道h5表单功能无非就是表单数据的收集,验证,提交,回显编辑,通常排列方式也是自上向下一行一列的方式显示 , 所以一开始就考虑封装一个配置化的页面生成方案,目前已经有多个项目基于此方式配置开发上线,思路和实现分享一下。
使用场景
任意包含表单的h5页面(使用zarm库,或自行适配自己的库)
目标
- 代码实现简单和简洁
- 基于配置
- 新手上手快,无学习成本
- 老手易扩展和维护
写之前参考了市面上的一些方案 ,大多都是通过定义json schema方式定义一套格式, 比如阿里的form-render ,通过 JSON Schema定义表单, 有可视化编辑器配置,导出json文件,动态渲染,凡此种种,无出其外。 这里就以阿里form-render为代表,谈谈它的一些缺陷 (优点自行参考官网宣传)
form-render或思路一些缺陷
- 我的目标是h5, form-remder目前仅仅是pc后台表单配置方案,提供了antd和fusion主题,默认不支持h5
- form-render 支持扩展组件,内部维护了一个映射表 mapping, 映射了数据类型和组件的映射关系,比如antd主题各数据类型和antd组件的映射关系如下,如果我有一套自己的/第三方公司统一使用的h5组件库,需要自己去配置扩展,比较麻烦。
- 如果用过/开发过 form-render 等基于json schema的工具, 有一个需求处理比较麻烦, 比如表单字段联动处理, form-render 提供了有限的几个联动属性,ui:options,ui:disabled,ui:hidden等, 这样算下来,除了需要掌握form-render定义的数据类型,数据类型主题组件映射,及组件关联的各种属性,还要背下额外的联动属性,不外乎多学了一门新编程的复杂程度,所以需要可视化界面辅助编辑。
import React, { useState } from 'react';import FormRender from 'form-render/lib/antd';const schema = { type: 'object', properties: { select: { title: '单选', type: 'string', enum: ['a', 'b'], enumNames: () => ['显示输入框', '隐藏输入框'], 'ui:disabled': (formData, rootValue) => rootValue.input1.length > 5, 'ui:widget': 'radio', }, input1: { title: '输入框', description: '尝试输入超过5个字符', type: 'string', 'ui:hidden': (formData, rootValue) => formData.select === 'b', }, },};const Demo1 = () => { const [formData, setFormData] = useState({}); return ( <FormRender schema={schema} formData={formData} onChange={setFormData} /> );};export default Demo1;
- 这种配置的json适合非开发人员快速怼出表单功能, 但是不适合开发人员开发扩展,比如我要在两个输入框中间放个图文混排的东西. (另行开发一个自定义组件挂载?)
javascript object 方案
所以以阿里form-render 等以json配置实现动态渲染的方案不能满足 简单,快速,突破,共赢的码农生存准则, 如果把json换成javascript object , 那配置和扩展的能力就不一样了, 这里我们还是借用form-render的总体思路,但是将type从string,number,boolean,array,object,html等数据类型换成Function,一个Function就是一个React组件,比如antd-mobile ,zarm 的Input组件,因为本文基于zarm, 后面都基于zarm展开(对antd-mobile ,vue等第三方移动端/pc端同样适用) ,例如下面的配置
import React, { useState, useEffect } from 'react';import FormRenderer from 'zarm-form-render';import { Input, Cell, Radio, Select, DateSelect, Button, Toast, Panel } from 'zarm';export default function App() { const [data, setData] = useState({}); const layoutData = [ { type: Input, label: '被保人姓名', placeholder: '请填写', name: 'name', }, { type: Radio.Group, label: '性别', name: 'gender', elProps: { type: 'button', ghost: true, }, items: [ { label: '男', value: 'male' }, { label: '女', value: 'female' }, ], }, { render() { if (!data.gender) return null; return <Cell title="你是" description={data.gender === 'male' ? '男生' : '女生'}></Cell>; }, }, { type: Select, label: '爱吃的水果', name: 'favfood', elProps: { dataSource: [ { label: 'apple', value: 'apple' }, { label: 'banana', value: 'banana' }, ], }, }, { type: DateSelect, label: '出生日期', title: '被保人出生日期', placeholder: '请选择', name: 'birthday', min: '1900-01-01', }, { type: Input, label: '手机号', placeholder: '请填写', name: 'mobile', }, { render() { return <div style={{ margin: '30px 6px',}}></div>; }, }, { render() { return ( <Panel title="你录入的内容"> <div style={{ margin: '10px 6px' }}>{JSON.stringify(data)}</div> </Panel> ); }, }, ]; return ( <div> <FormRenderer layoutData={layoutData} data={data} setData={setData} /> <Button block theme="primary" onClick={() => Toast.show(JSON.stringify(data))}> 确定 </Button> </div> );}
一个表单由一个数组定义,对象type为要渲染的组件, name为收集数据的key,其他属性定义组件其他的props, 基于哪个库,则参考相关库的组件API文档配置即可,对于一些特殊的/不存在的组件我们定义render函数动态渲染,然后就没有其他的了,全部是你熟悉的React, 最终我们可以定义一个自己的FormRender 接受一个一维数组用于从上往下排列表单项( 用render 不限于表单项,你可以render任意内容), 一个data用于数据收集,一个setData用于数据更新 (源自React Hooks useState), 就这么简单,源码如下
import React from 'react';import { Cell, Radio, DateSelect, Select } from 'zarm';
配置说明
import * as React from 'react';export interface Item { type: React.Component;
上述代码效果如下



这种方式唯一缺点是无法像json一样持久化存储在数据库 ,优点是可以统一移动和pc端表单配置式开发,少了大量的样板代码和嵌套, 可以统一处理数据的存取和验证, 表单项的排列方式 。