LOGO OA教程 ERP教程 模切知识交流 PMS教程 CRM教程 开发文档 其他文档  
 
网站管理员

C#.NET操作Excel高效低内存的开源框架 - MiniExcel

admin
2023年9月7日 17:16 本文热度 1262

.Net平台上对Excel进行操作主要有两种方式。第一种,把Excel文件看成一个数据库,通过OleDb的方式进行读取与操作;第二种,调用Excel的COM组件。两种方式各有特点。

今天给大家介绍第三种方式:插件方式,目前主流框架大多需要将数据全载入到内存方便操作,但这会导致内存消耗问题,MiniExcel 尝试以 Stream 角度写底层算法逻辑,能让原本1000多MB占用降低到几MB,避免内存不够情况。

MiniExcel简单、高效避免OOM的.NET处理Excel查、写、填充数据工具。

特点

  • 低内存耗用,避免OOM、频繁 Full GC 情况

  • 支持即时操作每行数据

  • 兼具搭配 LINQ 延迟查询特性,能办到低消耗、快速分页等复杂查询

  • 轻量,不需要安装 Microsoft Office、COM+,DLL小于150KB

  • 简便操作的 API 风格

性能比较、测试

导入、查询 Excel 比较

逻辑 : 以 Test1,000,000x10.xlsx 做基准与主流框架做性能测试,总共 1,000,000 行 * 10 列笔 "HelloWorld",文件大小 23 MB。

导出、创建 Excel 比较

逻辑 : 创建1千万笔 "HelloWorld"


使用示例

1、读/导入 Excel

1.1 Query 查询 Excel 返回强型别 IEnumerable 数据

1.    public class UserAccount

2.    {

3.    public Guid ID { getset; }

4.    public string Name { getset; }

5.    public DateTime BoD { getset; }

6.    public int Age { getset; }

7.    public bool VIP { getset; }

8.    public decimal Points { getset; }

9.    }

10.  var rows = MiniExcel.Query<UserAccount>(path);

11.  // or

12.  using (var stream = File.OpenRead(path))

13.  var rows = stream.Query<UserAccount>();


1.2 Query 查询支援延迟加载(Deferred execution),能配合LINQ First/Take/Skip办到低消耗、高效率复杂查询

1. var row = MiniExcel.Query(path).First();

2. Assert.Equal("HelloWorld", row.A);

3. // or

4. using (var stream = File.OpenRead(path))

5. {

6. var row = stream.Query().First();

7. Assert.Equal("HelloWorld", row.A);

8. }

与其他框架效率比较


1.3 读取大文件硬盘缓存 (Disk-Base Cache - SharedString)

概念 : MiniExcel 当判断文件 SharedString 大小超过 5MB,预设会使用本地缓存,如 10x100000.xlsx(一百万笔数据),读取不开启本地缓存需要最高内存使用约195MB,开启后降为65MB。但要特别注意,此优化是以时间换取内存减少,所以读取效率会变慢,此例子读取时间从 7.4 秒提高到 27.2 秒,假如不需要能用以下代码关闭硬盘缓存

1. var config = new OpenXmlConfiguration { EnableSharedStringCache = false };

2. MiniExcel.Query(path,configuration: config)

也能使用 SharedStringCacheSize 调整 sharedString 文件大小超过指定大小才做硬盘缓存

1. var config = new OpenXmlConfiguration { SharedStringCacheSize=500*1024*1024 };

2. MiniExcel.Query(path, configuration: config);


2、写/导出 Excel

  1. 必须是非abstract 类别有公开无参数构造函数

  2. MiniExcel SaveAs 支援 IEnumerable参数延迟查询,除非必要请不要使用 ToList 等方法读取全部数据到内存

2.1 支持集合<匿名类别>或是<强型别>

var path = Path.Combine(Path.GetTempPath(), $"{Guid.NewGuid()}.xlsx");

MiniExcel.SaveAs(path, new[] {

    new { Column1 = "MiniExcel", Column2 = 1 },

    new { Column1 = "Github", Column2 = 2}

});

2.2 IDataReader

  • 推荐使用,可以避免载入全部数据到内存



    推荐 DataReader 多表格导出方式(建议使用 Dapper executeReader )


·         using (var cnn = Connection)

·         {

·         cnn.Open();

·         var sheets = new Dictionary<string,object>();

·         sheets.Add("sheet1", cnn.executeReader("select 1 id"));

·         sheets.Add("sheet2", cnn.executeReader("select 2 id"));

·         MiniExcel.SaveAs("Demo.xlsx", sheets);

·         }

3、模板填充 Excel

  • 宣告方式类似 Vue 模板 {{变量名称}}, 或是集合渲染 {{集合名称.栏位名称}}

  • 集合渲染支持 IEnumerable/DataTable/DapperRow


3.1 基本填充

1.  // 1. By POCO

2.  var value = new

3.  {

4.      Name = "Jack",

5.      createDate = new DateTime(2021, 01, 01),

6.      VIP = true,

7.      Points = 123

8.  };

9.  MiniExcel.SaveAsByTemplate(path, templatePath, value);

1.  // 2. By Dictionary

2.  var value = new Dictionary<string, object>()

