基於antd封裝一個高可用form組件 減少cv代碼導致的bug

来源:https://www.cnblogs.com/amigod/archive/2019/12/10/antd-form-component-rebuild.html

引言 在開發中台過程中 我們的原型中有很多表單,antd有表單組件,但是粒度比較細,就單純組件而言,無可厚非,但是在開發過程中,可能會造成代碼不夠聚合,有些表單公共邏輯無法提取,copy paste比較多,所以可以加以封裝,搞一個相容性和擴展性都契合項目本身的組件。 主要思路 我簡單查閱了一番資料, ...


引言

在開發中台過程中 我們的原型中有很多表單,antd有表單組件,但是粒度比較細,就單純組件而言,無可厚非,但是在開發過程中,可能會造成代碼不夠聚合,有些表單公共邏輯無法提取,copy paste比較多,所以可以加以封裝,搞一個相容性和擴展性都契合項目本身的組件。

主要思路

我簡單查閱了一番資料,參考了一下別人的封裝方式,決定以ColFormItem作為基本單元,進行表單的搭建,主要原因

  • 可以將FormItem的信息和Col的信息以對象方式傳入,這樣我們可以更加專註於組件的包含的信息 減少CV代碼可能導致的bug
  • Col可以進行佈局的調整,可以調整表單單元位置和所占寬度
  • 表單的組件形式是不定的,可能是input也有可能是select,所以可以進行外部傳入,通用屬性可以內部修改
  • 復用性高,可以用它來實現一個純提交表單 和列表組件結合成可搜索表單 或者其他任何項目里需要自定義的一個表單

實現細節

抽象的FormItemInfo

export interface FormItemInfo {
  name: string, //label
  id: string, // 屬性
  colLayOut?: object,// 列佈局
  formItemLayout?: object,// 表單項佈局
  Comp?: any, // 傳入的組件 不傳預設input
  ruleArr?: RuleObj[],// 驗證規則
  initialValue?: string, // 初始值
  required?: boolean, // 是否必填
  CompExtraProps?: object // 傳入組件額外屬性
  isDetail?: boolean //是否需要被getFieldDecorator托管
}

baseForm組件

 * @param name 表單項label
 * @param id 屬性欄位名
 * @param colLayOut 列佈局
 * @param formItemLayout 表單項佈局
 * @param Comp 傳入的組件 不傳預設input
 * @param ruleArr 驗證規則 長度只需傳入{max:xxx}驗證信息是統一的
 * @param initialValue 初始值 編輯時推薦使用antd的mapPropsToFields 不要手動設置回顯值
 * @param required 是否必填 預設否 因為要統一寫驗證提示
 * @param CompExtraProps 組件額外屬性
  const mapToFormItem = (val: FormItemInfo) => {
 ......
 // 是否傳入組件
    const hasCompType = Comp && Comp.type
    // 根據組件類型 給出提示文字
    const msg = getMsgByCompType(hasCompType && hasCompType.name, name)
    // 判斷是不是select組件 是的話 調整寬度樣式
    const mixStyle = fixStyleByCompType(hasCompType && hasCompType.name)
    // 生成驗證規則
    const rules = getFormRules(ruleArr || [], required || false, name)

  return (
      <Col {...(colLayOut || defaultColSpan)} key={id}>
        {!isDetail ?
          <FormItem label={name} key={id} {...(formItemLayout || {})}>
            {/*用cloneElement方法給傳入的組件加新屬性*/}
            {
              getFieldDecorator(id, {
                initialValue: initialValue || '',
                rules,
              })(Comp ? React.cloneElement(Comp, { placeholder: msg, ...mixStyle, ...CompExtraProps }) : <Input type="text" placeholder={msg}/>)
            }
          </FormItem> : <FormItem label={name} key={id} {...(formItemLayout || {})}> {Comp}</FormItem>}
      </Col>
    )
}

