WeihanLi.Npoi 1.13.0 更新日志

WeihanLi.Npoi 1.13.0 更新日志

Intro

在 Github 上收到 Issue 收到网友反馈但愿支持自动分 Sheet 导出，有兴趣的能够参考 Issue https://github.com/WeihanLi/WeihanLi.Npoi/issues/94

从我我的角度来讲，我以为若是要导出很大批量的数据，能够导出 csv 文件，没有必要非得导出 Excel 文件，毕竟如今机器学习数据训练等不少都是用的 csv，并且 csv 的格式简单，更方便导出，导出性能会Excel更好更高效。

不过有些场景可能必需要用 Excel，因此想了一下仍是加一下这个功能吧，目前支持 List 或 DataTable 直接导出 Excel

使用示例

使用起来比较简单，和以前的使用并无什么不一样，能够参考下面的单元测试：

List 自动分 Sheet 导出：

[Theory]
[InlineData(ExcelFormat.Xls, 1000, 1)]
[InlineData(ExcelFormat.Xls, 65536, 2)]
[InlineData(ExcelFormat.Xls, 132_000, 3)]
//[InlineData(ExcelFormat.Xls, 1_000_000, 16)]
//[InlineData(ExcelFormat.Xlsx, 1_048_576, 2)]
public void EntityListAutoSplitSheetsTest(ExcelFormat excelFormat, int rowsCount, int expectedSheetCount)
{
    var list = Enumerable.Range(1, rowsCount)
        .Select(x => new Notice()
        {
            Id = x,
            Content = $"content_{x}",
            Title = $"title_{x}",
            Publisher = $"publisher_{x}"
        })
        .ToArray();

    var bytes = list.ToExcelBytes(excelFormat);
    var workbook = ExcelHelper.LoadExcel(bytes, excelFormat);
    Assert.Equal(expectedSheetCount, workbook.NumberOfSheets);
}

DataTable 自动分 Sheet 导出：

[Theory]
[InlineData(ExcelFormat.Xls, 1000, 1)]
[InlineData(ExcelFormat.Xls, 65536, 2)]
[InlineData(ExcelFormat.Xls, 132_000, 3)]
//[InlineData(ExcelFormat.Xls, 1_000_000, 16)]
//[InlineData(ExcelFormat.Xlsx, 1_048_576, 2)]
public void DataTableAutoSplitSheetsTest(ExcelFormat excelFormat, int rowsCount, int expectedSheetCount)
{
    var dataTable = new DataTable();
    dataTable.Columns.Add(new DataColumn("Id", typeof(int)));
    for (var i = 0; i < rowsCount; i++)
    {
        var row = dataTable.NewRow();
        row.ItemArray = new object[]
        {
            i+1
        };
        dataTable.Rows.Add(row);
    }
    Assert.Equal(rowsCount, dataTable.Rows.Count);
    var bytes = dataTable.ToExcelBytes(excelFormat);
    var workbook = ExcelHelper.LoadExcel(bytes, excelFormat);
    Assert.Equal(expectedSheetCount, workbook.NumberOfSheets);
}

More

除了上面的示例，还提供了两个扩展方法 GetWorkbookWithAutoSplitSheet<TEntity>(this IList<TEntity> entityList, ExcelFormat excelFormat)/GetWorkbookWithAutoSplitSheet(this DataTable dataTable, ExcelFormat excelFormat, ExcelSetting excelSetting = null) 来获取自动分 Sheet 以后的 IWorkbook，进行进一步的自定义操做。

其余的操做方式和以前彻底同样，能够直接导出文件，字节数组，或者写入到指定 Stream 里

void ToExcelFile<TEntity>(this IList<TEntity> entityList, string excelPath);

byte[] ToExcelBytes<TEntity>(this IList<TEntity> entityList, ExcelFormat excelFormat = ExcelFormat.Xls);

void ToExcelStream<TEntity>(this IList<TEntity> entityList, Stream stream, ExcelFormat excelFormat = ExcelFormat.Xls);

详细变动能够参考 PR： https://github.com/WeihanLi/WeihanLi.Npoi/pull/96/files

Reference

• https://github.com/WeihanLi/WeihanLi.Npoi/issues/94
• https://github.com/WeihanLi/WeihanLi.Npoi/blob/dev/test/WeihanLi.Npoi.Test/ExcelTest.cs#L625
• https://github.com/WeihanLi/WeihanLi.Npoi/pull/96
• https://weihanli.github.io/WeihanLi.Npoi/docs/api/WeihanLi.Npoi.NpoiExtensions.html