经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置:技术经验 » JS/JS库/框架 » JavaScript » 查看文章
基于react hooks,zarm组件库配置开发h5表单页面
来源:cnblogs  作者:记忆的森林  时间:2021/4/6 10:08:38  对本文有异议

最近使用React Hooks结合zarm组件库,基于js对象配置方式开发了大量的h5表单页面。大家都知道h5表单功能无非就是表单数据的收集,验证,提交,回显编辑,通常排列方式也是自上向下一行一列的方式显示 , 所以一开始就考虑封装一个配置化的页面生成方案,目前已经有多个项目基于此方式配置开发上线,思路和实现分享一下。

使用场景

任意包含表单的h5页面(使用zarm库,或自行适配自己的库)

目标

  1. 代码实现简单和简洁
  2. 基于配置
  3. 新手上手快,无学习成本
  4. 老手易扩展和维护

写之前参考了市面上的一些方案 ,大多都是通过定义json schema方式定义一套格式, 比如阿里的form-render ,通过 JSON Schema定义表单, 有可视化编辑器配置,导出json文件,动态渲染,凡此种种,无出其外。 这里就以阿里form-render为代表,谈谈它的一些缺陷 (优点自行参考官网宣传)

form-render或思路一些缺陷

  1. 我的目标是h5, form-remder目前仅仅是pc后台表单配置方案,提供了antd和fusion主题,默认不支持h5
  2. form-render 支持扩展组件,内部维护了一个映射表 mapping, 映射了数据类型和组件的映射关系,比如antd主题各数据类型和antd组件的映射关系如下,如果我有一套自己的/第三方公司统一使用的h5组件库,需要自己去配置扩展,比较麻烦。
  1. // 例如在antd下映射如下:
  2. export const mapping = {
  3. default: 'input',
  4. string: 'input',
  5. array: 'list',
  6. boolean: 'checkbox',
  7. integer: 'number',
  8. number: 'number',
  9. object: 'map',
  10. html: 'html',
  11. 'string:upload': 'upload',
  12. 'string:date': 'date',
  13. 'string:dateTime': 'date',
  14. 'string:time': 'date',
  15. 'string:textarea': 'textarea',
  16. 'string:color': 'color',
  17. 'string:image': 'input',
  18. 'string:email': 'input',
  19. 'string:url': 'url',
  20. 'range:date': 'dateRange',
  21. 'range:dateTime': 'dateRange',
  22. '*?enum': 'select',
  23. 'array?enum': 'checkboxes',
  24. };
  1. 如果用过/开发过 form-render 等基于json schema的工具, 有一个需求处理比较麻烦, 比如表单字段联动处理, form-render 提供了有限的几个联动属性,ui:options,ui:disabled,ui:hidden等, 这样算下来,除了需要掌握form-render定义的数据类型,数据类型主题组件映射,及组件关联的各种属性,还要背下额外的联动属性,不外乎多学了一门新编程的复杂程度,所以需要可视化界面辅助编辑。
  1. import React, { useState } from 'react';
  2. import FormRender from 'form-render/lib/antd';
  3. const schema = {
  4. type: 'object',
  5. properties: {
  6. select: {
  7. title: '单选',
  8. type: 'string',
  9. enum: ['a', 'b'],
  10. enumNames: () => ['显示输入框', '隐藏输入框'],
  11. 'ui:disabled': (formData, rootValue) => rootValue.input1.length > 5,
  12. 'ui:widget': 'radio',
  13. },
  14. input1: {
  15. title: '输入框',
  16. description: '尝试输入超过5个字符',
  17. type: 'string',
  18. 'ui:hidden': (formData, rootValue) => formData.select === 'b',
  19. },
  20. },
  21. };
  22. const Demo1 = () => {
  23. const [formData, setFormData] = useState({});
  24. return (
  25. <FormRender schema={schema} formData={formData} onChange={setFormData} />
  26. );
  27. };
  28. export default Demo1;
  1. 这种配置的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端同样适用) ,例如下面的配置

  1. import React, { useState, useEffect } from 'react';
  2. import FormRenderer from 'zarm-form-render';
  3. import { Input, Cell, Radio, Select, DateSelect, Button, Toast, Panel } from 'zarm';
  4. export default function App() {
  5. const [data, setData] = useState({});
  6. const layoutData = [
  7. {
  8. type: Input,
  9. label: '被保人姓名',
  10. placeholder: '请填写',
  11. name: 'name',
  12. },
  13. {
  14. type: Radio.Group,
  15. label: '性别',
  16. name: 'gender',
  17. elProps: {
  18. type: 'button',
  19. ghost: true,
  20. },
  21. items: [
  22. { label: '男', value: 'male' },
  23. { label: '女', value: 'female' },
  24. ],
  25. },
  26. {
  27. render() {
  28. if (!data.gender) return null;
  29. return <Cell title="你是" description={data.gender === 'male' ? '男生' : '女生'}></Cell>;
  30. },
  31. },
  32. {
  33. type: Select,
  34. label: '爱吃的水果',
  35. name: 'favfood',
  36. elProps: {
  37. dataSource: [
  38. { label: 'apple', value: 'apple' },
  39. { label: 'banana', value: 'banana' },
  40. ],
  41. },
  42. },
  43. {
  44. type: DateSelect,
  45. label: '出生日期',
  46. title: '被保人出生日期',
  47. placeholder: '请选择',
  48. name: 'birthday',
  49. min: '1900-01-01',
  50. },
  51. {
  52. type: Input,
  53. label: '手机号',
  54. placeholder: '请填写',
  55. name: 'mobile',
  56. },
  57. {
  58. render() {
  59. return <div style={{ margin: '30px 6px',}}></div>;
  60. },
  61. },
  62. {
  63. render() {
  64. return (
  65. <Panel title="你录入的内容">
  66. <div style={{ margin: '10px 6px' }}>{JSON.stringify(data)}</div>
  67. </Panel>
  68. );
  69. },
  70. },
  71. ];
  72. return (
  73. <div>
  74. <FormRenderer layoutData={layoutData} data={data} setData={setData} />
  75. <Button block theme="primary" onClick={() => Toast.show(JSON.stringify(data))}>
  76. 确定
  77. </Button>
  78. </div>
  79. );
  80. }

