在 React 項目中 Editable Table 的實現

来源:https://www.cnblogs.com/dtux/p/18349126
-Advertisement-
Play Games

我們是袋鼠雲數棧 UED 團隊，致力於打造優秀的一站式數據中台產品。我們始終保持工匠精神，探索前端道路，為社區積累並傳播經驗價值。 本文作者：佳嵐 可編輯表格在數棧產品中是一種比較常見的表單數據交互方式，一般都支持動態的新增、刪除、排序等基礎功能。 交互分類 可編輯表格一般為兩種交互形式： 實時保存 ...


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

本文作者：佳嵐

可編輯表格在數棧產品中是一種比較常見的表單數據交互方式，一般都支持動態的新增、刪除、排序等基礎功能。

交互分類

可編輯表格一般為兩種交互形式：

  1. 實時保存的表格，即所有單元格都可以直接進行編輯。
    image.png
  2. 可編輯行表格，即需要手動點擊編輯才能進入行編輯狀態。
    image.png

對比兩種交互形式：

  1. 第一種交互更加友好，但對應的性能開銷會非常大，不需要手動進入單元格編輯狀態。
  2. 對於第二種交互方式，更多的場景是在數據量很大，不需要頻繁修改，或者批量更新會對後端資料庫操作會有較大性能影響的場景下。它還有一個很好的好處就是在編輯狀態時，能夠對已填入數據進行回退。

數棧產品中絕大多數都採用了第一種交互方式。
要實現一個可編輯表格，Table 組件肯定是不可或缺，是否要引入 Form 做數據收集，還要具體場景具體分析。
如果不引入 Form , 採用自行管理數據收集的方式, 其一般實現如下。

const EditableTable = () => {
  const [dataSource, setDataSource] = useState([]);

  const handleAdd = () => {
    const newData = {
      key: shortid(),
      name: 'New User',
    };
    setDataSource([...dataSource, newData]);
  };

  const handleDelete = (key) => {
    const newData = dataSource.filter(item => item.key !== key);
    setDataSource(newData);
  };

  const handleChange = (value, key, field) => {
    const newData = dataSource.map(item => {
      if (item.key === key) {
        return { ...item, [field]: value };
      }
      return item;
    });
    setDataSource(newData);
  };

  const handleMove = (key, direction) => {
    const index = dataSource.findIndex(item => item.key === key);
    const newData = [...dataSource];
    const [item] = newData.splice(index, 1);
    newData.splice(direction === 'up' ? index - 1 : index + 1, 0, item);
    setDataSource(newData);
  };

  const columns = [
    {
      title: 'Name',
      dataIndex: 'name',
      render: (text, record) => (
        <Input
          value={text}
          onChange={e => handleChange(e.target.value, record.key, 'name')}
        />
      ),
    },
    {
      title: 'Action',
      dataIndex: 'action',
      render: (_, record) => (
        <span>
          <Button
            onClick={() => handleMove(record.key, 'up')}
          >
            上移
          </Button>
          <Button
            onClick={() => handleMove(record.key, 'down')}
          >
           下移
          </Button>
          <Button onClick={() => handleDelete(record.key)}>
              刪除
           </Button>
        </span>
      ),
    },
  ];

  return (
    <div>
      <Button
        onClick={handleAdd}
      >
        添加
      </Button>
      <Table
        columns={columns}
        dataSource={dataSource}
        pagination={false}
      />
    </div>
  );
};

export default EditableTable;

存在的問題：

  1. 無法對每行進行單獨校驗。
  2. 組件完全受控，表單數量很多時輸入會卡頓嚴重。

優點：

  1. 非常靈活。
  2. 不用考慮 Form 的依賴渲染問題。
  3. 可進行表格前端分頁，這能一定程度上解決性能問題。

如果使用 Form ，最正確的做法是通過 Form.List 來實現。 Form 在綁定欄位時，namePath 如果是字元串數組 ["user", "name"]，則會收集為對象結構 user.name ，如果 namePath 包含整型，則收集為數組 ["users", 0, "name"] ⇒ users[0].name 。
Form.List 中會暴露出維護的 fields 元數據與增刪移動操作的 opeartion , 那麼與 table 相結合，實現起來會變得更加簡單。
其中 field 對象包含 key 與 name ，key 是單調遞增無重覆的，如果刪除了該數據，則 name 為其在數組中的下標。
我們為 FormItem 註冊的 name 雖然是 [0, "name"] ，但是處於 Form.List 中的 Form.Item 組件都會自動拼上 parentNamePrefix 首碼，也就是最終會變成 [”users”, 0, “name”] 。

