XAF Excel Importer

来源:https://www.cnblogs.com/haoxj/archive/2023/05/21/17419045.html
-Advertisement-
Play Games

#### 開源項目地址：https://gitee.com/easyxaf/excel-importer ### 前言 在XAF中有Excel導出，但沒有Excel導入，一開始不理解，難道Excel導入很難實現嗎，當我自己去實現Excel導入功能時，才發現難的不是技術，而是要有足夠的靈活性，在不同的 ...


開源項目地址：https://gitee.com/easyxaf/excel-importer

前言

在XAF中有Excel導出，但沒有Excel導入，一開始不理解，難道Excel導入很難實現嗎，當我自己去實現Excel導入功能時，才發現難的不是技術，而是要有足夠的靈活性，在不同的項目中或不同的業務場景中，都會有不同的需求，可能需要很多客制化，那能不能實現通用的Excel導入功能呢，我感覺滿足所有需求是不可能的，但滿足大多數需求還是有可能的。

思路

Excel導入本質是數據的映射，就是將Excel的行映射到XAF的BO對象中，這中間要涉及到數據類型的轉換，如數值、日期、布爾、枚舉、引用等類型，同時還要有數據的校驗，由於Excel輸入的靈活性及隨意性，可以提高輸入的方便性，但輸入的準確性會大打折扣，所以數據的校驗很重要。
結合XAF的特點，再加上Excel的靈活性，本Excel導入模塊，優先考慮了採用XAF的Model進行Excel導入模板的創建，由於Model可以在設計時及運行時創建，這樣可以解決Excel導入模板的靈活性，再通過XAF的條件表達式（Criteria）來實現數據的驗證及數據的轉換，基本可以解決大部分Excel導入的需求。

使用

首先看一下項目結構：

項目中帶有Sample的是示例項目，主要項目為三個，EasyXaf.ExcelImporters為主項目，EasyXaf.Blazor.ExcelImporters為Blazor適配項目，EasyXaf.Win.ExcelImporters為WinForm適配項目，根據項目類型選擇不同的項目。

本模塊支持XPO及EFCore，由於Blazor項目需要一個存儲臨時文件的實體，而XPO與EFCore的實體類是不一樣的，模塊中並沒包含這個實體（ExcelImporterTempFile），而是將其放到了示例模塊項目中，如下圖

在項目引用模塊時，需要將文件ExcelImporterTempFile.cs拷貝到自己的項目中，對於EFCore項目，還要將ExcelImporterTempFile類，添加到DbContext中，如下圖

完成以上操作後，就可以正常使用了。

示例

下麵通過一個簡單的示例來講解Excel導入模塊的功能

簡易Excel模板製作

導出的Excel模板

編輯後的Excel模板

導入Excel數據

上面是簡單的演示，Excel導入的過程需要4個步驟

  • 模板製作
  • 導出模板
  • 編輯數據
  • 導入Excel

模板的有效性驗證

模板的製作是整個Excel導入模塊的核心功能，為了提高用戶在Excel輸入的體驗，同時為了避免輸入錯誤數據，在模板中加入了有效性驗證，如必填驗證，數值及日期的範圍驗證，布爾值及枚舉的下拉選擇，同時還支持引用類型的下拉選擇等

Excel錄入數據

設置

瞭解上面的簡單介紹後，下麵講解一些具體的設置

Excel模板中的下拉選擇

在User中有一個IsActive屬性，它的類型為布爾型，在本模塊中布爾型預設會使用下拉選擇，如果IsActive屬性定義了CaptionForFalse及CaptionForTrue，則採用定義的文本，否則會採用'否'與'是'，但同時我們也可以設置PredefinedValues屬性，如非活動與活動

PredefinedValues不僅可以用在布爾型中，也可以用在其它所有類型中（在數值及日期中也可以使用），同時它的優先順序最高，定義了PredefinedValues後，則會忽略其自身的下拉選擇，如果用在枚舉中，要保證與枚舉順序保持一致

Excel模板中的效果

Excel模板的標頭格式

預設情況下，在Excel模板中必填列的標頭文本會加粗，如感覺不明顯或想著重強調，可以修改相應的樣式，NumberFormat對應著單元格的數值格式，可以通過它設置格式中數值或日期的顯示格式。

Excel模板中的效果

Excel模板的標頭文本

