NuGet Build status version
English | 简体中文 | 繁體中文
---
您的 Star ,能幫助 MiniExcel 讓更多人看到
--- ### 簡介 MiniExcel 簡單、高效避免OOM的.NET處理Excel查、寫、填充工具。 目前主流框架大多需要將資料全載入到記憶體方便操作,但這會導致記憶體消耗問題,MiniExcel 嘗試以 Stream 角度寫底層算法邏輯,能讓原本1000多MB占用降低到幾MB,避免記憶體不夠情況。 ![image](https://user-images.githubusercontent.com/12729184/113084691-1804d000-9211-11eb-9b08-cbb89d9ecdc2.png) ### 特點 - 低記憶體耗用,避免OOM(out of memoery)、頻繁 Full GC 情況 - 支持`即時`操作每行資料 - 兼具搭配 LINQ 延遲查詢特性,能辦到低消耗、快速分頁等複雜查詢 - 輕量,不需要安裝 Microsoft Office、COM+,DLL小於150KB - 簡便操作的 API 風格 ### 快速開始 - [導入、讀取 Excel](#getstart1) - [導出 、創建 Excel](#getstart2) - [模板填充、創建 Excel](#getstart3) - [Excel Column Name/Index/Ignore Attribute](#getstart4) - [例子](#getstart5) ### 安裝 請查看 [NuGet](https://www.nuget.org/packages/MiniExcel) ### 更新日誌 請查看 [Release Notes](docs) ### TODO 請查看 [TODO](https://github.com/shps951023/MiniExcel/projects/1?fullscreen=true) ### 性能比較、測試 Benchmarks 邏輯可以在 [MiniExcel.Benchmarks](benchmarks/MiniExcel.Benchmarks/Program.cs) 查看或是提交 PR,運行指令 ```bash dotnet run -p .\benchmarks\MiniExcel.Benchmarks\ -c Release -f netcoreapp3.1 -- -f * --join ``` 最後一次運行規格、結果 : ```bash BenchmarkDotNet=v0.12.1, OS=Windows 10.0.19042 Intel Core i7-7700 CPU 3.60GHz (Kaby Lake), 1 CPU, 8 logical and 4 physical cores [Host] : .NET Framework 4.8 (4.8.4341.0), X64 RyuJIT Job-ZYYABG : .NET Framework 4.8 (4.8.4341.0), X64 RyuJIT IterationCount=3 LaunchCount=3 WarmupCount=3 ``` Benchmark History : [Link](https://github.com/shps951023/MiniExcel/issues/276) #### 導入、查詢 Excel 比較 邏輯 : 以 [**Test1,000,000x10.xlsx**](benchmarks/MiniExcel.Benchmarks/Test1%2C000%2C000x10.xlsx) 做基準與主流框架做性能測試,總共 1,000,000 行 * 10 列筆 "HelloWorld",文件大小 23 MB | Library | Method | 最大記憶體耗用 | 平均時間 | | ---------------------------- | -------------: | ---------------: | ---------------: | | MiniExcel | 'MiniExcel QueryFirst' | 0.109 MB | 0.0007264 sec | | ExcelDataReader | 'ExcelDataReader QueryFirst' | 15.24 MB | 10.66421 sec | | MiniExcel | 'MiniExcel Query' | 17.3 MB | 14.17933 sec | | ExcelDataReader | 'ExcelDataReader Query' | 17.3 MB | 22.56508 sec | | Epplus | 'Epplus QueryFirst' | 1,452 MB | 18.19801 sec | | Epplus | 'Epplus Query' | 1,451 MB | 23.64747 sec | | OpenXmlSDK | 'OpenXmlSDK Query' | 1,412 MB | 52.00327 sec | | OpenXmlSDK | 'OpenXmlSDK QueryFirst' | 1,413 MB | 52.34865 sec | | ClosedXml | 'ClosedXml QueryFirst' | 2,158 MB | 66.18897 sec | | ClosedXml | 'ClosedXml Query' | 2,184 MB | 191.43412 sec | #### 導出、創建 Excel 比較 邏輯 : 創建1千萬筆 "HelloWorld" | Library | Method | 最大記憶體耗用 | 平均時間 | | ------------------------ | -------------: | ---------------: | -----------: | | MiniExcel | 'MiniExcel Create Xlsx' | 15 MB | 11.53181 sec | | Epplus | 'Epplus Create Xlsx' | 1,204 MB | 22.50971 sec | | OpenXmlSdk | 'OpenXmlSdk Create Xlsx' | 2,621 MB | 42.47399 sec | | ClosedXml | 'ClosedXml Create Xlsx' | 7,141 MB | 140.93992 sec | ### 讀 Excel - 支持任何 stream 类型 : FileStream,MemoryStream #### 1. Query 查詢 Excel 返回`強型別` IEnumerable 資料 [[Try it]](https://dotnetfiddle.net/w5WD1J) ```csharp public class UserAccount { public Guid ID { get; set; } public string Name { get; set; } public DateTime BoD { get; set; } public int Age { get; set; } public bool VIP { get; set; } public decimal Points { get; set; } } var rows = MiniExcel.Query(path); // or using (var stream = File.OpenRead(path)) var rows = stream.Query(); ``` ![image](https://user-images.githubusercontent.com/12729184/111107423-c8c46b80-8591-11eb-982f-c97a2dafb379.png) #### 2. Query 查詢 Excel 返回`Dynamic` IEnumerable 資料 [[Try it]](https://dotnetfiddle.net/w5WD1J) * Key 系統預設為 `A,B,C,D...Z` | MiniExcel | 1 | | -------- | -------- | | Github | 2 | ```csharp var rows = MiniExcel.Query(path).ToList(); // or using (var stream = File.OpenRead(path)) { var rows = stream.Query().ToList(); Assert.Equal("MiniExcel", rows[0].A); Assert.Equal(1, rows[0].B); Assert.Equal("Github", rows[1].A); Assert.Equal(2, rows[1].B); } ``` #### 3. 查詢資料以第一行數據當Key [[Try it]](https://dotnetfiddle.net/w5WD1J) 注意 : 同名以右邊數據為準 Input Excel : | Column1 | Column2 | | -------- | -------- | | MiniExcel | 1 | | Github | 2 | ```csharp var rows = MiniExcel.Query(useHeaderRow:true).ToList(); // or using (var stream = File.OpenRead(path)) { var rows = stream.Query(useHeaderRow:true).ToList(); Assert.Equal("MiniExcel", rows[0].Column1); Assert.Equal(1, rows[0].Column2); Assert.Equal("Github", rows[1].Column1); Assert.Equal(2, rows[1].Column2); } ``` #### 4. Query 查詢支援延遲加載(Deferred Execution),能配合LINQ First/Take/Skip辦到低消耗、高效率複雜查詢 舉例 : 查詢第一筆資料 ```csharp var row = MiniExcel.Query(path).First(); Assert.Equal("HelloWorld", row.A); // or using (var stream = File.OpenRead(path)) { var row = stream.Query().First(); Assert.Equal("HelloWorld", row.A); } ``` 與其他框架效率比較 : ![queryfirst](https://user-images.githubusercontent.com/12729184/111072392-6037a900-8515-11eb-9693-5ce2dad1e460.gif) #### 5. 查詢指定 Sheet 名稱 ```csharp MiniExcel.Query(path, sheetName: "SheetName"); //or stream.Query(sheetName: "SheetName"); ``` #### 6. 查詢所有 Sheet 名稱跟資料 ```csharp var sheetNames = MiniExcel.GetSheetNames(path); foreach (var sheetName in sheetNames) { var rows = MiniExcel.Query(path, sheetName: sheetName); } ``` #### 7. 查詢所有欄(列) ```csharp var columns = MiniExcel.GetColumns(path); // e.g result : ["A","B"...] var cnt = columns.Count; // get column count ``` #### 8. Dynamic Query 轉成 `IDictionary` 資料 ```csharp foreach(IDictionary row in MiniExcel.Query(path)) { //.. } // or var rows = MiniExcel.Query(path).Cast>(); ``` #### 9. Query 讀 Excel 返回 DataTable 提醒 : 不建議使用,因為DataTable會將數據`全載入內存`,失去MiniExcel低記憶體消耗功能。 ```C# var table = MiniExcel.QueryAsDataTable(path, useHeaderRow: true); ``` ![image](https://user-images.githubusercontent.com/12729184/116673475-07917200-a9d6-11eb-947e-a6f68cce58df.png) #### 10. 指定單元格開始讀取資料 ```csharp MiniExcel.Query(path,useHeaderRow:true,startCell:"B3") ``` ![image](https://user-images.githubusercontent.com/12729184/117260316-8593c400-ae81-11eb-9877-c087b7ac2b01.png) #### 11. 合併的單元格填充 注意 : 效率相對於`沒有使用合併填充`來說差 底層原因 : OpenXml 標准將 mergeCells 放在文件最下方,導致需要遍歷兩次 sheetxml ```csharp var config = new OpenXmlConfiguration() { FsillMergedCells = true }; var rows = MiniExcel.Query(path, configuration: config); ``` ![image](https://user-images.githubusercontent.com/12729184/117973630-3527d500-b35f-11eb-95c3-bde255f8114e.png) 支持不固定長寬多行列填充 ![image](https://user-images.githubusercontent.com/12729184/117973820-6d2f1800-b35f-11eb-88d8-555063938108.png) ### 寫 Excel 1. 必須是非abstract 類別有公開無參數構造函數 2. MiniExcel SaveAs 支援 `IEnumerable參數延遲查詢`,除非必要請不要使用 ToList 等方法讀取全部資料到記憶體 圖片 : 是否呼叫 ToList 的記憶體差別 #### ![image](https://user-images.githubusercontent.com/12729184/112587389-752b0b00-8e38-11eb-8a52-cfb76c57e5eb.png) #### 1. 支持集合<匿名類別>或是<強型別> [[Try it]](https://dotnetfiddle.net/w5WD1J) ```csharp var path = Path.Combine(Path.GetTempPath(), $"{Guid.NewGuid()}.xlsx"); MiniExcel.SaveAs(path, new[] { new { Column1 = "MiniExcel", Column2 = 1 }, new { Column1 = "Github", Column2 = 2} }); ``` #### 2. `IEnumerable>` ```csharp var values = new List>() { new Dictionary{{ "Column1", "MiniExcel" }, { "Column2", 1 } }, new Dictionary{{ "Column1", "Github" }, { "Column2", 2 } } }; MiniExcel.SaveAs(path, values); ``` output : | Column1 | Column2 | | --------- | ------- | | MiniExcel | 1 | | Github | 2 | #### 3. IDataReader 參數 - 推薦使用,可以避免載入全部數據到記憶體 ```csharp MiniExcel.SaveAs(path, reader); ``` ![image](https://user-images.githubusercontent.com/12729184/121275378-149a5e80-c8bc-11eb-85fe-5453552134f0.png) #### 4. Datatable - `不推薦使用`,會將數據全載入記憶體 - 優先使用 Caption 當欄位名稱 ```csharp var path = Path.Combine(Path.GetTempPath(), $"{Guid.NewGuid()}.xlsx"); var table = new DataTable(); { table.Columns.Add("Column1", typeof(string)); table.Columns.Add("Column2", typeof(decimal)); table.Rows.Add("MiniExcel", 1); table.Rows.Add("Github", 2); } MiniExcel.SaveAs(path, table); ``` #### 5. Dapper - 不推薦使用,會將數據全載入記憶體 ```csharp using (var connection = GetConnection(connectionString)) { var rows = connection.Query(@"select 'MiniExcel' as Column1,1 as Column2 union all select 'Github',2"); MiniExcel.SaveAs(path, rows); } ``` #### 6. SaveAs 支持 Stream,生成文件不落地 [[Try it]](https://dotnetfiddle.net/JOen0e) ```csharp using (var stream = new MemoryStream()) //支持 FileStream,MemoryStream..等 { stream.SaveAs(values); } ``` 像是 API 導出 Excel ```csharp public IActionResult DownloadExcel() { var values = new[] { new { Column1 = "MiniExcel", Column2 = 1 }, new { Column1 = "Github", Column2 = 2} }; var memoryStream = new MemoryStream(); memoryStream.SaveAs(values); memoryStream.Seek(0, SeekOrigin.Begin); return new FileStreamResult(memoryStream, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet") { FileDownloadName = "demo.xlsx" }; } ``` #### 7. 創建多個工作表(Sheet) ```csharp // 1. Dictionary var users = new[] { new { Name = "Jack", Age = 25 }, new { Name = "Mike", Age = 44 } }; var department = new[] { new { ID = "01", Name = "HR" }, new { ID = "02", Name = "IT" } }; var sheets = new Dictionary { ["users"] = users, ["department"] = department }; MiniExcel.SaveAs(path, sheets); // 2. DataSet var sheets = new DataSet(); sheets.Add(UsersDataTable); sheets.Add(DepartmentDataTable); //.. MiniExcel.SaveAs(path, sheets); ``` ![image](https://user-images.githubusercontent.com/12729184/118130875-6e7c4580-b430-11eb-9b82-22f02716bd63.png) #### 8. 表格樣式選擇 從v0.15.0版本開始預設樣式改為 ![image](https://user-images.githubusercontent.com/12729184/118784493-a36e1980-b8c2-11eb-8a3d-a669985aea1a.png) 不需要樣式 ```csharp var config = new OpenXmlConfiguration() { TableStyles = TableStyles.None }; MiniExcel.SaveAs(path, value,configuration:config); ``` ![image](https://user-images.githubusercontent.com/12729184/118784917-f3e57700-b8c2-11eb-8718-8d955b1bc197.png) ### 模板填充 Excel - 宣告方式類似 Vue 模板 `{{變量名稱}}`, 或是集合渲染 `{{集合名稱.欄位名稱}}` - 集合渲染支持 IEnumerable/DataTable/DapperRow #### 1. 基本填充 模板: ![image](https://user-images.githubusercontent.com/12729184/114537556-ed8d2b00-9c84-11eb-8303-a69f62c41e5b.png) 最終效果: ![image](https://user-images.githubusercontent.com/12729184/114537490-d8180100-9c84-11eb-8c69-db58692f3a85.png) 代碼: ```csharp // 1. By POCO var value = new { Name = "Jack", CreateDate = new DateTime(2021, 01, 01), VIP = true, Points = 123 }; MiniExcel.SaveAsByTemplate(path, templatePath, value); // 2. By Dictionary var value = new Dictionary() { ["Name"] = "Jack", ["CreateDate"] = new DateTime(2021, 01, 01), ["VIP"] = true, ["Points"] = 123 }; MiniExcel.SaveAsByTemplate(path, templatePath, value); ``` #### 2. IEnumerable/DataTable 數據填充 > Note1: 同行從左往右以第一個 IEnumerableUse 當列表來源 (不支持同列多集合) 模板: ![image](https://user-images.githubusercontent.com/12729184/114564652-14f2f080-9ca3-11eb-831f-09e3fedbc5fc.png) 最終效果: ![image](https://user-images.githubusercontent.com/12729184/114564204-b2015980-9ca2-11eb-900d-e21249f93f7c.png) 代碼: ```csharp //1. By POCO var value = new { employees = new[] { new {name="Jack",department="HR"}, new {name="Lisa",department="HR"}, new {name="John",department="HR"}, new {name="Mike",department="IT"}, new {name="Neo",department="IT"}, new {name="Loan",department="IT"} } }; MiniExcel.SaveAsByTemplate(path, templatePath, value); //2. By Dictionary var value = new Dictionary() { ["employees"] = new[] { new {name="Jack",department="HR"}, new {name="Lisa",department="HR"}, new {name="John",department="HR"}, new {name="Mike",department="IT"}, new {name="Neo",department="IT"}, new {name="Loan",department="IT"} } }; MiniExcel.SaveAsByTemplate(path, templatePath, value); ``` #### 3. 複雜數據填充 > Note: 支持多 sheet 填充,並共用同一組參數 模板: ![image](https://user-images.githubusercontent.com/12729184/114565255-acf0da00-9ca3-11eb-8a7f-8131b2265ae8.png) 最終效果: ![image](https://user-images.githubusercontent.com/12729184/114565329-bf6b1380-9ca3-11eb-85e3-3969e8bf6378.png) 代碼: ```csharp // 1. By POCO var value = new { title = "FooCompany", managers = new[] { new {name="Jack",department="HR"}, new {name="Loan",department="IT"} }, employees = new[] { new {name="Wade",department="HR"}, new {name="Felix",department="HR"}, new {name="Eric",department="IT"}, new {name="Keaton",department="IT"} } }; MiniExcel.SaveAsByTemplate(path, templatePath, value); // 2. By Dictionary var value = new Dictionary() { ["title"] = "FooCompany", ["managers"] = new[] { new {name="Jack",department="HR"}, new {name="Loan",department="IT"} }, ["employees"] = new[] { new {name="Wade",department="HR"}, new {name="Felix",department="HR"}, new {name="Eric",department="IT"}, new {name="Keaton",department="IT"} } }; MiniExcel.SaveAsByTemplate(path, templatePath, value); ``` #### 4. 大數據填充效率比較 > NOTE: 在 MiniExcel 使用 IEnumerable 延遲 ( 不ToList ) 可以節省記憶體使用 ![image](https://user-images.githubusercontent.com/12729184/114577091-5046ec80-9cae-11eb-924b-087c7becf8da.png) #### 5. Cell 值自動類別對應 模板 ![image](https://user-images.githubusercontent.com/12729184/114802504-64830a80-9dd0-11eb-8d56-8e8c401b3ace.png) 最終效果 ![image](https://user-images.githubusercontent.com/12729184/114802419-43221e80-9dd0-11eb-9ffe-a2ce34fe7076.png) 類別 ```csharp public class Poco { public string @string { get; set; } public int? @int { get; set; } public decimal? @decimal { get; set; } public double? @double { get; set; } public DateTime? datetime { get; set; } public bool? @bool { get; set; } public Guid? Guid { get; set; } } ``` 代碼 ```csharp var poco = new TestIEnumerableTypePoco { @string = "string", @int = 123, @decimal = decimal.Parse("123.45"), @double = (double)123.33, @datetime = new DateTime(2021, 4, 1), @bool = true, @Guid = Guid.NewGuid() }; var value = new { Ts = new[] { poco, new TestIEnumerableTypePoco{}, null, poco } }; MiniExcel.SaveAsByTemplate(path, templatePath, value); ``` #### 6. Example : 列出 Github 專案 模板 ![image](https://user-images.githubusercontent.com/12729184/115068665-221f1200-9f25-11eb-9820-3d7d9638cb03.png) 最終效果 ![image](https://user-images.githubusercontent.com/12729184/115068685-2814f300-9f25-11eb-96b5-0e7f21297f4d.png) 代碼 ```csharp var projects = new[] { new {Name = "MiniExcel",Link="https://github.com/shps951023/MiniExcel",Star=146, CreateTime=new DateTime(2021,03,01)}, new {Name = "HtmlTableHelper",Link="https://github.com/shps951023/HtmlTableHelper",Star=16, CreateTime=new DateTime(2020,02,01)}, new {Name = "PocoClassGenerator",Link="https://github.com/shps951023/PocoClassGenerator",Star=16, CreateTime=new DateTime(2019,03,17)} }; var value = new { User = "ITWeiHan", Projects = projects, TotalStar = projects.Sum(s => s.Star) }; MiniExcel.SaveAsByTemplate(path, templatePath, value); ``` #### 7. DataTable 當參數 ```csharp var managers = new DataTable(); { managers.Columns.Add("name"); managers.Columns.Add("department"); managers.Rows.Add("Jack", "HR"); managers.Rows.Add("Loan", "IT"); } var value = new Dictionary() { ["title"] = "FooCompany", ["managers"] = managers, }; MiniExcel.SaveAsByTemplate(path, templatePath, value); ``` ### Excel 列屬性 (Excel Column Attribute) #### 1. 指定列名稱、指定第幾列、是否忽略該列 Excel例子 ![image](https://user-images.githubusercontent.com/12729184/114230869-3e163700-99ac-11eb-9a90-2039d4b4b313.png) 代碼 ```csharp public class ExcelAttributeDemo { [ExcelColumnName("Column1")] public string Test1 { get; set; } [ExcelColumnName("Column2")] public string Test2 { get; set; } [ExcelIgnore] public string Test3 { get; set; } [ExcelColumnIndex("I")] // 系統會自動轉換"I"為第8列 public string Test4 { get; set; } public string Test5 { get; } //系統會忽略此列 public string Test6 { get; private set; } //set非公開,系統會忽略 [ExcelColumnIndex(3)] // 從0開始索引 public string Test7 { get; set; } } var rows = MiniExcel.Query(path).ToList(); Assert.Equal("Column1", rows[0].Test1); Assert.Equal("Column2", rows[0].Test2); Assert.Null(rows[0].Test3); Assert.Equal("Test7", rows[0].Test4); Assert.Null(rows[0].Test5); Assert.Null(rows[0].Test6); Assert.Equal("Test4", rows[0].Test7); ``` #### 2. 自定義日期格式 (ExcelFormatAttribute) 類別 ```csharp public class Dto { public string Name { get; set; } [ExcelFormat("MMMM dd, yyyy")] public DateTime InDate { get; set; } } ``` 代碼 ```csharp var value = new Dto[] { new Issue241Dto{ Name="Jack",InDate=new DateTime(2021,01,04)}, new Issue241Dto{ Name="Henry",InDate=new DateTime(2020,04,05)}, }; MiniExcel.SaveAs(path, value); ``` 效果 ![image](https://user-images.githubusercontent.com/12729184/118910788-ab2bcd80-b957-11eb-8d42-bfce36621b1b.png) Query 支持自定義格式轉換 ![image](https://user-images.githubusercontent.com/12729184/118911286-87b55280-b958-11eb-9a88-c8ff403d240a.png) ### Excel 類別自動判斷 - MiniExcel 預設會根據`文件擴展名`判斷是 xlsx 還是 csv,但會有失準時候,請自行指定。 - Stream 類別無法判斷來源於哪種 excel 請自行指定 ```csharp stream.SaveAs(excelType:ExcelType.CSV); //or stream.SaveAs(excelType:ExcelType.XLSX); //or stream.Query(excelType:ExcelType.CSV); //or stream.Query(excelType:ExcelType.XLSX); ``` ### CSV #### 概念 - 預設全以字串類型返回,預設不會轉換為數字或者日期,除非有強型別定義泛型 #### 自定分隔符 預設以 `,` 作為分隔符,自定義請修改 `Seperator` 屬性 ```csharp var config = new MiniExcelLibs.Csv.CsvConfiguration() { Seperator=';' }; MiniExcel.SaveAs(path, values,configuration: config); ``` #### 自定義換行符 預設以 `\r\n` 作為換行符,自定義請修改 `NewLine` 屬性 ```csharp var config = new MiniExcelLibs.Csv.CsvConfiguration() { NewLine='\n' }; MiniExcel.SaveAs(path, values,configuration: config); ``` #### 自定義編碼 - 預設編碼為「從Byte順序標記檢測編碼」(detectEncodingFromByteOrderMarks: true) - 有自定義編碼需求,請修改 StreamReaderFunc / StreamWriterFunc 屬性 ```csharp // Read var config = new MiniExcelLibs.Csv.CsvConfiguration() { StreamReaderFunc = (stream) => new StreamReader(stream,Encoding.GetEncoding("gb2312")) }; var rows = MiniExcel.Query(path, true,excelType:ExcelType.CSV,configuration: config); // Write var config = new MiniExcelLibs.Csv.CsvConfiguration() { StreamWriterFunc = (stream) => new StreamWriter(stream, Encoding.GetEncoding("gb2312")) }; MiniExcel.SaveAs(path, value,excelType:ExcelType.CSV, configuration: config); ``` ### 異步 Async 從 v0.17.0 版本開始支持異步 (感謝[isdaniel ( SHIH,BING-SIOU)](https://github.com/isdaniel)) ```csharp public static Task SaveAsAsync(string path, object value, bool printHeader = true, string sheetName = "Sheet1", ExcelType excelType = ExcelType.UNKNOWN, IConfiguration configuration = null) public static Task SaveAsAsync(this Stream stream, object value, bool printHeader = true, string sheetName = "Sheet1", ExcelType excelType = ExcelType.XLSX, IConfiguration configuration = null) public static Task> QueryAsync(string path, bool useHeaderRow = false, string sheetName = null, ExcelType excelType = ExcelType.UNKNOWN, string startCell = "A1", IConfiguration configuration = null) public static Task> QueryAsync(this Stream stream, string sheetName = null, ExcelType excelType = ExcelType.UNKNOWN, string startCell = "A1", IConfiguration configuration = null) where T : class, new() public static Task> QueryAsync(string path, string sheetName = null, ExcelType excelType = ExcelType.UNKNOWN, string startCell = "A1", IConfiguration configuration = null) where T : class, new() public static Task>> QueryAsync(this Stream stream, bool useHeaderRow = false, string sheetName = null, ExcelType excelType = ExcelType.UNKNOWN, string startCell = "A1", IConfiguration configuration = null) public static Task SaveAsByTemplateAsync(this Stream stream, string templatePath, object value) public static Task SaveAsByTemplateAsync(this Stream stream, byte[] templateBytes, object value) public static Task SaveAsByTemplateAsync(string path, string templatePath, object value) public static Task SaveAsByTemplateAsync(string path, byte[] templateBytes, object value) public static Task QueryAsDataTableAsync(string path, bool useHeaderRow = true, string sheetName = null, ExcelType excelType = ExcelType.UNKNOWN, string startCell = "A1", IConfiguration configuration = null) ``` ### 範例 #### 1. SQLite & Dapper 讀取大數據新增到資料庫 Note : 請不要呼叫 call ToList/ToArray 等方法,這會將所有資料讀到記憶體內 ```csharp using (var connection = new SQLiteConnection(connectionString)) { connection.Open(); using (var transaction = connection.BeginTransaction()) using (var stream = File.OpenRead(path)) { var rows = stream.Query(); foreach (var row in rows) connection.Execute("insert into T (A,B) values (@A,@B)", new { row.A, row.B }, transaction: transaction); transaction.Commit(); } } ``` 效能: ![image](https://user-images.githubusercontent.com/12729184/111072579-2dda7b80-8516-11eb-9843-c01a1edc88ec.png) #### 2. ASP.NET Core 3.1 or MVC 5 下載/上傳 Excel Xlsx API Demo [Try it](tests/MiniExcel.Tests.AspNetCore) ```csharp public class ApiController : Controller { public IActionResult Index() { return new ContentResult { ContentType = "text/html", StatusCode = (int)HttpStatusCode.OK, Content = @" DownloadExcel
DownloadExcelFromTemplatePath
DownloadExcelFromTemplateBytes

