嘗試做一個.NET簡單、高效、避免OOM的Excel工具

暐翰發表於2021-04-02

Github : https://github.com/shps951023/MiniExcel

簡介

我嘗試做一個.NET簡單、高效、避免OOM的Excel工具

目前主流框架大多將資料全載入到記憶體方便操作，但這會導致記憶體消耗問題，MiniExcel 嘗試以 Stream 角度寫底層演算法邏輯，能讓原本1000多MB佔用降低到幾MB，避免記憶體不夠情況。適合像是低規格 azure app service 或是讀取大檔案等情境。

特點

低記憶體耗用，避免OOM(out of memoery)、頻繁 Full GC 情況
支援即時操作每行資料
兼具搭配 LINQ 延遲查詢特性，能辦到低消耗、快速分頁等複雜查詢
圖片:與主流框架對比的消耗、效率差
輕量，不依賴任何套件，DLL小於100KB
簡便操作的 Dapper API 風格

效能測試

以 Test1,000,000x10.xlsx 做基準與主流框架做效能測試，總共 1千萬筆 "HelloWorld"，檔案大小 23 MB

Benchmarks 邏輯可以在 MiniExcel.Benchmarks 檢視或是提交 PR，執行指令

dotnet run -p .\benchmarks\MiniExcel.Benchmarks\ -c Release -f netcoreapp3.1 -- -f * --join

最後一次執行結果 :

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

Method	最大記憶體耗用	平均時間	Gen 0	Gen 1	Gen 2
'MiniExcel QueryFirst'	0.109 MB	726.4 us	-	-	-
'ExcelDataReader QueryFirst'	15.24 MB	10,664,238.2 us	566000.0000	1000.0000	-
'MiniExcel Query'	17.3 MB	14,179,334.8 us	367000.0000	96000.0000	7000.0000
'ExcelDataReader Query'	17.3 MB	22,565,088.7 us	1210000.0000	2000.0000	-
'Epplus QueryFirst'	1,452 MB	18,198,015.4 us	535000.0000	132000.0000	9000.0000
'Epplus Query'	1,451 MB	23,647,471.1 us	1451000.0000	133000.0000	9000.0000
'OpenXmlSDK Query'	1,412 MB	52,003,270.1 us	978000.0000	353000.0000	11000.0000
'OpenXmlSDK QueryFirst'	1,413 MB	52,348,659.1 us	978000.0000	353000.0000	11000.0000
'ClosedXml QueryFirst'	2,158 MB	66,188,979.6 us	2156000.0000	575000.0000	9000.0000
'ClosedXml Query'	2,184 MB	191,434,126.6 us	2165000.0000	577000.0000	10000.0000

Method	最大記憶體耗用	平均時間	Gen 0	Gen 1	Gen 2
'MiniExcel Create Xlsx'	15 MB	11,531,819.8 us	1020000.0000	-	-
'Epplus Create Xlsx'	1,204 MB	22,509,717.7 us	1370000.0000	60000.0000	30000.0000
'OpenXmlSdk Create Xlsx'	2,621 MB	42,473,998.9 us	1370000.0000	460000.0000	50000.0000
'ClosedXml Create Xlsx'	7,141 MB	140,939,928.6 us	5520000.0000	1500000.0000	80000.0000

Query 查詢 Excel 返回`強型別` IEnumerable 資料 [Try it]

推薦使用 Stream.Query 效率會相對較好。

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<UserAccount>(path);

// or

using (var stream = File.OpenRead(path))
    var rows = stream.Query<UserAccount>();

Query 查詢 Excel 返回`Dynamic` IEnumerable 資料 [Try it]

Key 系統預設為 A,B,C,D...Z

MiniExcel	1
Github	2

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);
}

查詢資料以第一行資料當Key [Try it]

note : 同名以右邊資料為準

Input Excel :

Column1	Column2
MiniExcel	1
Github	2

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);
}

Query 查詢支援延遲載入(Deferred Execution)，能配合LINQ First/Take/Skip辦到低消耗、高效率複雜查詢

Query First

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);
}

建立 Excel 檔案 [Try it]

必須是 non-abstract 類別有 public parameterless constructor
MiniExcel SaveAs 支援 IEnumerable引數``延遲查詢，除非必要請不要使用 ToList 等方法讀取全部資料到記憶體

圖片 : 是否呼叫 ToList 的記憶體差別

Anonymous or strongly type:

var path = Path.Combine(Path.GetTempPath(), $"{Guid.NewGuid()}.xlsx");
MiniExcel.SaveAs(path, new[] {
    new { Column1 = "MiniExcel", Column2 = 1 },
    new { Column1 = "Github", Column2 = 2}
});

Datatable:

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);

Dapper:

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);
}

IEnumerable<IDictionary<string, object>>

var values = new List<Dictionary<string, object>>()
{
    new Dictionary<string,object>{{ "Column1", "MiniExcel" }, { "Column2", 1 } },
    new Dictionary<string,object>{{ "Column1", "Github" }, { "Column2", 2 } }
};
MiniExcel.SaveAs(path, values);

output :

Column1	Column2
MiniExcel	1
Github	2

SaveAs 支援 Stream [Try it]

using (var stream = File.Create(path))
{
    stream.SaveAs(values);
}

Excel Column Name/Ignore Attribute

e.g

input excel :

Test1	Test2	Test3	Test4	Test5	Test6	Column1	Column2
Test1	Test2	Test3	Test4	Test5	Test6	Column1	Column2