一个表单由一个数组定义,对象type为要渲染的组件, name为收集数据的key,其他属性定义组件其他的props, 基于哪个库,则参考相关库的组件API文档配置即可,对于一些特殊的/不存在的组件我们定义render函数动态渲染,然后就没有其他的了,全部是你熟悉的React, 最终我们可以定义一个自己的FormRender 接受一个一维数组用于从上往下排列表单项( 用render 不限于表单项,你可以render任意内容), 一个data用于数据收集,一个setData用于数据更新 (源自React Hooks useState), 就这么简单,源码如下

  1. import React from 'react';
  2. import { Cell, Radio, DateSelect, Select } from 'zarm';
  3. // 对于无法配置(比如自定义组件,需要根据条件显示的组件等)的情况, 请使用render方法,
  4. // getJSON() 动态返回json
  5. // render() 自定义render
  6. export default function FormRenderer({ layoutData, data, setData }) {
  7. const onFiledChange = (name, value) => {
  8. let v = value;
  9. // for Select ctrl
  10. if (Array.isArray(value)) {
  11. v = value.map((item) => item.value)[0];
  12. }
  13. setData({ ...data, [name]: v });
  14. };
  15. const onChangeFactory = (name) => (value) => onFiledChange(name, value);
  16. return (
  17. <div className="renderer">
  18. {layoutData.map((item, idx) => {
  19. if (typeof item.getJSON === 'function') {
  20. item = item.getJSON();
  21. }
  22. if (typeof item !== 'object' || !item) return null;
  23. const {
  24. name,
  25. type,
  26. description,
  27. items,
  28. elProps = {},
  29. cellProps = {},
  30. render,
  31. ...props
  32. } = item;
  33. if (typeof render === 'function') {
  34. return render();
  35. }
  36. let children = [];
  37. if (Array.isArray(items) && type === Radio.Group) {
  38. children = items.map((it, idx1) => (
  39. <Radio value={it.value} key={idx1}>
  40. {it.label}
  41. </Radio>
  42. ));
  43. }
  44. props.value = data[name];
  45. props.onChange = onChangeFactory(name);
  46. if (type === Select) {
  47. props.dataSource = items;
  48. }
  49. if (type === DateSelect || type === Select) {
  50. props.onOk = props.onChange;
  51. delete props.onChange;
  52. props.onChange = elProps.onChange;
  53. }
  54. return (
  55. <Cell key={idx} title={item.label} description={description} {...cellProps} name={name}>
  56. {React.createElement(type, { ...props, ...elProps }, ...children)}
  57. </Cell>
  58. );
  59. })}
  60. </div>
  61. );
  62. }

配置说明

  1. import * as React from 'react';
  2. export interface Item {
  3. type: React.Component; // 组件类型, 比如Input 等
  4. name: string; // key
  5. items?: Array<any>; // dataSource
  6. description: string; // Cell description
  7. label?: string; // Cell title
  8. render?: () => React.ReactNode; //自定义 render
  9. getJSON?: () => object | null; // 动态返回Item配置
  10. elProps?: object; // 组件的props配置 , 比如type为Input, elProps则会配置到Input
  11. cellProps?: object; // cell props配置
  12. }
  13. export interface Props {
  14. layoutData: Array<Item>; // 表单布局配置
  15. data: object; // 数据存储,name作为key,内容为value
  16. setData: () => void; // 数据更新
  17. }
  18. interface FormRenderer extends React.FC<Props> {}
  19. declare const FormRenderer: FormRenderer;
  20. export default FormRenderer;

上述代码效果如下

d.png

b.png

c.png

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

原文链接:http://www.cnblogs.com/leonwang/p/14618280.html

 友情链接:直通硅谷  点职佳  北美留学生论坛

本站QQ群:前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

W3xue 的所有内容仅供测试,对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接(目前9元/月)请联系QQ:27243702 沸活量
皖ICP备17017327号-2 皖公网安备34020702000426号