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++ 智能指針](https://mp.weixin.qq.com/s/McD-kfsiQ7hW1UnsAriC1g) ## 前言 大家好,今天是【重學C++】系列的第二講,我們來聊聊C++的智能指針。 ## 為什麼需要智能指針 在上一 ...
  • CAS 是樂觀鎖設計思想的實現。CAS 的思想是:在“讀取 - 修改 - 寫回”操作序列中,先讀取並修改數據,寫回數據前先判斷讀取數據後的這段時間內數據是否發生變化(共用變數的當前值是否是我們的期望值)。通過 CAS 我們可以以無鎖的方式,保證對共用數據進行 “讀取 - 修改 - 寫回” 操作序列的... ...
  • 深入探討Python中的併發編程,特別關註多線程和多進程的應用。我們將先從基本概念開始,然後通過詳細舉例探討每一種機制,最後分享一些實戰經驗以及一種優雅的編程技巧。 ...
  • [toc] # 一、背景介紹 滇西小哥是一位來自中國雲南省的視頻博主,他在YouTube上擁有超過1000萬的訂閱者和上億的觀看量。他的視頻內容主要涵蓋中國文化、美食、旅行、音樂和藝術等方面。滇西小哥通過分享自己的文化體驗和獨特的觀點,成功地將中國文化傳遞到了國際社會並獲得了廣泛的關註。通過他的視頻 ...
  • Django是一個高級的Python Web框架,它鼓勵快速開發和乾凈、實用的設計。 Django遵循MVC(模型-視圖-控制器)設計模式,使得開發者能夠更輕鬆地組織代碼和實現功能。以下是Django框架的一些主要組件: 1.**模型(Model)** :模型是數據的抽象表示,用於定義數據結構。在D ...
  • ## 1. 安裝Django 在命令行中輸入以下命令安裝Django ```shell pip install django ``` ## 2. 創建Django項目 在命令行中輸入以下命令創建一個名為myblog的Django項目 ```shell django-admin startprojec ...
  • 本章將和大家分享C#中如何通過遞歸獲取所有的子分類。廢話不多說,我們直接來看一下Demo,如下所示: 遞歸寫法如下: using System; using System.Collections.Generic; using System.Linq; namespace RecursionDemo ...
  • # 在Winform中一分鐘入門使用好看性能還好的Blazor Hybrid ## 安裝模板 ```shell dotnet new install Masa.Template::1.0.0-rc.2 ``` ## 創建 Winform的Blazor Hybrid項目 ```shell dotnet ...
一周排行
    -Advertisement-
    Play Games
  • 下麵是一個標準的IDistributedCache用例: public class SomeService(IDistributedCache cache) { public async Task<SomeInformation> GetSomeInformationAsync (string na ...
  • 這個庫提供了在啟動期間實例化已註冊的單例,而不是在首次使用它時實例化。 單例通常在首次使用時創建,這可能會導致響應傳入請求的延遲高於平時。在註冊時創建實例有助於防止第一次Request請求的SLA 以往我們要在註冊的時候實例單例可能會這樣寫: //註冊: services.AddSingleton< ...
  • 最近公司的很多項目都要改單點登錄了,不過大部分都還沒敲定,目前立刻要做的就只有一個比較老的項目 先改一個試試手,主要目標就是最短最快實現功能 首先因為要保留原登錄方式,所以頁面上的改動就是在原來登錄頁面下加一個SSO登錄入口 用超鏈接寫的入口,頁面改造後如下圖: 其中超鏈接的 href="Staff ...
  • Like運算符很好用,特別是它所提供的其中*、?這兩種通配符,在Windows文件系統和各類項目中運用非常廣泛。 但Like運算符僅在VB中支持,在C#中,如何實現呢? 以下是關於LikeString的四種實現方式,其中第四種為Regex正則表達式實現,且在.NET Standard 2.0及以上平... ...
  • 一:背景 1. 講故事 前些天有位朋友找到我,說他們的程式記憶體會偶發性暴漲,自己分析了下是非托管記憶體問題,讓我幫忙看下怎麼回事?哈哈,看到這個dump我還是非常有興趣的,居然還有這種游戲幣自助機類型的程式,下次去大玩家看看他們出幣的機器後端是不是C#寫的?由於dump是linux上的程式,剛好win ...
  • 前言 大家好,我是老馬。很高興遇到你。 我們為 java 開發者實現了 java 版本的 nginx https://github.com/houbb/nginx4j 如果你想知道 servlet 如何處理的,可以參考我的另一個項目: 手寫從零實現簡易版 tomcat minicat 手寫 ngin ...
  • 上一次的介紹,主要圍繞如何統一去捕獲異常,以及為每一種異常添加自己的Mapper實現,並且我們知道,當在ExceptionMapper中返回非200的Response,不支持application/json的響應類型,而是寫死的text/plain類型。 Filter為二方包異常手動捕獲 參考:ht ...
  • 大家好,我是R哥。 今天分享一個爽飛了的面試輔導 case: 這個杭州兄弟空窗期 1 個月+,面試了 6 家公司 0 Offer,不知道問題出在哪,難道是杭州的 IT 崩盤了麽? 報名面試輔導後,經過一個多月的輔導打磨,現在成功入職某上市公司,漲薪 30%+,955 工作制,不咋加班,還不捲。 其他 ...
  • 引入依賴 <!--Freemarker wls--> <dependency> <groupId>org.freemarker</groupId> <artifactId>freemarker</artifactId> <version>2.3.30</version> </dependency> ...
  • 你應如何運行程式 互動式命令模式 開始一個互動式會話 一般是在操作系統命令行下輸入python,且不帶任何參數 系統路徑 如果沒有設置系統的PATH環境變數來包括Python的安裝路徑,可能需要機器上Python可執行文件的完整路徑來代替python 運行的位置:代碼位置 不要輸入的內容:提示符和註 ...