統一方法

  • 根據組件類型 給出提示文字
  /**根據組件類型 給出提示文字
   * @param type 組件類型 根據傳入組件的函數名判斷 在map里維護
   * @param name label名稱
   * @returns 提示文字
   * */
  const getMsgByCompType = (name: string, type?: string): string => {
    if (!type) {
      return `請輸入${name}`
    }
    const map: { [props: string]: string } = {
      Select: '請選擇',
      Input: '請輸入',
      default: '請輸入',
    }
    return `${map[type] || map.default}${name}`
  }

  • 生成驗證規則
  // 生成驗證規則
 * @param ruleArr 驗證規則 長度只需傳入{max:xxx}驗證信息是統一的
 * @param name 表單項label
 * @param required 是否必填 預設否 因為要統一寫驗證提示
  const getFormRules = (val: RuleObj[], required: boolean, name: string) => {
    // 根據max生成最長輸入提示
    const ruleArr: object[] = []
    val.forEach(item => {
      if ('max' in item) {
        ruleArr.push({ ...item, message: `輸入信息不能超過${item.max}字` })
      } else {
        ruleArr.push(item)
      }
    })
    // 根據name生成報錯提示
    return [{ required: required, message: `${name}不能為空` }, ...ruleArr]
  • 根據組件類型 給出統一樣式修改
  /**根據組件類型 給出統一樣式修改
   * @param type 組件類型 根據傳入組件的函數名判斷 在map里維護
   * @returns 樣式對象
   * */
  const fixStyleByCompType = (type?: string): object => {
    if (!type) {
      return {}
    }
    const map: { [props: string]: object } = {
      Select: { style: { width: '100%' } },
      default: {},
    }
    return map[type] || map.default
  }

註意:當出現表單顯示一個詳情文字或者一個按鈕 此時需要用isDetail幹掉getFieldDecorator托管

實現提交表單SubmitForm

 * @param form -`antd`的form
 * @param title - 主標題
 * @param subTitle - 分組標題
 * @param FormItemInfos - 二維數組 順序和數量和分組標題對應 存放表單項信息
 * @param isLoading - `dva-loading` 執行effects過程中的loading
 * @param onSubmit - 傳入的submit方法
 * @param buttonArea - 可選 不傳預設數提交和取消 傳入覆蓋
 * @param children - 在表單下麵 按鈕區域上面的傳入內容
 * @param formLayOutType - 佈局方式 詳情見`getLayOutByType`方法
 * @returns ReactNode
......
 <Form onSubmit={onSubmit}>

        <SubmitLayOut subTitle={subTitle} title={title} renderFormArea={renderFormArea}>
          {children}
          {buttonArea?buttonArea: <Row type="flex" gutter={24} justify="center">
            <Col>
              <Button type="primary" htmlType="submit" loading={isLoading}>提交</Button>
            </Col>
            <Col>
              <Button type="default" onClick={() => router.go(-1)}>取消</Button>
            </Col>
          </Row>}
        </SubmitLayOut>

    </Form>

BaseForm的調用在renderFormArea方法里

// 水平和垂直佈局
export enum FormLayOutType {
  normal = 'normal',
  vertical = 'vertical'
}

const renderFormArea = (idx: number) => {
    // 在這邊加上normal表單的layout
    const FormItemInfo = FormItemInfos[idx]
  // 根據傳入參數 返回佈局類型
    const _FormItemInfo = getLayOutByType(formLayOutType||FormLayOutType.normal, FormItemInfo)
    return <BaseForm formItems={_FormItemInfo} form={form}/>
  }

FormItemInfos這裡是二維數組,二維分別承載分組信息和表單項信息 而且在這裡用getLayOutByType封裝常用的水平 垂直佈局方式

這裡結合了我們業務里的表單佈局 大標題 和小標題對錶單區域進行分組,我將佈局單獨搞了個SubmitLayOut組件 將渲染邏輯和樣式組件在其中實現 這樣也方便更換成其他LayOut

// SubmitLayOut
 * @param title - 主標題
 * @param subTitle - 分組標題
 * @param renderFormArea - 根據分組的順序 渲染表單區域
 * @param children - 傳入內容
......
  <Card title={title} bordered={false} className={styles["special-card"]}>
      <List itemLayout="vertical" className="special-list">
        {subTitle.map((item,idx) => {
          return (
            <>
              <Meta title={item}/>
              <List.Item>
                {renderFormArea(idx)}
              </List.Item>
            </>
          )
        })}
      </List>
      {children}
    </Card>

結語

後續還實現了serachForm等業務相關性高的組件,所以個人覺得封裝的思路主要是

  • 底層組件越純粹越好
  • 中層可以實現一些適用性比較高的具體業務組件和通用方法
  • 高層就具體要頁面的細節的方方面面了

您的分享是我們最大的動力!

更多相關文章
  • Frida是什麼 我覺得官網已經說得很清楚了。簡單的說就是一款動態代碼檢測工具,可用於各種主流操作系統,這裡主要討論的是動態檢測Android系統裡面代碼運行情況。 Android版的Frida環境的搭建主要分為兩個部分,一部分是運行在Android機器上的代理工具 ,另一部分是Windows系統用 ...
  • 本來之前覺得Android項目優化系列的文章基本整理完畢了,但是近期看了一下《阿裡Android開發手冊》有了很多收穫,想再整理一篇,下麵就開始吧。 先在這裡列一下之前整理的文章及鏈接: Android 項目優化(一):項目代碼規範優化 Android 項目優化(二):啟動頁面優化 Android ...
  • 在Vue開發中,模板內的表達式非常便利,但是設計它們的初衷是用於簡單運算的。在模板中放入太多的邏輯會讓模板過重且難以維護。當你想要在模板中多次引用相同表達式時,就會更加難以處理。所以,對於任何複雜邏輯,你都應當使用計算屬性。本文主要講解Vue中的計算屬性和偵聽器,僅供學習分享使用,如有不足之前,還請... ...
  • 一、今天完成了網易郵箱註冊界面的全部編寫,編寫一個小小的網頁就需要這麼多時間來進行設計、測量、排版、編寫、測試,才能進行使用,同時編寫這個網頁複習了幾乎前面的所有內容,最後來一個彙總就可以了。 <!DOCTYPE html> <html lang="en"> <head> <meta charset ...
  • 如果是li浮動導致ul沒有寬度,給ul手動設置一個寬度或者給div一個overflow:hidden; ...
  • ``` Practice 請註冊 立即登錄> 請登錄 立即註冊> 七天內自動登錄 忘記密碼? ``` ![](https://img2018.cnblogs.com/blog/821307/201912/821307-20191210153842909-1130015050.png) ...
  • 解決z-index上層元素遮擋下層元素點擊事件問題 by:授客 QQ:1033553122 開發環境 Win 10 element-ui "2.8.2" Vue 2.9.6 需求描述 如下,有以下界面,其中右側邊時一個ElementUI Dialog模態對話框,希望在對話框上執行點擊操作時,不會點擊 ...
  • 基於HTML5 canvas 獲取文本占用的像素寬度 by:授客 QQ:1033553122 直接上代碼 // 獲取單行文本的像素寬度 getTextPixelWith(text, fontStyle) { var canvas = document.createElement("canvas"); ...
一周排行
  • 比如要拆分“呵呵呵90909086676喝喝999”,下麵當type=0返回的是中文字元串“呵呵呵,喝喝”,type=1返回的是數字字元串“90909086676,999”, private string GetStrings(string str,int type=0) { IList<strin ...
  • Swagger一個優秀的Api介面文檔生成工具。Swagger可以可以動態生成Api介面文檔,有效的降低前後端人員關於Api介面的溝通成本,促進項目高效開發。 1、使用NuGet安裝最新的包:Swashbuckle.AspNetCore。 2、編輯項目文件(NetCoreTemplate.Web.c ...
  • 2020 年 7 月 30 日, 由.NET基金會和微軟 將舉辦一個線上和為期一天的活動,包括 微軟 .NET 團隊的演講者以及社區的演講者。本次線上大會 專註.NET框架構建微服務,演講者分享構建和部署雲原生應用程式的最佳實踐、模式、提示和技巧。有關更多信息和隨時瞭解情況:https://focu... ...
  • #abp框架Excel導出——基於vue #1.技術棧 ##1.1 前端採用vue,官方提供 UI套件用的是iview ##1.2 後臺是abp——aspnetboilerplate 即abp v1,https://github.com/aspnetboilerplate/aspnetboilerp ...
  • 前言 本文的文字及圖片來源於網路,僅供學習、交流使用,不具有任何商業用途,版權歸原作者所有,如有問題請及時聯繫我們以作處理。 作者:碧茂大數據 PS:如有需要Python學習資料的小伙伴可以加下方的群去找免費管理員領取 input()輸入 Python提供了 input() 內置函數從標準輸入讀入一 ...
  • 從12年到20年,python以肉眼可見的趨勢超過了java,成為了當今It界人人皆知的編程語言。 python為什麼這麼火? 網路編程語言搜索指數 適合初學者 Python具有語法簡單、語句清晰的特點,這就讓初學者在學習階段可以把精力集中在編程對象和思維方法上。 大佬都在用 Google,YouT ...
  • 在社會上存在一種普遍的對培訓機構的學生一種歧視的現象,具體表現在,比如:當你去公司面試的時候,一旦你說了你是培訓機構出來的,那麼基本上你就涼了,那麼你瞞著不說,然後又通過了面試成功入職,但是以後一旦在公司被髮現有培訓經歷,可能會面臨被降薪,甚至被辭退,培訓機構出來的學生,在用人單位眼裡就是能力低下的 ...
  • from typing import List# 這道題看了大佬寫的代碼,經過自己的理解寫出來了。# 從最外圍的四周找有沒有為O的,如果有的話就進入深搜函數,然後深搜遍歷# 判斷上下左右的位置是否為Oclass Solution: def solve(self, board: List[List[s ...
  • import requests; import re; import os; # 1.請求網頁 header = { "user-agent":'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, li ...
  • import requests; import re; import os; import parsel; 1.請求網頁 header = { "user-agent":'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537. ...