<Form form={form}>
    <Form.List name="users">
        {(fields, operation) => (
            <>
                <Table
                    key="key"
                    dataSource={fields}
                    columns={[
                        {
                            title: "姓名",
                            key: "name",
                            render: (_, field) => (
                                <FormItem name={[field.name, "name"]}>
                                    <Input />
                                </FormItem>
                            ),
                        },
                        {
                            title: "操作",
                            key: "actions",
                            render: (_, field) => (
                                <Button
                                    onClick={() =>
                                        operation.remove(field.name)
                                    }
                                >
                                    刪除
                                </Button>
                            ),
                        },
                    ]}
                    pagination={{ pageSize: 3 }}
                />
                <Button onClick={() => operation.add({ name: "Jack" })}>
                    添加
                </Button>
            </>
        )}
    </Form.List>
</Form>

image.png
我們可以看到，使用 Form.List 實現，甚至可以使用分頁，我們通過 form.getFieldsValue() 查看，數據是正常的。
image.png
為何被銷毀的第一頁的表單數據能夠保存下來?
預設情況下 preserve 為 true 的欄位在銷毀時仍能保存數據，只是需要通過 getFieldsValue(true) 才能拿到，但對於 Form.List , 不需要加 true 參數也能拿到所有數據。
Form.List 本身內部也是一個 Form.Item ，不過添加了 isList 來區分，不光是 List 中的子項，其本身也會被註冊。如下圖所示，表格中有 5 條數據，由於分頁原因只有當前頁的數據表單會在 Form 中註冊收集，
額外的會將 users 也單獨作為一個欄位進行收集。
image.png
然後，在 getFieldsValue 源碼中，直接就取了 Form.List 註冊的值。
image.png
因此，使用 Form.List 完成分頁，從源碼層面分析下來是可行的，但實際沒怎麼見到有人這樣配合用過。

應用

案例 1

以運行參數為例，其實現使用了 Table 的自定義 components , 在 EditableCell 中再去定義表單如何渲染。
image.png

const RunParamsEditTable = () => {
    const [dataSource, setDataSource] = useState([])
    const components = {
        body: {
            row: EditableFormRow,
            cell: EditableCell,
        },
    };

    const initColumns = () => {
        return [
           // xxx欄位
        ];
    };

    const columns = initColumns().map((col) => {
        if (!col.editable) {
            return col;
        }
        return {
            ...col,
            onCell: (record, index) => ({
                index,
                record,
                editable: col.editable,
                dataIndex: col.dataIndex,
                title: record[col.dataIndex] || col.title,
                errorTitle: col.title,
                save,
                // 還有很多其他狀態需要傳遞
            }),
        };
    });
    return (
        <div>
            <Table components={components} dataSource={dataSource} columns={columns} />
            <span onClick={this.handleAdd}>添加運行參數</span>
        </div>
    );
};

在 EditableCell 中, 通常需要傳遞大量的 props 來和父組件進行通訊，且表格列定義與表單定義拆分成兩個組件，這樣寫個人感覺太割裂了，且對於產品中絕大部分 EditableTable 來說使用自定義 components 有點大題小用。

const EditableCell = ({ editable, dataIndex, children, save, ...restProps }) => {
    const renderCell = () => {
        switch (dataIndex) {
            case 'name':
                return (
                    <Form.Item name={dataIndex} onChange={(v) => save(v)}>
                        <Input />
                    </Form.Item>
                );
            // 所有其他欄位
        }
    };
    return <td>{editable ? renderCell() : children}</td>;
};

在代碼中，實際又自定義了 Row 來為每一行創建一個 Form ，這樣才實現的同時編輯多個行, 且 Form 只是用來做校驗的，後面都通過 save 來手動收集的。假如改為上述 Form.List 的形式，那麼這將會變得很好維護，在 onValuesChange 中將列表數據同步到上層 store 中。
個人認為 Table 的自定義 components 應在表格行或單元格要維護一些自身狀態時才應該去考慮，如行列拖拽，單元格可在編輯狀態進行切換等場景下使用。

案例 2

每個表單項都是下拉框，且下拉選項是通過級聯請求過來的。
image.png
在這裡，我們可能會這樣做，維護一個 state 用來存放不用資料庫對應的數據表列表, 並以 dbId 為鍵。

const [tableOptionsMap, setTableOptionsMap] = useState(new Map())

在 columns render 中直接消費對應的 tableOptions 進行渲染。

<FormItem dependencies={[["list", field.name, "dbId"]]}>
    {() => {
        const dbId = form.getFieldValue(["list", field.name, "dbId"]);
        const tableOptions = tableOptionsMap.get(dbId);
        return (
            <FormItem name={[field.name, "table"]}>
                <Select options={tableOptions} />
            </FormItem>
        );
    }}
</FormItem>;

這一切正常，但當我把數據加到百行數量級的時候，卡頓已經非常明顯了
iShot_2024-06-22_16.26.16.gif
由於我們是把 state 存放在父組件的，每次請求會造成 table 進行 render 一遍，如果再加入 loading 等狀態，render 次數會更多。Table 組件預設情況下沒有對 rerender 行為做優化，父組件更新，如果 columns 中的提供了自定義 render 方法， 對應的每個 Cell 都會重新 render 。
image.png
針對這種情況我們就需要進行優化，根據 shouldCellUpdate 來自定義渲染時機。
那麼每個 Cell 的渲染時機應該是：

  1. FormItem 增刪位置變動時
  2. 該 Cell 消費的對應 tableOptions 變動時