Upload Excel


" }; } public IActionResult DownloadExcel() { var values = new[] { new { Column1 = "MiniExcel", Column2 = 1 }, new { Column1 = "Github", Column2 = 2} }; var memoryStream = new MemoryStream(); memoryStream.SaveAs(values); memoryStream.Seek(0, SeekOrigin.Begin); return new FileStreamResult(memoryStream, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet") { FileDownloadName = "demo.xlsx" }; } public IActionResult DownloadExcelFromTemplatePath() { string templatePath = "TestTemplateComplex.xlsx"; Dictionary value = new Dictionary() { ["title"] = "FooCompany", ["managers"] = new[] { new {name="Jack",department="HR"}, new {name="Loan",department="IT"} }, ["employees"] = new[] { new {name="Wade",department="HR"}, new {name="Felix",department="HR"}, new {name="Eric",department="IT"}, new {name="Keaton",department="IT"} } }; MemoryStream memoryStream = new MemoryStream(); memoryStream.SaveAsByTemplate(templatePath, value); memoryStream.Seek(0, SeekOrigin.Begin); return new FileStreamResult(memoryStream, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet") { FileDownloadName = "demo.xlsx" }; } private static Dictionary TemplateBytesCache = new Dictionary(); static ApiController() { string templatePath = "TestTemplateComplex.xlsx"; byte[] bytes = System.IO.File.ReadAllBytes(templatePath); TemplateBytesCache.Add(templatePath, bytes); } public IActionResult DownloadExcelFromTemplateBytes() { byte[] bytes = TemplateBytesCache["TestTemplateComplex.xlsx"]; Dictionary value = new Dictionary() { ["title"] = "FooCompany", ["managers"] = new[] { new {name="Jack",department="HR"}, new {name="Loan",department="IT"} }, ["employees"] = new[] { new {name="Wade",department="HR"}, new {name="Felix",department="HR"}, new {name="Eric",department="IT"}, new {name="Keaton",department="IT"} } }; MemoryStream memoryStream = new MemoryStream(); memoryStream.SaveAsByTemplate(bytes, value); memoryStream.Seek(0, SeekOrigin.Begin); return new FileStreamResult(memoryStream, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet") { FileDownloadName = "demo.xlsx" }; } public IActionResult UploadExcel(IFormFile excel) { var stream = new MemoryStream(); excel.CopyTo(stream); foreach (var item in stream.Query(true)) { // do your logic etc. } return Ok("File uploaded successfully"); } } ``` #### 3. 分頁查詢 ```csharp void Main() { var rows = MiniExcel.Query(path); Console.WriteLine("==== No.1 Page ===="); Console.WriteLine(Page(rows,pageSize:3,page:1)); Console.WriteLine("==== No.50 Page ===="); Console.WriteLine(Page(rows,pageSize:3,page:50)); Console.WriteLine("==== No.5000 Page ===="); Console.WriteLine(Page(rows,pageSize:3,page:5000)); } public static IEnumerable Page(IEnumerable en, int pageSize, int page) { return en.Skip(page * pageSize).Take(pageSize); } ``` ![20210419](https://user-images.githubusercontent.com/12729184/114679083-6ef4c400-9d3e-11eb-9f78-a86daa45fe46.gif) #### 4. WebForm不落地導出Excel ```csharp var fileName = "Demo.xlsx"; var sheetName = "Sheet1"; HttpResponse response = HttpContext.Current.Response; response.Clear(); response.ContentType = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"; response.AddHeader("Content-Disposition", $"attachment;filename=\"{fileName}\""); var values = new[] { new { Column1 = "MiniExcel", Column2 = 1 }, new { Column1 = "Github", Column2 = 2} }; var memoryStream = new MemoryStream(); memoryStream.SaveAs(values, sheetName: sheetName); memoryStream.Seek(0, SeekOrigin.Begin); memoryStream.CopyTo(Response.OutputStream); response.End(); ``` #### 5. 動態 i18n 多國語言跟權限管理 像例子一樣,建立一個方法處理 i18n 跟權限管理,並搭配 `yield return 返回 IEnumerable>`,即可達到動態、低記憶體處理效果 ```csharp void Main() { var value = new Order[] { new Order(){OrderNo = "SO01",CustomerID="C001",ProductID="P001",Qty=100,Amt=500}, new Order(){OrderNo = "SO02",CustomerID="C002",ProductID="P002",Qty=300,Amt=400}, }; Console.WriteLine("en-Us and Sales role"); { var path = Path.GetTempPath() + Guid.NewGuid() + ".xlsx"; var lang = "en-US"; var role = "Sales"; MiniExcel.SaveAs(path, GetOrders(lang, role, value)); MiniExcel.Query(path, true).Dump(); } Console.WriteLine("zh-CN and PMC role"); { var path = Path.GetTempPath() + Guid.NewGuid() + ".xlsx"; var lang = "zh-CN"; var role = "PMC"; MiniExcel.SaveAs(path, GetOrders(lang, role, value)); MiniExcel.Query(path, true).Dump(); } } private IEnumerable> GetOrders(string lang, string role, Order[] orders) { foreach (var order in orders) { var newOrder = new Dictionary(); if (lang == "zh-CN") { newOrder.Add("客戶編號", order.CustomerID); newOrder.Add("訂單編號", order.OrderNo); newOrder.Add("產品編號", order.ProductID); newOrder.Add("數量", order.Qty); if (role == "Sales") newOrder.Add("價格", order.Amt); yield return newOrder; } else if (lang == "en-US") { newOrder.Add("Customer ID", order.CustomerID); newOrder.Add("Order No", order.OrderNo); newOrder.Add("Product ID", order.ProductID); newOrder.Add("Quantity", order.Qty); if (role == "Sales") newOrder.Add("Amount", order.Amt); yield return newOrder; } else { throw new InvalidDataException($"lang {lang} wrong"); } } } public class Order { public string OrderNo { get; set; } public string CustomerID { get; set; } public decimal Qty { get; set; } public string ProductID { get; set; } public decimal Amt { get; set; } } ``` ![image](https://user-images.githubusercontent.com/12729184/118939964-d24bc480-b982-11eb-88dd-f06655f6121a.png) #### 6. CSV 轉成 Xlsx ```csharp public void CsvToXlsx(string csvPath, string xlsxPath) { var value = MiniExcel.Query(csvPath, true); MiniExcel.SaveAs(xlsxPath, value); } ``` ![image](https://user-images.githubusercontent.com/12729184/122674182-8486de00-d206-11eb-8f96-58b22ebbefc3.png) ### FAQ 常見問題 #### Q: Excel 表頭標題名稱跟 class 屬性名稱不一致,如何對應? A. 請使用 ExcelColumnName 作 mapping ![image](https://user-images.githubusercontent.com/12729184/116020475-eac50980-a678-11eb-8804-129e87200e5e.png) #### Q. 多工作表(sheet)如何導出/查詢資料? A. 使用 `GetSheetNames `方法搭配 Query 的 sheetName 參數 ```csharp var sheets = MiniExcel.GetSheetNames(path); foreach (var sheet in sheets) { Console.WriteLine($"sheet name : {sheet} "); var rows = MiniExcel.Query(path,useHeaderRow:true,sheetName:sheet); Console.WriteLine(rows); } ``` ![image](https://user-images.githubusercontent.com/12729184/116199841-2a1f5300-a76a-11eb-90a3-6710561cf6db.png) #### Q. 查詢如何映射枚舉(enum)? A. 名稱一樣,系統會自動映射(注意:大小寫不敏感) ![image](https://user-images.githubusercontent.com/12729184/116210595-9784b100-a775-11eb-936f-8e7a8b435961.png) #### Q. 是否使用 Count 會載入全部數據到記憶體 不會,圖片測試一百萬行*十列資料,簡單測試,內存最大使用 < 60MB,花費13.65秒 ![image](https://user-images.githubusercontent.com/12729184/117118518-70586000-adc3-11eb-9ce3-2ba76cf8b5e5.png) #### Q. Query如何使用整數索引取值? Query 預設索引為字串Key : A,B,C....,想要改為數字索引,請建立以下方法自行轉換 ```csharp void Main() { var path = @"D:\git\MiniExcel\samples\xlsx\TestTypeMapping.xlsx"; var rows = MiniExcel.Query(path,true); foreach (var r in ConvertToIntIndexRows(rows)) { Console.Write($"column 0 : {r[0]} ,column 1 : {r[1]}"); Console.WriteLine(); } } private IEnumerable> ConvertToIntIndexRows(IEnumerable rows) { ICollection keys = null; var isFirst = true; foreach (IDictionary r in rows) { if(isFirst) { keys = r.Keys; isFirst = false; } var dic = new Dictionary(); var index = 0; foreach (var key in keys) dic[index++] = r[key]; yield return dic; } } ``` #### Q. 導出時數組為空時生成沒有標題空 Excel 因為 MiniExcel 使用類似 JSON.NET 動態從值獲取類別機制簡化 API 操作,沒有數據就無法獲取類別。可以查看[ issue #133](https://github.com/shps951023/MiniExcel/issues/133) 了解。 ![image](https://user-images.githubusercontent.com/12729184/122639771-546c0c00-d12e-11eb-800c-498db27889ca.png) ### 侷限與警告 - 目前不支援 xls (97-2003) 或是加密檔案 - xlsm 只支持查詢 ### 參考 - 讀取邏輯 : [ExcelDataReader](https://github.com/ExcelDataReader/ExcelDataReader) / [ClosedXML](https://github.com/ClosedXML/ClosedXML) - API 設計方式 : [StackExchange/Dapper](https://github.com/StackExchange/Dapper) ### 感謝名單 #### [Jetbrains](https://www.jetbrains.com/) ![jetbrains-variant-2](https://user-images.githubusercontent.com/12729184/123997015-8456c180-da02-11eb-829a-aec476fe8e94.png) 感謝提供免費IDE支持此專案 ([License](https://user-images.githubusercontent.com/12729184/123988233-6ab17c00-d9fa-11eb-8739-2a08c6a4a263.png)) ### Contributors ![](https://contrib.rocks/image?repo=shps951023/MiniExcel)