基於react hooks,zarm元件庫配置開發h5表單頁面

記憶的森林發表於2021-04-05
ReactHook元件H5

最近使用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元件庫，需要自己去配置擴充套件,比較麻煩。
// 例如在antd下對映如下：
export const mapping = {
  default: 'input',
  string: 'input',
  array: 'list',
  boolean: 'checkbox',
  integer: 'number',
  number: 'number',
  object: 'map',
  html: 'html',
  'string:upload': 'upload',
  'string:date': 'date',
  'string:dateTime': 'date',
  'string:time': 'date',
  'string:textarea': 'textarea',
  'string:color': 'color',
  'string:image': 'input',
  'string:email': 'input',
  'string:url': 'url',
  'range:date': 'dateRange',
  'range:dateTime': 'dateRange',
  '*?enum': 'select',
  'array?enum': 'checkboxes',
};
  1. 如果用過/開發過 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;
  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端同樣適用） ，例如下面的配置

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';

// 對於無法配置(比如自定義元件，需要根據條件顯示的元件等)的情況， 請使用render方法，
// getJSON() 動態返回json
// render()  自定義render

export default function FormRenderer({ layoutData, data, setData }) {
  const onFiledChange = (name, value) => {
    let v = value;

    // for Select ctrl
    if (Array.isArray(value)) {
      v = value.map((item) => item.value)[0];
    }

    setData({ ...data, [name]: v });
  };

  const onChangeFactory = (name) => (value) => onFiledChange(name, value);

  return (
    <div className="renderer">
      {layoutData.map((item, idx) => {
        if (typeof item.getJSON === 'function') {
          item = item.getJSON();
        }
        if (typeof item !== 'object' || !item) return null;
        const {
          name,
          type,
          description,
          items,
          elProps = {},
          cellProps = {},
          render,
          ...props
        } = item;

        if (typeof render === 'function') {
          return render();
        }

        let children = [];
        if (Array.isArray(items) && type === Radio.Group) {
          children = items.map((it, idx1) => (
            <Radio value={it.value} key={idx1}>
              {it.label}
            </Radio>
          ));
        }

        props.value = data[name];
        props.onChange = onChangeFactory(name);

        if (type === Select) {
          props.dataSource = items;
        }
        if (type === DateSelect || type === Select) {
          props.onOk = props.onChange;
          delete props.onChange;
          props.onChange = elProps.onChange;
        }

        return (
          <Cell key={idx} title={item.label} description={description} {...cellProps} name={name}>
            {React.createElement(type, { ...props, ...elProps }, ...children)}
          </Cell>
        );
      })}
    </div>
  );
}

配置說明

import * as React from 'react';
export interface Item {
  type: React.Component; // 元件型別， 比如Input 等
  name: string; // key
  items?: Array<any>; // dataSource
  description: string; // Cell description
  label?: string; // Cell title
  render?: () => React.ReactNode; //自定義 render
  getJSON?: () => object | null; // 動態返回Item配置
  elProps?: object; // 元件的props配置 , 比如type為Input, elProps則會配置到Input
  cellProps?: object; // cell props配置
}
export interface Props {
  layoutData: Array<Item>; // 表單佈局配置
  data: object; // 資料儲存,name作為key,內容為value
  setData: () => void; // 資料更新
}
interface FormRenderer extends React.FC<Props> {}
declare const FormRenderer: FormRenderer;
export default FormRenderer;

上述程式碼效果如下

d.png

b.png

c.png

 這種方式唯一缺點是無法像json一樣持久化儲存在資料庫 ，優點是可以統一移動和pc端表單配置式開發，少了大量的樣板程式碼和巢狀， 可以統一處理資料的存取和驗證, 表單項的排列方式 。 

相關文章