管理后臺開發(fā),這種無腦重復(fù)的代碼真不該有!

以下文章來源于政采云前端團隊 ,作者二剛

前言
在日常的中后臺系統(tǒng)開發(fā)中,表單是和我們打交道非常多的名詞。但是在一般的表單實現(xiàn)中、我們會做著很多重復(fù)的工作,不停在寫 FormItem...,以及為組件加上“請輸入/請選擇”等無腦的 placeholder 文本和“請輸入 xx/ 請選擇 xx” 等必填提示。其次表單一般都存在編輯頁和詳情頁,而為了代碼更好的維護性通常會將編輯和詳情用一套代碼實現(xiàn)。此時我們的代碼里就會出現(xiàn) isEdit ?表單組件 :純文本”這樣無腦且重復(fù)率高的代碼。秉承著更少代碼更多產(chǎn)出的原則,我設(shè)計了一套配置化邏輯來提升這一開發(fā)體驗。

一般實現(xiàn)
// 一般實現(xiàn)
import React from 'react';
import { Form, Input, Select } from 'antd';

const Demo = (props) => {
  const { form: { getFieldDecorator }, obj = {}, isEdit } = props;
  return (
    <>
      <FormItem label="姓名" >
        {isEdit ? obj.name || '-' :
          getFieldDecorator('name', {
            initialValue: obj.name,
          })(
            <Input placeholder="請輸入" />
          )
        }
      </FormItem>
      <FormItem label="性別" >
        {isEdit ? obj.sex || '-' :
          getFieldDecorator('sex', {
            initialValue: obj.sex,
            rules: [{ required: true, message: '請選擇性別' }],
          })(
            <Select placeholder="請選擇" >
              <Option key="male" value="male">男</Option>            
              <Option key="female" value="female">女</Option>
            </Select>
          )
        }
      </FormItem>
       <FormItem label="手機號" >
        {isEdit ? obj.phone || '-' :
          getFieldDecorator('phone', {
            initialValue: obj.phone,
            rules: [{ required: true, message: '請輸入手機號' }],
          })(
            <Input placeholder="請輸入" />
          )
        }
      </FormItem>
    <>
  )
}
配置化的實現(xiàn)
// 配置化的實現(xiàn)
import React from 'react';
import { renderDataForm } from 'src/util/renderDataForm';

const Demo = (props) => {
  const { form, obj = {}, isEdit } = props;
  const conf = [{
    label: '姓名', // 表單的 label
    field: 'name', // 表單字段名
    initialValue: obj.name, // 表單默認值
    required: false, // 是否必填、默認必填
  }, {
    label: '性別',
    field: 'sex',
    initialValue: obj.sex,
    formItemType: 'Select', // 表單類型默認 Input
    options: [{ value: 'male', label: '男' }, { value: 'female', label: '女' }], // 下拉選項
  }, {
    label: '手機號',
    field: 'phone',
    initialValue: obj.phone,
  }];
  const dataForm = isEdit ? 'form' : 'text';
  // 傳入 form,表單配置,想要的數(shù)據(jù)形式
  return renderDataForm(form, conf, dataForm));
}
實現(xiàn)思路



如上圖所示,無論是在詳情頁中顯示文本亦或是編輯頁中的表單組件包裹的數(shù)據(jù),其實本身所對應(yīng)的都是同一個數(shù)據(jù),只是展示形式不一樣而已。在這里我們暫時將數(shù)據(jù)的形式定為表單組件形式與文本形式。其實在實際的使用中,由于數(shù)據(jù)的收集形式不同,會出現(xiàn)第三種數(shù)據(jù)形式。它就是表單文本形式,一種以文本展示但數(shù)據(jù)可被表單自動收集的形式,我把它定義為 FormText(如下所示)。至此,針對實現(xiàn)數(shù)據(jù)詳情與編輯形式的方案有了這樣兩種,表單與文本組合或表單與表單文本組合的實現(xiàn)。本次我選擇表單與文本組合的方案。
/**
 * 用于 Form 表單內(nèi)部受控展示文本
 */
export default class FormText extends Component {
  render() {
    const { value, formatMethod = a => a, defaultText = '-', ...resetProps } = this.props;
    return <span {...resetProps}>{formatMethod(value) || defaultText}</span>;
  }
}

// 使用
<FormItem label="姓名">
  {getFieldDecorator('name', {
      initialValue: 'egg',
  })(<FormText />)}
</FormItem>
   
具體實現(xiàn)
1、形式選擇(表單組件 or 文本)

const renderDataForm = (form, conf = {}, dataForm = 'form') => {
  // customRenderText 自定義文本形式
  const { customRenderText } = conf;
  return (
    <FormItem label={conf.label} {...conf.formItemProps} >
      {dataForm === 'form' ? renderFormItem(form, conf) :
        customRenderText ? customRenderText(conf) : renderText(conf) }
    </FormItem>
  );
};
2、表單組件選擇

export const renderFormItem = (form, rest) => {
  const { getFieldDecorator } = form;
  const { label = '', field = '', formItemType = 'input', initialValue, required = true, rules = [], ...itemRest } = rest;
  return (getFieldDecorator(field, {
    initialValue,
    rules: [
      // 必填提示
      { required, message: renderMessage(formItemType, label) },
      ...rules,
    ],
    ...(formItemType === 'upload' ? { // Upload 組件的通用配置
      getValueFromEvent: (e) => {
        if (Array.isArray(e)) {
          return e;
        }
        return e && e.fileList;
      },
      valuePropName: 'fileList' } : {}),
  })(
    renderItem(formItemType, itemRest)
  ));
};