3.  {

4.      ["Name"] = "Jack",

5.      ["createDate"] = new DateTime(2021, 01, 01),

6.      ["VIP"] = true,

7.      ["Points"] = 123

8.  };

9.  MiniExcel.SaveAsByTemplate(path, templatePath, value);


3.2 复杂数据填充

1.    // 1By POCO

2.    var value = new

3.    {

4.    title = "FooCompany",

5.    managers = new[] {

6.    new {name="Jack",department="HR"},

7.    new {name="Loan",department="IT"}

8.    },

9.    employees = new[] {

10.  new {name="Wade",department="HR"},

11.  new {name="Felix",department="HR"},

12.  new {name="Eric",department="IT"},

13.  new {name="Keaton",department="IT"}

14.  }

15.  };

16.  MiniExcel.SaveAsByTemplate(path, templatePath, value);

  1. 1.  // 2By Dictionary

  2. 2.  var value = new Dictionary<stringobject>()

  3. 3.  {

  4. 4.  ["title"] = "FooCompany",

  5. 5.  ["managers"] = new[] {

  6. 6.  new {name="Jack",department="HR"},

  7. 7.  new {name="Loan",department="IT"}

  8. 8.  },

  9. 9.  ["employees"] = new[] {

  10. 10. new {name="Wade",department="HR"},

  11. 11. new {name="Felix",department="HR"},

  12. 12. new {name="Eric",department="IT"},

  13. 13. new {name="Keaton",department="IT"}

  14. 14. }

  15. 15. };

  16. 16. MiniExcel.SaveAsByTemplate(path, templatePath, value);


4、Excel 列属性 (Excel Column Attribute)

4.1 指定列名称、指定第几列、是否忽略该列

1.    public class ExcelAttributeDemo

2.    {

3.    [ExcelColumnName("Column1")]

4.    public string Test1 { getset; }

5.    [ExcelColumnName("Column2")]

6.    public string Test2 { getset; }

7.    [ExcelIgnore]

8.    public string Test3 { getset; }

9.    [ExcelColumnIndex("I")] // 系统会自动转换"I"为第8

10.  public string Test4 { getset; }

11.  public string Test5 { get; } //系统会忽略此列

12.  public string Test6 { get; private set; } //set非公开,系统会忽略

13.  [ExcelColumnIndex(3)] // 0开始索引

14.  public string Test7 { getset; }

15.  }

  1. 1. var rows = MiniExcel.Query<ExcelAttributeDemo>(path).ToList();

  2. 2. Assert.Equal("Column1", rows[0].Test1);

  3. 3. Assert.Equal("Column2", rows[0].Test2);

  4. 4. Assert.Null(rows[0].Test3);

  5. 5. Assert.Equal("Test7", rows[0].Test4);

  6. 6. Assert.Null(rows[0].Test5);

  7. 7. Assert.Null(rows[0].Test6);

  8. 8. Assert.Equal("Test4", rows[0].Test7);


4.2 DynamicColumnAttribute 动态设定 Column

1.    var config = new OpenXmlConfiguration

2.    {

3.    DynamicColumns = new DynamicExcelColumn[] {

4.    new DynamicExcelColumn("id"){Ignore=true},

5.    new DynamicExcelColumn("name"){Index=1,Width=10},

6.    new DynamicExcelColumn("createdate"){Index=0,Format="yyyy-MM-dd",Width=15},

7.    new DynamicExcelColumn("point"){Index=2,Name="Account Point"},

8.    }

9.    };

10.  var path = PathHelper.GetTempPath();

11.  var value = new[] { new { id = 1, name = "Jack", createdate = new DateTime(20220412) ,point = 123.456} };

12.  MiniExcel.SaveAs(path, valueconfiguration: config);


Excel 类别自动判断

  • MiniExcel 预设会根据文件扩展名判断是 xlsx 还是 csv,但会有失准时候,请自行指定。

  • Stream 类别无法判断来源于哪种 excel 请自行指定

  • 1.  stream.SaveAs(excelType:ExcelType.CSV);

  • 2.  //or

  • 3.  stream.SaveAs(excelType:ExcelType.XLSX);

  • 4.  //or

  • 5.  stream.Query(excelType:ExcelType.CSV);

  • 6.  //or

  • 7.  stream.Query(excelType:ExcelType.XLSX);


该文章在 2023/9/7 17:26:42 编辑过
关键字查询
相关文章
正在查询...
点晴ERP是一款针对中小制造业的专业生产管理软件系统,系统成熟度和易用性得到了国内大量中小企业的青睐。
点晴PMS码头管理系统主要针对港口码头集装箱与散货日常运作、调度、堆场、车队、财务费用、相关报表等业务管理,结合码头的业务特点,围绕调度、堆场作业而开发的。集技术的先进性、管理的有效性于一体,是物流码头及其他港口类企业的高效ERP管理信息系统。
点晴WMS仓储管理系统提供了货物产品管理,销售管理,采购管理,仓储管理,仓库管理,保质期管理,货位管理,库位管理,生产管理,WMS管理系统,标签打印,条形码,二维码管理,批号管理软件。
点晴免费OA是一款软件和通用服务都免费,不限功能、不限时间、不限用户的免费OA协同办公管理系统。
Copyright 2010-2024 ClickSun All Rights Reserved