封裝react antd的form表單元件

小壞先生發表於2020-08-13
封裝ReactORM元件

form表單在我們日常的開發過程中被使用到的概率還是很大的，比如包含了登入、註冊、修改個人資訊、新增修改業務資料等的公司內部管理系統。而在使用時這些表單的樣式如高度、上下邊距、邊框、圓角、陰影、高亮等等都大同小異、大差不差且表單的功能基本相似，所以很有必要對這些表單來一個簡單的封裝。

其實，封裝元件的意義我們在上一篇封裝react antd的表格table元件中已經介紹過了，這裡不再做過多的描述了，且在“封裝react antd的表格table元件”一文中，我們也對相關技術作了簡要介紹。接下來，再來介紹一下本次封裝所用到的其他技術。

本次封裝用到了useForm，官方解釋：useForm是React Hooks的實現，只能用於函式元件。我們可以通過Form.useForm對錶單資料域進行互動，如：setFieldsValue()、getFieldValue()、validateFields()、resetFields()等。

本次封裝還用到了useEffect，它也是React Hooks的實現，相當於componentDidMount和componentDidUpdate以及componentWillUnmount這些生命週期的集合體，但需要注意react首次渲染和之後的每次渲染都會呼叫一遍傳給useEffect的函式，但每次重新渲染都要執行一遍這些副作用函式，顯然對於追求效能的我們來說是很不友好的，那該咋辦呢？useEffect給我們提供了第二個引數，可用於定義其依賴的所有變數。如果其中一個變數發生變化，則useEffect會再次執行，如果包含變數的陣列為空，則在更新元件時useEffect不會再執行，因為它不能監聽到任何變數的變更。關於useEffect的介紹還有很多，可自行查閱API或資料，這裡同樣不再做過多的描述了。

另外本次封裝同樣是混合了JSX和createElement兩種方式來建立虛擬DOM節點，如果你覺得混亂的話，可以使用其中一種方式的。

本次封裝所使用到的方法的介紹基本完畢，以下是元件封裝的具體實現部分。

還是先貼一張最後實現的效果圖：

1、所封裝的antd form元件form.js

import React, { createElement, useEffect, useImperativeHandle } from 'react'
import PropTypes from 'prop-types'
import { Form, Input, Select, DatePicker, Button } from 'antd';
import { timestampToTime } from "@/utils";

const FormItem = Form.Item, { Password } = Input, { Option } = Select, h = createElement;

const FormComponent = ({columns, data, cRef}) => {
  //通過Form.useForm對錶單資料域進行互動。useForm是React Hooks的實現，只能用於函式元件
  const [form] = Form.useForm();
  //cRef就是父元件傳過來的ref
  useImperativeHandle(cRef, () => ({
    //getForm就是暴露給父元件的方法
    getForm: () => form,
  }));

  const layout = {
    labelCol: { span: 4 },
    wrapperCol: { span: 16 },
  },
  tailLayout = {
    wrapperCol: { offset: 4, span: 16 },
  };

  //若有正則驗證，則在所有的正則校驗都通過後用來獲取輸入的資料，若沒有正則校驗，則直接獲取輸入的資料
  const onFinish = values => {
    values.date = timestampToTime(values.date).replace(' ', '')
    console.log(values);
  };

  //重置要配合著const [form] = Form.useForm()以及form={form}
  const onReset = () => {
    form.resetFields();
  };

  //form表單的回顯
  useEffect(() => {
    form.setFieldsValue(data)
  }, [])
  
  const components = {
    select: ({label, list = [], callback = () => {}}) => h(Select, {placeholder: label, onChange: v => callback(v)}, list.map(c => h(Option, {key: c.value, value: c.value}, c.label))),
    input: ({label}) => <Input placeholder={label} />,
    password: ({label}) => h(Password, {placeholder: label}),
    datePicker: ({label}) => <DatePicker placeholder={label} format="YYYY-MM-DD" />,
  }

  return (
    <Form {...layout} form={form} onFinish={onFinish}>
      {
        columns.map(n => {
          n.type = n.type ? n.type : 'input'
          return <FormItem label={n.label} name={n.name} rules={n.rules} key={n.name}>
            {components[n.type](n)}
          </FormItem>
        })
      }
      <FormItem {...tailLayout}>
        <Button type="primary" htmlType="submit" style={{marginRight: '20px'}}>提交</Button>
        <Button htmlType="button" onClick={onReset}>重置</Button>
      </FormItem>
    </Form>
  )
}

FormComponent.propTypes = {
  columns: PropTypes.array.isRequired,
  data: PropTypes.object,
  cRef: PropTypes.object,
}

export default FormComponent

2、時間戳格式化timestampToTime.js

