基于react的表單生成器FormRender

本文是對阿里FormRender的分析。

FormRender 1.0 是下一代的 React.js 表單解決方案。項目從內(nèi)核級別進行了重寫徘跪,為了能切實承接日益復雜的表單場景需求司光。我們的目標是以強大的擴展能力對表單場景 100%的覆蓋支持茅诱,同時保持開發(fā)者能快速上手邑闺,并以表單編輯器季俩、插件栅组、自定義組件等一系列周邊產(chǎn)品帶來極致的開發(fā)體驗雀瓢。

FormRender配套有在線拖拉拽的工具,見fr-generator玉掸。

FormRender和fr-generator兩套工具配合起來刃麸,基本滿足了項目的初始需求,因需要擴展排截,或許還會對源碼進行改造嫌蚤,在此先深入研究了下FormRender@1.5.8的源碼,后面再研究fr-generator断傲。

1 使用舉例

1.1 schema

{
  "type": "object",
  "properties": {
    "input_xnNHW9": {
      "title": "輸入框",
      "type": "string",
      "props": {}
    },
    "textarea_Ski8kS": {
      "title": "編輯框",
      "type": "string",
      "format": "textarea",
      "props": {}
    }
  },
 "column": 1, // 整體控制一行的列數(shù)脱吱,默認為1
  "labelWidth": 120, // 整體控制標簽寬度
  "displayType": "row" // 整體控制表單元素與 label 同行 or 分兩行展示, inline 則整個展示自然順排,有'column'认罩、'row'和'inline'三個選項
}

1.2 渲染

效果圖

2 整體架構(gòu)

整體架構(gòu)圖

3 核心

Core

3.1 Core

<Core />組件經(jīng)過簡單預處理后將schema和表單布局等信息傳給<MCore/>箱蝠,而MCore = React.memo(CoreRender, areEqual),會根據(jù)表單值、錯誤提示和schema等信息是否有變化來決定是否重新渲染<CoreRender />(在form-render@1.8.5中去掉了MCore這一層):

const areEqual = (prev, current) => {
  if (prev.allTouched !== current.allTouched) {
    return false;
  }
  if (prev.displayType !== current.displayType) {
    return false;
  }
  if (prev.column !== current.column) {
    return false;
  }
  if (prev.labelWidth !== current.labelWidth) {
    return false;
  }
  if (
    JSON.stringify(prev._value) === JSON.stringify(current._value) &&
    JSON.stringify(prev.schema) === JSON.stringify(current.schema) &&
    JSON.stringify(prev.errorFields) === JSON.stringify(current.errorFields)
  ) {
    return true;
  }
  return false;
};
const MCore = React.memo(CoreRender, areEqual);

3.2 CoreRender

<div
      style={columnStyle}
      className={`${containerClass} ${debugCss ? 'debug' : ''}`}
    >
      <RenderField {...fieldProps}>{_children}</RenderField>
</div>

3.2.1 _children:根據(jù)子元素的類型是object宦搬、數(shù)組或checkbox來決定調(diào)用的組件

// 計算 children
  let _children = null;
  if (hasChildren) {
    if (isObj) {
      _children = objChildren; // 即RenderObject組件
    } else if (isList) {
      _children = listChildren; // 即RenderList組件
    }
  } else if (isCheckBox) {
    _children = schema.title;
  }

3.2.2 CoreRender會調(diào)用RenderField組件渲染_children牙瓢,RenderField的核心邏輯如下圖:

RenderField

ExtendedWidget中有一個邏輯是通過Suspense包裹了組件,這大概是因為有一部分組件通過React.lazy做了處理间校,需要配套使用Suspense矾克。
3.2.3 RenderList
當組件類型為list時,會根據(jù)具體情況分別渲染成不同組件:

switch (renderWidget) {
    case 'list0':
    case 'cardList':
      return <CardList {...displayProps} />;
    case 'list1':
    case 'simpleList':
      return <SimpleList {...displayProps} />;
    case 'list2':
    case 'tableList':
      return <TableList {...displayProps} />;
    case 'list3':
    case 'drawerList':
      return <DrawerList {...displayProps} />;
    case 'list4':
    case 'virtualList':
      return <VirtualList {...displayProps} />;
    case 'tabList':
      return <TabList {...displayProps} />;
    default:
      return <CardList {...displayProps} />;
  }