第一種情況很好判斷, Form.List 中 field.name 指代下標，只需比較即可

 shouldCellUpdate: (prev, curr) => {
    return prev.name !== curr.name;
}

第二種情況我們沒法直接知道 tableOptions 是否有變化，所以需要自行寫個 hooks usePreviousStateRef ，這裡需要非常註意的點：返回的是 ref 而不是 ref.current ，在 shouldCellUpdate 中使用會有閉包問題。

const usePreviousStateRef = <T>(state: T): React.MutableRefObject<T> => {
    const ref = React.useRef<typeof state>();

    useEffect(() => {
        ref.current = state;
    }, [state]);

    return ref;
};

const prevTableOptionsMapRef = usePreviousStateRef(tableOptionsMap);

那麼組合起來，重新渲染的條件就變成了

shouldCellUpdate: (prev, curr) => {
  // 位置變化直接渲染
  if (prev.name !== curr.name) return true;

  // 只對數據表下拉數據變動的行進行重新渲染
  const dbId = form.getFieldValue(['list', curr.name, 'dbName']),
  const prevTableInfo = prevTableOptionsMapRef.current?.get(dbId);
  const currTableInfo = tableOptionsMap?.get(dbId);

  return prevTableInfo !== currTableInfo;
},

改完後明細流暢許多
iShot_2024-06-22_17.00.38.gif
通過 shouldCellUpdate 可解決性能問題，但對應的如果 render 中依賴了外部 state, 就要自行保存 prevState 去判斷了。

總結：

Form.List + Table 的組合能滿足絕大部分需求，所以後續開發中最先應該考慮這種方式，當每行中存在各自狀態需要維護時再嘗試採用自定義 components ，永遠不要 state 與 Form 混用！
此外還需要考慮足夠的性能因素，特別是面對存在大量下拉框時。

最後

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


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

-Advertisement-
Play Games
更多相關文章
  • iOS開發-屬性的記憶體管理
    Objective-C中，類的實例變數（instance variables）和屬性（properties）是兩種不同的概念，其中屬性的記憶體管理就較為複雜。Objective-C 提供了多種屬性修飾符，用於管理對象的記憶體。這些修飾符用於控制對象的生命周期和記憶體管理行為。 以下是一些常見的屬性修飾符及 ...
  • UITableView的原理——探究及重新實現代碼
    我們非常激動地宣佈，詞雲圖大師（WordCloudMaster）現已正式上線Web端！這一全新版本為用戶帶來了更多的便捷和功能，讓創建和分享詞雲變得更加輕鬆。無論是企業、教育機構還是個人用戶，都可以通過Web端實現快速生成和定製屬於自己的詞雲圖。 https://studio.wordcloudma ...
  • JavaScript發展歷史
    JavaScript 作為一種編程語言，經歷了多次發展與演變，以下是其主要歷史里程碑： 1. 誕生與早期發展（1995-1999） 1995年: JavaScript 由 Brendan Eich 在網景公司（Netscape）發明，最初被稱為 Mocha，後來改名為 LiveScript，最終定名 ...
  • 使用 Nuxt 3 的 defineRouteRules 進行頁面級別的混合渲染
    title: 使用 Nuxt 3 的 defineRouteRules 進行頁面級別的混合渲染 date: 2024/8/12 updated: 2024/8/12 author: cmdragon excerpt: 摘要：本文介紹了Nuxt 3中的defineRouteRules功能，用於實現頁面 ...
  • HTML 引用
    title: 掌握 Nuxt 3 的頁面元數據：使用 definePageMeta 進行自定義配置 date: 2024/8/11 updated: 2024/8/11 author: cmdragon excerpt: 摘要：本文詳細介紹Nuxt 3框架中definePageMeta的使用方法，包 ...
  • 使用 defineNuxtRouteMiddleware 創建路由中間件
    title: 使用 defineNuxtRouteMiddleware 創建路由中間件 date: 2024/8/10 updated: 2024/8/10 author: cmdragon excerpt: 本篇文章介紹瞭如何使用 defineNuxtRouteMiddleware 創建和應用路由 ...
  • HTML 文本格式化
    摘要：目前 OpenTiny HUICharts 已經成功落地在華為內部100多個產品中，持續提升了用戶的可視化體驗。 本文分享自華為雲社區《OpenTiny HUICharts 正式開源發佈，一個簡單、易上手的圖表組件庫》，作者： OpenTiny。 引言 大家好！ 我們非常高興地跟大家宣佈，今天 ...
  • 使用 defineNuxtComponent`定義 Vue 組件
    title: 使用 defineNuxtComponent`定義 Vue 組件 date: 2024/8/9 updated: 2024/8/9 author: cmdragon excerpt: 摘要：本文介紹了在Nuxt 3中使用defineNuxtComponent輔助函數定義類型安全的Vue ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類