如果我們沒有設置列的Caption屬性，它將採用BO中定義的Caption，如果BO的Caption也為空，則採用BO類型的Name屬性。同時可以用它來適配外來的Excel工作表，這樣就可以不用修改Excel工作表原有標頭文本，通過與其它參數配合，可以實現外來Excel工作表直接導入。

Excel模板中的效果

Excel模板中的列隱藏

在Excel模板中我們一般不需要對列進行隱藏，但有時我們需要通過導入來更新時，有時需要Oid等欄位，如果我們不想顯示出來，可以對其進行隱藏，只是進行了隱藏，用戶可以輕鬆的顯示出來，無法通過它隱藏數據

Excel模板中的效果

Excel模板中引用類型的下拉選擇

本模塊中引用類型預設不下拉選擇，這主要基於安全考慮，由於引用類型下拉選擇數據源中的數據並不是面向所有用戶的，所以不能把不相關的都顯示出來，這裡需要單獨的定義，可以通過PredefinedValues或DataSoruceCriteria，而DataSoruceCriteria可以通過表達式來限制數據源的顯示。

Excel模板中的效果

忽略驗證錯誤

一般驗證錯誤是不需要忽略的，但有時我們提供了下拉選擇，也允許用戶輸入下拉列表之外的內容時，就需要忽略驗證錯誤，這樣Excel不會阻止用戶的輸入

必須包含的Excel工作表列

有時我們要保證數據的完整性，要求用戶輸入比較完整的信息，在Model中定義的列，如果是必填的，那麼在導入時首先會檢查Excel工作表對應的列是否存在，如果不存在則無法導入，而對於不是必填的列，由於Excel的靈活性，用戶可以很輕鬆的刪除，我們可以將MustIncludeColumn設為True，這樣缺少當前列時將無法成功導入。

導入時的預設值表達式

預設值一般用在當用戶沒有輸入值時採用的值，格式為Criteria表達式。同時預設值還有一種使用場景，與VisibleInTemplate結合使用，當VisibleInTemplate為False，當前列不會顯示在Excel模板中，可以通過設置預設值，用於它的初始值，例如：當我們希望用戶導入的數據只在他自己所在的部門，但我們又不想用戶自己選擇部門，就可以通過這種方式。

列不顯示在模板中

這裡的不顯示就是不在Excel模板中創建列，Excel模板不會包含它，與ColumnVisible是不一樣的，ColumnVisible會將列包含在Excel模板中，而VisibleInTemplate一般主要用於不想要用戶自己輸入，可以結合DefaultValue一起使用

不更新模板中的列

模板中的列預設都是更新的，但有時我們是不需要更新的，比如在盤點時，我們只更新數量，但其它的列則是展示列沒有必要更新，再比如，當用戶表中部分用戶手機號錯誤或不全時，需要比對確認，那麼在導入時，我們希望只更新手機號

列的值表達式

一般主要用在引用類型的查找，通過設置Criteria來查找引用類型，同時也可以通過它來實現數據的轉換，如下麵在導入時在用戶名的前面加上USER。ValueCriteria擴展性很強，可以使用XAF中的表達式函數，也可以使用自定義表達式函數

Excel模板中的效果

導入後的效果

導出視圖數據

導出Excel模板時包含視圖數據，這裡的視圖數據是視圖查詢出來的可顯現數據，主要用在數據更新，可以對導出的數據進行修改，然後再次導入

主鍵的導入

主鍵主要用於更新，主鍵不一定是BO的真實主鍵，也可以是其它的唯一欄位，如果不是BO的主鍵，需要設置KeyCriteria

導入數據方式

導入數據方式是導入數據時創建BO對象的方式，有4種導入方式

  • 同步（Synchronize），它不僅創建不存在的數據，同時還會更新已存在的數據（預設行為）
  • 僅創建（OnlyCreation），它只創建不存在的數據，已存在的數據不會更新
  • 僅更新（OnlyUpdate），不存在的數據不會創建，更新已存在的數據
  • 全創建（AllCreation），不管是否存在都會創建

驗證失敗展示

由於Excel的靈活性，無法避免錯誤的產生，如果導入時對數據驗證不通過時，則將其顯示在相應的單元格中，如果驗證錯誤沒有對應的單元格，則將其錯誤信息放在對應行的第一個單元格中。錯誤單元的背景可以通過ErrorBackgroundColor來設置，為空時將採用預設背景顏色。