3.2.4 RenderObject

const RenderObject = ({
  children = [],
  dataIndex = [],
  displayType,
  hideTitle,
}) => {
  return (
    <>
      {children.map((child, i) => {
        const FRProps = {
          displayType,
          id: child,
          dataIndex,
          hideTitle,
        };
        return <Core key={i.toString()} {...FRProps} />;
      })}
    </>
  );
};

RenderObject內(nèi)部會遞歸調(diào)用Core組件憔足,一層層找到子組件配置進行渲染胁附。
schema有個配置類型是objecttypeobject滓彰,title為空控妻,會被渲染成div,例如根元素揭绑;如果typeobject弓候,但title不為空會被渲染成Collpase組件。
object類型往往配置有properties他匪,用來定義子組件們菇存。

最后編輯于
?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市诚纸,隨后出現(xiàn)的幾起案子撰筷,更是在濱河造成了極大的恐慌,老刑警劉巖畦徘,帶你破解...
    沈念sama閱讀 206,839評論 6 482
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件毕籽,死亡現(xiàn)場離奇詭異,居然都是意外死亡井辆,警方通過查閱死者的電腦和手機关筒,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,543評論 2 382
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來杯缺,“玉大人蒸播,你說我怎么就攤上這事∑妓粒” “怎么了袍榆?”我有些...
    開封第一講書人閱讀 153,116評論 0 344
  • 文/不壞的土叔 我叫張陵,是天一觀的道長塘揣。 經(jīng)常有香客問我包雀,道長,這世上最難降的妖魔是什么亲铡? 我笑而不...
    開封第一講書人閱讀 55,371評論 1 279
  • 正文 為了忘掉前任才写,我火速辦了婚禮葡兑,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘赞草。我一直安慰自己讹堤,他們只是感情好,可當我...
    茶點故事閱讀 64,384評論 5 374
  • 文/花漫 我一把揭開白布厨疙。 她就那樣靜靜地躺著洲守,像睡著了一般。 火紅的嫁衣襯著肌膚如雪沾凄。 梳的紋絲不亂的頭發(fā)上岖沛,一...
    開封第一講書人閱讀 49,111評論 1 285
  • 那天,我揣著相機與錄音搭独,去河邊找鬼。 笑死廊镜,一個胖子當著我的面吹牛牙肝,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播嗤朴,決...
    沈念sama閱讀 38,416評論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼配椭,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了雹姊?” 一聲冷哼從身側(cè)響起股缸,我...
    開封第一講書人閱讀 37,053評論 0 259
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎吱雏,沒想到半個月后敦姻,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,558評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡歧杏,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,007評論 2 325
  • 正文 我和宋清朗相戀三年镰惦,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片犬绒。...
    茶點故事閱讀 38,117評論 1 334
  • 序言:一個原本活蹦亂跳的男人離奇死亡旺入,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出凯力,到底是詐尸還是另有隱情茵瘾,我是刑警寧澤,帶...
    沈念sama閱讀 33,756評論 4 324
  • 正文 年R本政府宣布咐鹤,位于F島的核電站拗秘,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏慷暂。R本人自食惡果不足惜聘殖,卻給世界環(huán)境...
    茶點故事閱讀 39,324評論 3 307
  • 文/蒙蒙 一晨雳、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧奸腺,春花似錦餐禁、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,315評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至讹蘑,卻和暖如春末盔,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背座慰。 一陣腳步聲響...
    開封第一講書人閱讀 31,539評論 1 262
  • 我被黑心中介騙來泰國打工陨舱, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人版仔。 一個月前我還...
    沈念sama閱讀 45,578評論 2 355
  • 正文 我出身青樓游盲,卻偏偏與公主長得像,于是被迫代替她去往敵國和親蛮粮。 傳聞我的和親對象是個殘疾皇子益缎,可洞房花燭夜當晚...
    茶點故事閱讀 42,877評論 2 345

推薦閱讀更多精彩內(nèi)容