基於分步表單的實踐探索

来源:https://www.cnblogs.com/dtux/archive/2023/07/11/17543163.html
-Advertisement-
Play Games

>我們是[袋鼠雲數棧 UED 團隊](http://ued.dtstack.cn/)，致力於打造優秀的一站式數據中台產品。我們始終保持工匠精神，探索前端道路，為社區積累並傳播經驗價值。。 >本文作者：修能 ***以下內容充滿個人觀點。◡ ヽ(`Д´)ﾉ ┻━┻*** # 前言 基於分佈表單的需求，在 ...


我們是袋鼠雲數棧 UED 團隊，致力於打造優秀的一站式數據中台產品。我們始終保持工匠精神，探索前端道路，為社區積累並傳播經驗價值。。

本文作者：修能

以下內容充滿個人觀點。◡ ヽ(`Д´)ﾉ ┻━┻

前言

基於分佈表單的需求，在中後臺管理中是一個非常常見的需求，通常具有如下佈局：

file

其中，自定義需求度從高到低為，正文 > 按鈕區 > 步驟條。

雖然佈局類似，但是實現的方式卻是天差地別，這裡就探究一下究竟怎麼樣實現可以兼具代碼的可維護性和可讀性呢？

指出問題

Container

我們這裡，以「指標-數據模型」的代碼為例。

首先先來看看數據模型這裡的代碼是如何實現的？

export default () => {
  ...
  return (
    <>
      <header>
        <Steps current={current}>
          {['tab1', 'tab2', 'tab3', 'tab4', 'tab5'].map(
      	     (title, index) => (
                <Step key={index} title={title} />
             )
          )}
        </Steps>
      </header>
      <Spin>
        {stepRender(current, {
           childRef,
           modelDetail,
           globalStep: globalStep.current,
           mode,
           isModelTypeDisabled,
           setModelDetail,
           setDisabled,
           onModelNameChange: handleModelNameChange,
        })}
        <Modal>...</Modal>
      </Spin>
      <footer>
        {current === EnumModifyStep.tab1 ? (
           <Button
             onClick={() => router.push('/url')}
           >
             取消
           </Button>
        ) : null}
        ...
      </footer>
    </>
  )
}

這是數據模型編輯頁面 Steps所在的容器組件的 DOM 部分的代碼。

可以看出來，設計者的思路是比較明確的，通過 header，content，和 footer 進行分層， 增加代碼的可讀性。

在 header 中，通過聲明 title 數組的方式創建 Steps 的方式簡潔又不失可讀性。

在 content 中，有幾個問題的存在：

  1. 既然 header 和 footer 都有語義化的標簽強化可讀性，我認為這裡其實也可以添加語義化的標簽強化可讀性，譬如 main或者section，當然同時還需要考慮會不會造成過深的層級。
  2. stepRender函數的實現把一大堆 params 傳到子組件是否合適。
  3. 為何 content 區域內，會存在 Modal？對於沒有設置 getPopupContainer 的 Modal 來說，其會通過 createPortal在 body 上創建，那麼在這裡不論是寫在 content 還是 header，都不會影響它的渲染，所以我推薦把 Modal 寫到最角落裡，不影響可讀性。
  4. 在 footer 中，通過 current === 步驟 的方式去定義按鈕，我認為這種方式會使代碼顯得較為冗餘。

Tab1

我們這裡以指標相關代碼為例，以簡見深，以小見大

export default (props) => {
  ...
 const { cref, modelDetail, mode, onModelNameChange } = props;

  useImperativeHandle(cref, () => {
    return {
      validate: () => {...},
      getValue: () => {...},
    }
  });

   useEffect(() => {
     setFieldsValue({
       a: modelDetail.a,
       b: modelDetail.b,
       c: modelDetail.c,
     });
    }, [modelDetail]);

  return (
    <Form>
      <Row gutter={40}>
        <Col span={12}>
            ...
        </Col>
        <Col span={12}>
            ...
        </Col>
    </Row>
    <Row gutter={40}>
      <Col span={12}>
         ...
      </Col>
    </Row>
    </Form>
  )
}

這裡我想指出的第一個問題是，ref 的使用，由於 ref 無法在 props 中傳遞，需要通過 forwardRef 才能拿到。然而這裡通過 cref 這種比較 hack 的方式進行一個操作。我認為這是一個不推薦的做法，如果需要拿 ref 我建議是老老實實通過 forwardRef 拿。

其次是 Row 和 Col 的使用，並不是說 Col 達到 24 之後就需要再寫一個 Row，你可以繼續寫的呀，童鞋！

這裡需要提出來的一個論點是，每一個子組件里去寫 Form 的方式好（即上面的這種寫法），還是總體寫一個 Form 的方式更好？個人認為前者存在的問題如下：

  1. 由於子組件寫 Form，但是提交（或下一步）按鈕在外面，那麼必然需要用 ref 拿到子組件的實例，並調用相關方法。（上面是 validate 和 getValue 分別對應下一步和上一步調用）
  2. 沒有遵循 single source of truth（單一事實來源）
  3. 如果多層級結構，例如 RelationTableSelect 的話，每一層都有填寫內容，那麼需要大量 Form + ref，降低可維護性。

除此之外，由於基礎信息比較簡單，所以不存在 props 層層往下傳遞的問題，但是複雜組件就會存在層層往下傳遞的情況，那麼就涉及到是否需要 context 的問題了。當然，我推薦是需要 context 的。

Tab2

這裡再看一眼第二步關聯表的設計

interface ITab2Props {
  cref: IModifyRef;
  modelDetail?: Partial<IModelDetail>;
  mode: any;
  globalStep: number;
  updateModelDetail: Function;
  setDisabled?: Function;
}

const RelationTableSelect = (props: ITab2Props) => {}

首先，這裡需要支持的一個設計思路是，通常情況下，切忌直接把 dispatch 傳遞給子組件。

關聯表這裡的設計由於層級嵌套很深，子組件非常多，導致updateModelDetail不斷往下傳遞，你完全不知道哪層組件在什麼情況下會去修改這個值！！！ 這對於 SSOT 來說，是毀滅性的打擊。

再加上 modelDetail 是一個很複雜的數據，對於可維護性來說，屬於是力中暴力地打擊了。

解決問題

綜上，我們設計分佈表單的時候，需要規避以上的問題，遵循如下原則：

  1. SSOT
  2. 可維護性
  3. 可擴展性

首先實現如下組件：

<StepsForm
  current={current}
  onChange={setCurrent}
  titles={['tab1', 'tab2', 'tab3', 'tab4', 'tab5']}
/>

這一塊代碼比較簡單，無非就是投傳幾個值到對應的組件中去。

接下來考慮底部按鈕的可擴展性。

通過 submitter 屬性支持定製按鈕的交互屬性。

<StepsForm
  current={current}
  onChange={setCurrent}
  submitter={[
    {
      [StepsForm.PREV]: {
        children: '取消',
      },
    },
    null,
    {
      [PREVIEW]: {
        danger: true,
        children: '預覽',
      },
    },
  ]}
/>

接下來要解決按鈕的事件，這裡有兩種方案，一種是將事件掛載在 Container 上（即這裡的 StepsForm 組件），通過諸如 onCancel，onSubmit，onPrev等方式進行反饋。
我認為這種方式不夠好，原因有如下幾點

  1. 通常我們會把子組件提出來，不會和 Container 組件寫在一起，這就會使得我們需要在不同的組件中寫按鈕的交互邏輯和 UI 邏輯，存在隔離感
  2. 有時候我們需要把 Select.Option 相關的數據一起放到數據里給到服務端，這種方式交互需要把 Option 的數據提取到 Container 中
  3. 需要通過 ref 去子組件獲取值

而目前我考慮通過事件訂閱對按鈕事件觸發，通過 useEffect 監聽事件，但是這種方式的缺點如下：

  1. 不夠直觀，和我們通常來說的組件開發有一定相悖的思路

除了以上兩種方式以外，其實還有一種方式，即通過實現 Children 組件，將 Children 組件作為 StepsForm 的子組件，從而使得將每一步相關的 title 和 onSubmit 等方式都掛載在 Children 組件上。即 ant-design-pro 中的 StepsForm 的實現方式。我認為這種方式的優點在於直觀，不割裂。缺點在於如下：

  1. 為了獲取 title 不得不先渲染子組件，從而導致 DOM 先渲染出來，然後通過 active 判斷表單是否渲染。
  2. 導致子組件無法通過 useEffect獲取數據

其中第二點我認為是無法忍受的，這和開發組件的思路完全相悖，故摒棄這種方式
暫時考慮不清楚是第一種好還是第二種好。

這裡先考慮實現第二種方式後組件書寫的效果：

export function () {
  ...
  StepsForm.useFooterEffect(
    ({ prev }) => {
      prev(() => {});
    },
    [StepsForm.PREV],
  );

  StepsForm.useFooterEffect(() => {
    message.info('預覽')
  }, [PREVIEW]);

  StepsForm.useFooterEffect(
    ({ next }) => {
      next(() => {
        return new Promise((resolve) => {
          setTimeout(() => {
            resolve();
          }, 1000);
        });
      });
    },
    [StepsForm.NEXT],
  );

  return (
    ...
  )
}

hook 的實現方式也比較簡單，基於事件訂閱，結合每一個按鈕都賦予一個唯一值。
實現按鈕交互觸發後，通過事件分發，觸發當前渲染的組件中的監聽 hook。

總結

本文意在探索分步表單的最佳實踐，防止不同的同學在開發該類型的需求會寫出五花八門的代碼，從而導致降低可維護性。

本文提到的解決方案也不認為是最佳實踐，其中不同的方法經過分析都存在優點和缺點。在實際的開發過程中，仍然需要根據具體的需求進行調整。

但是基於分步表單的特性和使用場景，總結出適用大部分情況下的方法論是有必要的。

最後

歡迎關註【袋鼠雲數棧UED團隊】~
袋鼠雲數棧UED團隊持續為廣大開發者分享技術成果，相繼參與開源了歡迎star


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

-Advertisement-
Play Games
更多相關文章
  • 一次元數據空間記憶體溢出的排查記錄
    在應用中，我們使用的 SpringData ES的 ElasticsearchRestTemplate來做查詢，使用方式不對，導致每次ES查詢時都新實例化了一個查詢對象，會載入相關類到元數據中。最終長時間運行後元數據出現記憶體溢出； ...
  • 達夢實時主備搭建技術分享
    在部分工作場景下可能會使用到達夢資料庫的數據守護功能，本文介紹達夢數據守護服務的搭建。 此次搭建使用三台機器，一主一備一監視器。其中主備資料庫需要提前初始化。一、數據準備需要保證主備庫數據一直，這裡使用dmrman離線備份還原方式進行。停止主庫，進行rman全備。 ./dmrman CTLSTMT= ...
  • NSURL請求中含有中文的解決方法
    原文地址：https://blog.csdn.net/zhanglei5415/article/details/131434931 ## 一、問題 當對含有中文的url字元串，進行NSURL對象包裝時，是不能被識別的。 不會得到期望的NSURL對象，而是返回一個nil 值 ; ```objectiv ...
  • FFmpeg+SDL實時解碼和渲染H264視頻流
    原文地址:[Android 自定義view中根據狀態修改drawable圖片 - Stars-One的雜貨小窩](https://stars-one.site/2023/07/09/android-view-state-drawable) 本文涉及知識點: - Android里的selector圖片 ...
  • 記錄--盤點前端實現文件下載的幾種方式
    這裡給大家分享我在網上總結出來的一些知識，希望對大家有所幫助 前端涉及到的文件下載還是很多應用場景的，那麼前端文件下載有多少種方式呢？每種方式有什麼優缺點呢？下麵就來一一介紹。 1. 使用 a 標簽下載 通過a標簽的download屬性來實現文件下載，這種方式是最簡單的，也是我們比較常用的方式，先來 ...
  • vue2基礎 入門vue2
    # vue基礎 - vue項目搭建 - vue單文件組件 - mustach表達式 - vue指令 - methods方法 - filters過濾器 - computed計算屬性 - watch監聽器 - vue組件 - vue-router 路由 - vue生命周期 - vue組件通信 - slo ...
  • H5 WebGL實現水波特效
    字元串的17種方法。。。。。。 length：返回字元串的長度。 const str = "Hello, World!"; console.log(str.length); // 輸出 13 charAt(index)：返回指定索引位置的字元。 const str = "Hello, World!" ...
  • vue3中父組件與組件之間參數傳遞，使用(defineProps/defineEmits)，涉及屬性傳遞，對象傳遞，數組傳遞，以及事件傳遞
    ## Vue3 中子父組件之間的通信 ### 一、父組件傳遞參數到子組件 採用defineProps #### 傳遞屬性 父組件: ```vue 這是父組件 父組件像子組件傳遞參數 傳遞屬性值 ``` 子組件: ```vue 這是子組件 屬性值接收區 父組件傳值接收區：字元型：{{ fatherMe ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類