ExcelReport是一款基於NPOI開發的報表引擎組件。它基於關注點分離的理念,將數據與樣式、格式分離。讓模板承載樣式、格式等NPOI不怎么擅長且實現繁瑣的信息,結合NPOI對數據的處理的優點將Excel報表的生成化繁為簡。同時,對報表組成的基本元素進行了抽象,進一步簡化了Excel報表的生成過程。
官方站點
NuGet:https://www.nuget.org/packages/ExcelReport
GitHub:https://github.com/hanzhaoxin/ExcelReport
cnblogs:http://www.cnblogs.com/hanzhaoxin/tag/ExcelReport /
團隊介紹
Jensen
來自於中國深圳,是這個項目的發起人和開發人員,2014年11月開始了ExcelReport的開發,負責ExcelReport的開發、測試和bug修復。
個人博客地址:http:// hanzhaoxin.cnblogs.com
許可證說明
ExcelReport采用的是MIT許可,這意味着它可以被用於任何商業或非商業項目,你不用擔心因為使用它而必須開放你自己的源代碼,且可借助ExcelReport的影響力推廣你的產品。
當然作為一個開源許可證,肯定也是有一些義務。例如:在軟件和軟件的所有副本中都必須包含以上版權聲明和本許可聲明。
完整的MIT許可證請見:http://mit-license.org/
版本升級說明:
如果您項目中使用了ExcelReport,Bug修復和功能擴充的升級版本請放心升級,這類升級不能影響您現有的項目。如果架構修改版本信息發生了變化,請謹慎升級,這類升級有可能影響您現有的項目。
為什么要用ExcelReport?
回答這個問題前,我們先看看Tony Qu是怎么回答為什么要用NPOI的?
1)你不需要在服務器上安裝微軟的 Office,可以避免版權問題。
2)NPOI使用起來比 Office PIA 的 API 更加方便,更人性化。
3)你不用去花大力氣維護 NPOI,NPOI Team 會不斷更新、改善 NPOI,絕對省成本。
4)很多事情是 html 和cvs法做不到的,比如說公式計算[Cell C1]=A1+B1*A2單元格
高級樣式(如文本旋轉、對齊、寬度)等,其中公式計算可以適當減輕服務器端的計算壓力
回到我們的問題,為什么要用ExcelReport呢?
1) 復雜的事情簡單了,不可能的事情可行了。
2) 你不需要了解NPOI大量的API,你不需要用.NET語言寫蹩腳的Java的語法。
3) 套用Tony兄的描述,你不用去花大力氣維護ExcelReport,ExcelReport Team會不斷更新、改善ExcelReport,絕對省成本。
目錄
1報表元素與元素格式化器
2演示:使用ExcelReport生成報表
3格式化器示例
3.1局部格式化器
3.2單元格格式化器
3.3表格格式化器
3.4重復單元格式化器
4多Sheet報表生成
1報表元素與元素格式化器
在開始示例之前,我們用一章的篇幅介紹ExcelReport是如何將報表的內容抽象為元素的?
又是如何為元素填充數據的?為了說明第一個問題,我們從一個現有的報表開始。
如下報表有兩個Sheet:Sheet1名為“工資表”Sheet2名為“工資條”,其截圖如下所示。
我們先把數據部用藍色框線標出來。
名正才能言順,先說說ExcelReport中報表元素的概念:
元素:填充到報表模板中的數據源對象,我們稱之為元素。
局部元素:填充到報表模板中的數據源對象是一個單元格內容的一部分,我們稱這樣的數據源對象為局部元素。
單元格元素:填充到報表模板中的數據源對象是一個單元格的內容,我們稱這樣的數據源對象為單元格元素。
表格元素:填充到報表模板中的數據源是某對象的集合,該對象是一行中多個單元格的內容集合,我們稱這樣的數據源集合為表格元素。
重復單元元素:填充到報表模板中的數據源是某對象的集合,該對象是多行中多個單元格的內容集合,我們稱這樣的數據源集合為重復單元元素。
【表格元素與重復單元元素數據源以集合出現。為復元素。】
【對應的,局部元素和單元格元素稱之為單元素。】
有了定義,我們讓元素們各就各位。
那么,ExcelReport又是如何為元素填充數據的?
話說元素格式化器為此而生。
報表元素 |
元素格式化器 |
局部元素 |
PartFormatter |
單元格元素 |
CellFormatter |
表格元素 |
TableFormatter |
重復單元元素 |
RepeaterFormatter |
【元素格式化器的作用是格式化元素將其填充到報表模板。】
2演示:使用ExcelReport生成報表
目標報表,生成上章分析的”工資表-工資條”報表。
第一步:設計模板
【模板中參數格式:$[ParameterName]】
1) 打開模板填充規則文件生成工具
2) 將設計好的模板拖入Excel模板文件選擇框
3) 點擊“生成模板規則文件(.XML)”按鈕,生成規則文件。
第三步:填充模板,生成報表【項目中要添加對ExcelReport及NPOI(2.0以上)的引用】
生成導出報表:
【注:演示示例“生成工資表-工資條報表”源碼見解決方案:ExcelReportExamples】
3格式化器示例
通過上一章的示例,我們了解了ExcelReport生成報表的步驟,也用到了各種格式化器。在本章,我們將對格式化器逐一展開講解,以更詳細的了解它們。
3.1局部格式化器
局部格式化器用於格式化填充一個單元格內容的一部分。填充數據類型為string。
構成函數:
參數 |
描述 |
cellPoint |
參數所在單元格位置 |
parameterName |
參數名 |
value |
要格式化填充的值 |
示例:(局部格式化器示例)
第一步:設計模板
第二步:由模板生成模板填充規則文件
第三步:填充模板,生成報表
生成導出報表:
3.2單元格格式化器
單元格格式化器用於格式化填充一個單元格。填充數據類型為object,詳見下表:
填充數據類型 |
Excel中對應的數據類型 |
可視化設置項 |
String |
String |
|
DateTime |
DateTime |
|
Boolean |
Boolean |
|
Int16 Int32 Int64 Byte Single Double UInt16 UInt32 UInt64 |
||
Byte[] |
Image |
構成函數:
參數 |
描述 |
cellPoint |
參數所在單元格位置 |
value |
要格式化填充的值 |
示例:(單元格格式化器示例)
第一步:設計模板
第二步:由模板生成模板填充規則文件(略,詳參見第2章“演示”)
第三步:填充模板,生成報表
生成導出報表:
3.3表格格式化器
表格格式化器用於格式化填充一個表格。填充數據類型為IEnumerable<TSource>。
構造函數:
參數 |
描述 |
templateRowIndex |
模板行行標 |
dataSource |
要格式化填充的數據 |
columnInfos |
列信息集合 |
TableColumnInfo構造函數:
參數 |
描述 |
columnIndex |
列標 |
dgSetValue |
Func<TSource, object>類型的委托對象(返回值Object,可參照第二節填充數據類型與Excel中數據類型對應表。) |
示例:(表格格式化器示例)
第一步:設計模板
第二步:由模板生成模板填充規則文件(略,詳參見第2章“演示”)
第三步:填充模板,生成報表
生成導出報表:
提問回復:【關於TableFormatter有以下知識點,多次被提問,這里做出統一回答。】 問題一:TableFormatter的數據源可以是DataTable嗎? 答:你可以這樣寫: 問題二:我的實體類中沒有實現外鏈,在實體對象中有一個ID屬性,我想導出的內容是ID對應的Name,這怎么辦? 答:和示例中的“性別”沒什么區別吧。好吧,貼行代碼: |
3.4重復單元格式化器
重復單元格式化器用於格式化填充一個重復單元元素。填充數據類型為IEnumerable<TSource>。
構造函數:
參數 |
描述 |
startTagCell |
重復單元(開始)標識單元格 |
endTagCell |
重復單元(結束)標識單元格 |
dataSource |
要格式化填充的數據 |
cellInfos |
重復單元包含的單元格信息集合 |
RepeaterCellInfo構造函數:
參數 |
描述 |
cellPoint |
單元格坐標 |
dgSetValue |
Func<TSource, object>類型的委托對象(返回值Object,可參照第二節填充數據類型與Excel中數據類型對應表。) |
示例:(重復單元格式化器示例)
第一步:設計模板
根據需求,隱藏重復單元標識行。
第二步:由模板生成模板填充規則文件(略,詳參見第2章“演示”)
第三步:填充模板,生成報表
生成導出報表:
4多Sheet報表生成
到目前為止,我們所有導出都直接使用的是:ExportHelper類中的靜態方法。其實在ExcelReport組件的設計中Export類便是終點了,ExportHelper類正如它的名字只是為了方便操作提供的助手類而已。
【哦,它還是部分類,你可以根據需求擴展。】
回到本章的主題,我們要談的是多Sheet報表的生成。什么?這和前邊啰嗦的那些有什么關系?好吧,其實關系也不大,我只是想說關注報表的生成,你看Export類就對了。
參數 |
描述 |
templateFile |
模板文件路徑 |
containers |
Sheet格式化容器的數組【數組中的每個元素對應一個Sheet】 |
示例:(多Sheet報表生成示例)
第一步:設計模板
第二步:由模板生成模板填充規則文件(略,詳參見第2章“演示”)
第三步:填充模板,生成報表
生成導出報表: