如何在 Asp.Net Core 实现 Excel 导出功能

在web应用程序开发时，或许你会遇到这样的需求，如何在 Asp.Net Core 中实现 excel 或者 word 的导入导出，在 NuGet 上有大量的工具包可以实现这样的功能，本篇就讨论下如何使用 ClosedXML 实现 Excel 数据导出。

安装 ClosedXML

如果想实现 Excel 的导出功能，在 Asp.Net Core 中有很多的dll可以做到，其中的一个叫做 ClosedXML，你可以通过可视化界面 NuGet package manager 去安装，也可以使用命令行 NuGet package manager console 执行下面命令。


Install-Package ClosedXML

将数据导出成 CSV 文件

将数据导成 CSV 文件是非常简单的，毕竟每行数据都是用 , 隔开即可，可以用 NuGet 上的 CsvExport 或者 AWright18.SimpleCSVExporter 去实现，当然你觉得自己很 ????????，可以亲自操刀实现，下面我准备亲自实现一下，先看下面定义的 Author 类。


public class Author
{
  public int Id { get; set; }
  public string FirstName { get; set; }
  public string LastName { get; set; }
}

然后塞一些数据到 authors 列表中，如下代码所示：


List<Author> authors = new List<Author>
{
    new Author { Id = 1, FirstName = "Joydip", LastName = "Kanjilal" },
    new Author { Id = 2, FirstName = "Steve", LastName = "Smith" },
    new Author { Id = 3, FirstName = "Anand", LastName = "Narayaswamy"}
};

定义一个 DownloadCommaSeperatedFile 方法，用于实现 Action 的 csv 导出功能。


public IActionResult DownloadCommaSeperatedFile()
{
    try
    {
       StringBuilder stringBuilder = new StringBuilder();
       stringBuilder.AppendLine("Id,FirstName,LastName");
       foreach (var author in authors)
       {
           stringBuilder.AppendLine($"{author.Id},
           {author.FirstName},{author.LastName}");
       }
      return File(Encoding.UTF8.GetBytes
      (stringBuilder.ToString()), "text/csv", "authors.csv");
    }
    catch
    {
       return Error();
    }
}

将数据导出成 XLSX 文件

Excel 中的 workbook 是由若干个 worksheet 组成，下面的代码可用来生成一个 workbook。


var workbook = new XLWorkbook();

接下来生成一个 worksheet，然后在 worksheet 中填一些数据，代码如下：


IXLWorksheet worksheet = workbook.Worksheets.Add("Authors");
worksheet.Cell(1, 1).Value = "Id";
worksheet.Cell(1, 2).Value = "FirstName";
worksheet.Cell(1, 3).Value = "LastName";
for (int index = 1; index <= authors.Count; index++)
{
   worksheet.Cell(index + 1, 1).Value = authors[index - 1].Id;
   worksheet.Cell(index + 1, 2).Value = authors[index - 1].FirstName;
   worksheet.Cell(index + 1, 3).Value = authors[index - 1].LastName;
}

最后，将 workbook 转成内存流 (memory stream) 再通过 Controller.Action 的 FileContentResult 返回给客户端，代码如下：


using (var stream = new MemoryStream())
{
     workbook.SaveAs(stream);
     var content = stream.ToArray();
     return File(content, contentType, fileName);
}

下载 Excel

下面是导出 Excel 所有的业务逻辑代码，这个 Action 实现了 Excel 导出功能。


        public IActionResult DownloadExcelDocument()
        {
            string contentType = "application/vnd.openxmlformats-
            officedocument.spreadsheetml.sheet";
            string fileName = "authors.xlsx";
            try
            {
                using (var workbook = new XLWorkbook())
                {
                    IXLWorksheet worksheet =
                    workbook.Worksheets.Add("Authors");
                    worksheet.Cell(1, 1).Value = "Id";
                    worksheet.Cell(1, 2).Value = "FirstName";
                    worksheet.Cell(1, 3).Value = "LastName";
                    for (int index = 1; index <= authors.Count; index++)
                    {
                        worksheet.Cell(index + 1, 1).Value =
                        authors[index - 1].Id;
                        worksheet.Cell(index + 1, 2).Value =
                        authors[index - 1].FirstName;
                        worksheet.Cell(index + 1, 3).Value =
                        authors[index - 1].LastName;
                    }
                    using (var stream = new MemoryStream())
                    {
                        workbook.SaveAs(stream);
                        var content = stream.ToArray();
                        return File(content, contentType, fileName);
                    }
                }
            }
            catch(Exception ex)
            {
                return Error();
            }
        }

这篇就是 ClosedXML 的所有内容，如果你想对 Excel 中的数据进行更加复杂的操控，可以使用 EPPlus 或者 NPOI，关于 ClosedXML 的更多内容，可参考：https://github.com/ClosedXML/ClosedXML