export const timestampToTime = (timestamp, type) => {
  let date = new Date(timestamp); //時間戳為10位需*1000，時間戳為13位的話不需乘1000
  let Y = date.getFullYear() + '-';
  let M = (date.getMonth() + 1 < 10 ? '0' + (date.getMonth() + 1) : date.getMonth() + 1) + '-';
  let D = date.getDate() < 10 ? '0' + date.getDate() + ' ' : date.getDate() + '';
  let h = date.getHours() < 10 ? '0' + date.getHours() + ':' : date.getHours() + ':';
  let m = date.getMinutes() < 10 ? '0' + date.getMinutes() + ':' : date.getMinutes() + ':';
  let s = date.getSeconds() < 10 ? '0' + date.getSeconds() : date.getSeconds();
 
  if (type == 'second') {
    return Y + M + D + ' ' + h + m + s;
  } else {
    return Y + M + D
  }
}

3、form元件的使用方法：

import React, { useState, useRef } from 'react'
import { Button } from 'antd';
import Form from './form'
import { timestampToTime } from "@/utils";

const FormComp = () => {
  //useState只能放在元件內
  let [isRequired, setRequired] = useState(true);
  
  const config = {
    columns: [
      {name: 'userName', label: '使用者名稱', rules: [{ required: true, message: '請輸入使用者名稱' }]},
      {name: 'password', label: '密碼', type: 'password', rules: [{ required: true, message: '請輸入密碼' }]},
      {name: 'confirmPwd', label: '確認密碼', type: 'password', rules: [
        { required: true, message: '請再一次輸入密碼' },
        ({ getFieldValue }) => ({
          validator(rule, value) {
            //如果value為空，!value為true則直接返回Promise.resolve()就會提示“請再一次輸入密碼”
            if (!value || getFieldValue('password') === value) {
              return Promise.resolve();
            }
            return Promise.reject('兩次密碼輸入不一致');
          },
        }),
      ]},
      {name: 'email', label: '郵箱', rules: [
        { required: true, message: '請輸入郵箱' },
        {
          validator:(_, value) => {
            let reg = /^([a-zA-Z]|[0-9])(\w|\-)+@[a-zA-Z0-9]+\.([a-zA-Z]{2,4})$/;
            if(!value || reg.test(value)){
              return Promise.resolve();
            }
  
            return Promise.reject('郵箱格式不正確');
          }
        }
      ]},
      {name: 'gender', label: '性別', type: 'select', rules: [{ required: true, message: '請選擇性別' }], list: [{value: 'male', label: '男'}, {value: 'female', label: '女'}], callback: res => onGenderChange(res)},
      {name: 'highHeeled', label: '高跟鞋', rules: [{ required: isRequired, message: '請輸入喜歡的高跟鞋' }]},
      {name: 'exercise', label: '運動', rules: [{ required: true, message: '請輸入喜歡的運動' }]},
      {name: 'date', label: '日期', type: 'datePicker', rules: [{ required: true, message: '請輸入日期' }]},
    ],
    data: {
      userName: '小壞',
      gender: 'female',
    },
  }

  //切換性別時會顯示隱藏高跟鞋的正則校驗
  const onGenderChange = value => {
    switch (value) {
      case "male":
        setRequired(false);
        break;
      case "female":
        setRequired(true);
        break;
    }
  };

  const childRef = useRef();
  const getFormVal = () => {
    const form = childRef.current.getForm();
    //可以在驗證後再獲取值
    form.validateFields().then(valid => {
      valid.date = timestampToTime(valid.date).replace(' ', '')
      console.log(valid)
    }).catch((e) => {})
    //也可以在不需要正則驗證的地方直接通過這種方式來獲取值
    // console.log(form.getFieldValue())
  }

  return <div>
    <Form {...config} cRef={childRef} />
    <Button type="primary" onClick={getFormVal} style={{marginLeft: '12%'}}>在元件外部獲取form表單的值</Button>
  </div>
}

export default FormComp

在使用封裝的form表單元件時，由於回顯表單資料採用了useEffect方式，所以在切換性別select表單的過程中，就多次觸發了useEffect中的副作用函式，這在我們肉眼可觀察到的範圍內雖然看不到這種變化，但確實是多次觸發了回顯表單資料的函式，這很顯然是造成了效能的浪費，所以我就給useEffect的第二個引數設定了一個空陣列，用來告訴useEffect沒有資料更新，就不會再執行它裡邊的函式了。

最後再貼一下本次封裝所用到的各個包的版本：

react: 16.8.6,

react-dom: 16.8.6,

react-router-dom: 5.0.0,

antd: 4.3.5,

@babel/core: 7.4.4,

babel-loader: 8.0.5

其實最主要的是react和antd的版本，其中antd4和antd3在form元件上的差異還是很大的，在其他元件上的差異也是很大的。

相關文章