自定義數據驗證

數據驗證是導入數據的保障，本模塊中會依次採用下麵的方式進行數據驗證

  • 數據類型的驗證
  • 模板中定義的最大值，最小值
  • BO中定義的規則
  • 模板中自定義的規則

最後

Excel導入模塊現已實現了基礎功能，今後還會根據業務的需求擴充新功能

https://www.cnblogs.com/haoxj/p/17419045.html


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

-Advertisement-
Play Games
更多相關文章
  • 【重學C++】02 脫離指針陷阱：深入淺出 C++ 智能指針
    ## 文章首發 [【重學C++】02 脫離指針陷阱：深入淺出 C++ 智能指針](https://mp.weixin.qq.com/s/McD-kfsiQ7hW1UnsAriC1g) ## 前言 大家好，今天是【重學C++】系列的第二講，我們來聊聊C++的智能指針。 ## 為什麼需要智能指針 在上一 ...
  • Java的CAS操作
    CAS 是樂觀鎖設計思想的實現。CAS 的思想是：在“讀取 - 修改 - 寫回”操作序列中，先讀取並修改數據，寫回數據前先判斷讀取數據後的這段時間內數據是否發生變化（共用變數的當前值是否是我們的期望值）。通過 CAS 我們可以以無鎖的方式，保證對共用數據進行 “讀取 - 修改 - 寫回” 操作序列的... ...
  • 協程併發下數據彙總：除了互斥鎖，還有其他方式嗎?
    深入探討Python中的併發編程，特別關註多線程和多進程的應用。我們將先從基本概念開始，然後通過詳細舉例探討每一種機制，最後分享一些實戰經驗以及一種優雅的編程技巧。 ...
  • 【爬蟲數據集】滇西小哥YouTube頻道TOP10熱門視頻的熱評數據，共2W條！
    [toc] # 一、背景介紹 滇西小哥是一位來自中國雲南省的視頻博主，他在YouTube上擁有超過1000萬的訂閱者和上億的觀看量。他的視頻內容主要涵蓋中國文化、美食、旅行、音樂和藝術等方面。滇西小哥通過分享自己的文化體驗和獨特的觀點，成功地將中國文化傳遞到了國際社會並獲得了廣泛的關註。通過他的視頻 ...
  • 簡要介紹django框架
    Django是一個高級的Python Web框架，它鼓勵快速開發和乾凈、實用的設計。 Django遵循MVC（模型-視圖-控制器）設計模式，使得開發者能夠更輕鬆地組織代碼和實現功能。以下是Django框架的一些主要組件： 1.**模型（Model）** ：模型是數據的抽象表示，用於定義數據結構。在D ...
  • 基於Django的簡易博客系統的搭建
    ## 1. 安裝Django 在命令行中輸入以下命令安裝Django ```shell pip install django ``` ## 2. 創建Django項目 在命令行中輸入以下命令創建一個名為myblog的Django項目 ```shell django-admin startprojec ...
  • C#中通過遞歸獲取所有的子分類
    本章將和大家分享C#中如何通過遞歸獲取所有的子分類。廢話不多說，我們直接來看一下Demo，如下所示： 遞歸寫法如下： using System; using System.Collections.Generic; using System.Linq; namespace RecursionDemo ...
  • 在Winform中一分鐘入門使用好看性能還好的Blazor Hybrid
    # 在Winform中一分鐘入門使用好看性能還好的Blazor Hybrid ## 安裝模板 ```shell dotnet new install Masa.Template::1.0.0-rc.2 ``` ## 創建 Winform的Blazor Hybrid項目 ```shell dotnet ...