// 選擇表單組件
const renderItem = (formItemType, itemRest) => {
  const { options = [], CustomFormItem } = itemRest;
  const obj = { Input, TextArea, InputNumber, Upload, Select, RadioGroup, CheckboxGroup, DatePicker };
  // 自定義的表單組件
  if (formItemType === 'CustomFormItem') {
    return <CustomFormItem {...itemRest} />;
  }
  // 不存在對應(yīng)組件時返回默認的 Input 組件
  if (!obj[formItemType]) {
    return <Input placeholder="請輸入" {...itemRest} />;
  }
  const Comp = obj[formItemType];
  // 雙標簽組件處理
  if (['Select', 'Upload'].includes(formItemType)) {
    return formItemType === 'Upload' ? (
      <Upload
        {...itemRest}
      >
        <Button><Icon type="upload" />上傳</Button>
      </Upload>
    ) : (
      <Comp {...getDefaultCompProps(itemRest)} {...itemRest} >
        {options.map(el => (
          <Option key={el.value} value={el.value}>{el.label || el.name}</Option>))}
      </Comp>
    );
  }
  // 單標簽組件
  return <Comp {...getDefaultCompProps(itemRest)} {...itemRest} />;
};

// 獲取組件屬性
const getDefaultCompProps = (conf = {}) => {
  const { formItemType } = conf;
  const props = {};
  props.placeholder = renderMessage(formItemType);
  if (formItemType === 'InputNumber') {
    // zeroOmit 小數(shù)點后多余的零是否省略,limitDecimal 限制最長的小數(shù)位數(shù)
    const { zeroOmit = true, limitDecimal = 6 } = conf;
    const limitDecimalsF = (value) => {
      const reg = new RegExp(`^(-)*(\\d+)\\.(\\d{${limitDecimal}}).*$`);
      return `${value}`.replace(reg, '$1$2.$3');
    };
    if (zeroOmit) {
      props.formatter = limitDecimalsF;
      props.parse = limitDecimalsF;
    }
  }
  if (formItemType === 'Input') {
    props.maxLength = 100; // 輸入框的默認最大輸入字符長度
  }
  if (formItemType === 'TextArea') {
    props.maxLength = 500; // 文本框的默認最大輸入字符長度
  }
  return props;
};






3、映射文本

export const renderText = (rest) => {
  const { formItemType = 'Input', initialValue, selectOptions = [], selectMode = '', options = [] } = rest;
  switch (formItemType) {
  case 'RadioGroup':
    return (options.find(item => item.value === initialValue) || {}).label || '-';
  case 'DatePick':
    const { format = 'YYYY-MM-DD HH:mm:ss' } = rest;
    // 日期組件組件值格式化為對應(yīng)的文本
    return initialValue !== undefined ? moment(initialValue).format(format) : '-';
  // ...code
  default:
    return bizStringFormat(initialValue); // 無值時默認 ‘-’
  }
}
4、通用校驗規(guī)則整理

export const postCode = /^[0-9]{6}$/;
export const phone = /^1\d{10}$/;
// ...其他正則

// form rules
export const postCodeRule = {
  pattern: postCode,
  message: '請輸入6位數(shù)字',
};
export const phoneRule = {
  pattern: phone,
  message: '請輸入11位號碼',
};
// ...其他表單校驗規(guī)則


使用示例
const Demo = (props) => {
  const { form } = props;
  // 數(shù)據(jù)
  const obj = {
    email: '123@egg.com',
    addr: '派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星派大星',
    sort: 'up',
    birthday: '1999-01-23',
    sex: 'male',
    file: [{ fileId: '123', name: '信用承諾書', size: 1024 }],
  };
  // 因為數(shù)據(jù)的形式默認為表單,所以 dataForm: 'form' 可不配置
  const formConf = [{
    label: '郵箱',
    field: 'email',
    initialValue: obj.email,
    rules: [emailRule], // emailRule 為郵箱校驗規(guī)則
  }, {
    label: '地址',
    field: 'addr',
    initialValue: obj.addr,
    formItemType: 'TextArea',
  }, {
    label: '排序',
    field: 'sort',
    initialValue: obj.sort,
    formItemType: 'Select',
    options: [{ value: 'up', label: '升序' }, { value: 'down', label: '降序' }],
  }, {
    label: '生日',
    field: 'birthday',
    initialValue: obj.birthday,
    formItemType: 'DatePicker',
    format: 'YYYY-MM-DD', // 日期組件的格式配置字段
  }, {
    label: '性別',
    field: 'sex',
    initialValue: obj.sex,
    formItemType: 'RadioGroup',
    options: [{ value: 'male', label: '男' }, { value: 'female', label: '女' }],
  }, {
    label: '信用承諾書',
    field: 'file',
    initialValue: obj.file,
    formItemType: 'Upload',
  }];
  const dataForm = isEdit ? 'form' : 'text';
  // 將配置遍歷傳入 renderDataForm
  // 當然你也可以封裝成組建,直接向組建傳入 form、formConf,減少遍歷的重復(fù)書寫和整潔
  return formConf.map(item => renderDataForm(form, item, dataForm));
最終呈現(xiàn)如下:

編輯



觸發(fā)校驗



詳情



總結(jié)
雖然,在目前的前端領(lǐng)域,關(guān)于頁面配置、可視化等更加復(fù)雜的能力,已有更豐富和更全面的實現(xiàn)。比如我們前端團隊的無相應(yīng)用早已實現(xiàn)整個表單頁的配置化能力。而本文展示的表單塊的代碼配置化能力接入較為輕量、內(nèi)容上更容易理解。

作者:二剛


歡迎關(guān)注微信公眾號 :前端印象