public class ExcelAttributeDemo
{
    [ExcelColumnName("Column1")]
    public string Test1 { get; set; }
    [ExcelColumnName("Column2")]
    public string Test2 { get; set; }
    [ExcelIgnore]
    public string Test3 { get; set; }
    public string Test4 { get; set; }
    public string Test5 { get; }
    public string Test6 { get; private set; }
}

var rows = MiniExcel.Query<ExcelAttributeDemo>(path).ToList();
Assert.Equal("Column1", rows[0].Test1);
Assert.Equal("Column2", rows[0].Test2);
Assert.Null(rows[0].Test3);
Assert.Equal("Test4", rows[0].Test4);
Assert.Null(rows[0].Test5);
Assert.Null(rows[0].Test6);

例子 : SQLite & Dapper 讀取大資料新增到資料庫

note : 請不要呼叫 call ToList/ToArray 等方法，這會將所有資料讀到記憶體內

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();
    }
}

效能:

例子 : ASP.NET Core 3.1 or MVC 5 下載 Excel Xlsx API Demo

public class ExcelController : Controller
{
    public IActionResult Download()
    {
        var values = new[] {
            new { Column1 = "MiniExcel", Column2 = 1 },
            new { Column1 = "Github", Column2 = 2}
        };
        var stream = new MemoryStream();
        stream.SaveAs(values);
        return File(stream,
            "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
            "demo.xlsx");
    }
}

Excel 類別自動判斷

MiniExcel 預設會根據副檔名或是 Stream 類別判斷是 xlsx 還是 csv，但會有失準時候，請自行指定。

stream.SaveAs(excelType:ExcelType.CSV);
//or
stream.SaveAs(excelType:ExcelType.XLSX);
//or
stream.Query(excelType:ExcelType.CSV);
//or
stream.Query(excelType:ExcelType.XLSX);

Dynamic Query 轉換 `IDictionary<string,object>` 資料

foreach(IDictionary<string,object> row = MiniExcel.Query(path))
{
    //..
}

侷限與警告

目前不支援 xls (97-2003) 或是加密檔案。
不支援樣式、字型、寬度等修改，因為 MiniExcel 概念是隻專注於值資料，藉此降低記憶體消耗跟提升效率。

參考

讀取邏輯 : ExcelDataReader
API 設計方式 :　StackExchange/Dapper

一個簡單易用高效的工具庫
2019-06-11
一個簡單高效低記憶體的.NET操作Excel開源框架 - MiniExcel
2023-10-26
記憶體Excel框架
用Python做一個簡單的翻譯工具
2020-07-17
Python
【Jeffrey Zhao】不妨來做個嘗試：UpdatePanel for ASP.NET MVC
2008-07-21
ASP.NETMVC
【開源之路】溫蒂、一次簡單的嘗試
2020-11-23
HExcel，一個簡單通用的匯入匯出Excel工具類
2023-10-30
Excel
java 匯出 excel 最佳實踐，java 大檔案 excel 避免OOM(記憶體溢位) excel 工具框架
2018-11-26
JavaExcelOOM記憶體溢位框架
MySQL刪除資料的簡單嘗試
2016-03-04
MySql
簡單又好用的高效工具
2021-04-12
五個值得嘗試的前端開發工具
2014-06-09
前端
go1.18泛型的簡單嘗試
2022-03-16
Go泛型
MySQL 5.5複製升級到5.7的一點簡單嘗試
2017-10-31
MySql
nodeJS做一個簡單的爬蟲
2018-03-30
NodeJS爬蟲
配置簡單功能強大的excel工具類搞定excel匯入匯出工具類(一)
2012-09-22
Excel
相見恨晚的幾個Excel小技巧，簡單實用又高效！
2019-06-19
Excel
Unity嘗試實現簡單的行為樹-01
2020-10-23
Unity
MySQL控制程式碼恢復的簡單嘗試
2017-07-10
MySql
用 Material Design 寫了一個簡單的 API 測試工具
2019-10-18
Material DesignAPI
Laravel 一個簡單的除錯工具
2018-11-05
Laravel除錯
一個簡單的圖片水印工具
2018-02-24
一個簡單的驗證碼工具
2017-11-23
用 Vue 做一個簡單的購物app
2018-04-07
VueAPP
做一個簡單好看的ViewPager翻轉動畫
2017-05-18
Viewpager動畫
用java做一個簡單的二維碼
2017-06-14
Java
MongoDB觸發oom-killer的簡單處理（一)
2015-12-21
MongoDBOOM
避免 OOM，高效匯出百萬級資料的 SpringBoot 實現方案
2023-03-31
OOMSpring Boot
Flutter + Rust 高效能的跨端嘗試
2020-02-15
FlutterRust跨端
一個簡單的介面測試框架 demo
2020-09-06
框架
pdf轉Excel超簡單，你也來試試
2021-02-26
Excel
使用React並做一個簡單的to-do-list
2016-03-22
React
嘗試從零開始構建我的商城 (一) :使用Abp vNext快速一個簡單的商城專案
2020-10-22
利用jmeter做一個簡單的效能測試並進行引數化設定
2017-10-12
JMeter
嘗試 H2o 做機器學習
2022-11-27
機器學習
Python實現簡單的excel對比工具
2021-04-22
PythonExcel
嘗試手寫一個註解框架
2017-11-30
框架
推薦五款簡潔而實用的工具，值得你嘗試
2023-12-29
分享5款簡單而高效的小工具
2023-12-19
一個簡單好用的java增量更新工具
2019-02-22
Java