一周排行
    -Advertisement-
    Play Games
  • （開源）都進來！簡單易懂、功能強大的許可權+可視化流程管理系統
    1、預覽地址：http://139.155.137.144:9012 2、qq群:801913255 一、前言 隨著網路的發展，企業對於信息系統數據的保密工作愈發重視，不同身份、角色對於數據的訪問許可權都應該大相徑庭。 列如 1、不同登錄人員對一個數據列表的可見度是不一樣的，如數據列、數據行、數據按鈕 ...
  • 設計模式-C#實現簡單工廠模式
    前言 上一篇文章寫瞭如何使用RabbitMQ做個簡單的發送郵件項目，然後評論也是比較多，也是準備去學習一下如何確保RabbitMQ的消息可靠性，但是由於時間原因，先來說說設計模式中的簡單工廠模式吧！ 在瞭解簡單工廠模式之前，我們要知道C#是一款面向對象的高級程式語言。它有3大特性，封裝、繼承、多態。 ...
  • Nodify學習 一：介紹與使用
    Nodify學習 一：介紹與使用 - 可樂_加冰 - 博客園 (cnblogs.com) Nodify學習 二：添加節點 - 可樂_加冰 - 博客園 (cnblogs.com) 介紹 Nodify是一個WPF基於節點的編輯器控制項，其中包含一系列節點、連接和連接器組件，旨在簡化構建基於節點的工具的過程 ...
  • 使用C#/.NET解析Wiki百科數據實現獲取歷史上的今天
    創建一個webapi項目做測試使用。 創建新控制器，搭建一個基礎框架，包括獲取當天日期、wiki的請求地址等 創建一個Http請求幫助類以及方法，用於獲取指定URL的信息 使用http請求訪問指定url，先運行一下，看看返回的內容。內容如圖右邊所示，實際上是一個Json數據。我們主要解析 大事記 部 ...
  • .NET科普：.NET簡史、.NET Standard以及C#和.NET Framework之間的關係
    最近在不少自媒體上看到有關.NET與C#的資訊與評價，感覺大家對.NET與C#還是不太瞭解，尤其是對2016年6月發佈的跨平臺.NET Core 1.0，更是知之甚少。在考慮一番之後，還是決定寫點東西總結一下，也回顧一下.NET的發展歷史。 首先，你沒看錯，.NET是跨平臺的，可以在Windows、 ...
  • Nodify學習 二：添加節點
    Nodify學習 一：介紹與使用 - 可樂_加冰 - 博客園 (cnblogs.com) Nodify學習 二：添加節點 - 可樂_加冰 - 博客園 (cnblogs.com) 添加節點（nodes） 通過上一篇我們已經創建好了編輯器實例現在我們為編輯器添加一個節點 添加model和viewmode ...
  • 論如何直接用EF Core實現創建更新時間、用戶審計，自動化樂觀併發、軟刪除和樹形查詢（上）
    前言 資料庫併發，數據審計和軟刪除一直是數據持久化方面的經典問題。早些時候，這些工作需要手寫複雜的SQL或者通過存儲過程和觸發器實現。手寫複雜SQL對軟體可維護性構成了相當大的挑戰，隨著SQL字數的變多，用到的嵌套和複雜語法增加，可讀性和可維護性的難度是幾何級暴漲。因此如何在實現功能的同時控制這些S ...
  • C# 使用模式匹配的好處,因為好用所以推薦~
    類型檢查和轉換：當你需要檢查對象是否為特定類型，並且希望在同一時間內將其轉換為那個類型時，模式匹配提供了一種更簡潔的方式來完成這一任務，避免了使用傳統的as和is操作符後還需要進行額外的null檢查。 複雜條件邏輯：在處理複雜的條件邏輯時，特別是涉及到多個條件和類型的情況下，使用模式匹配可以使代碼更 ...
  • 推薦一種批量判斷文件是否存在的快速辦法
    在日常開發中，我們經常需要和文件打交道，特別是桌面開發，有時候就會需要載入大批量的文件，而且可能還會存在部分文件缺失的情況，那麼如何才能快速的判斷文件是否存在呢？如果處理不當的，且文件數量比較多的時候，可能會造成卡頓等情況，進而影響程式的使用體驗。今天就以一個簡單的小例子，簡述兩種不同的判斷文件是否... ...
  • 論如何直接用EF Core實現創建更新時間、用戶審計，自動化樂觀併發、軟刪除和樹形查詢（中）
    前言 資料庫併發，數據審計和軟刪除一直是數據持久化方面的經典問題。早些時候，這些工作需要手寫複雜的SQL或者通過存儲過程和觸發器實現。手寫複雜SQL對軟體可維護性構成了相當大的挑戰，隨著SQL字數的變多，用到的嵌套和複雜語法增加，可讀性和可維護性的難度是幾何級暴漲。因此如何在實現功能的同時控制這些S ...
所有分類