Excel导出是非常常见的需求,而大多数时候只需要导出CSV格式文件即可。Csv文件非常简单以及快速,除了日常导出报表,还可以导出大量数据用于跨系统数据交换,曾经多次遇到一次性导出数百万行数据。NewLife.Core 内封装了CsvFile类,用于Csv格式文件读写,同时支持输出到Http响应流。魔方的导出功能就是由CsvFile类提供支持。
Nuget包:NewLife.Core
源码地址:https://github.com/NewLifeX/X/blob/master/NewLife.Core/IO/CsvFile.cs
写入文件
Csv文件第一行一般是头部字段名,也有部分场合不需要头部字段名。
CsvFile 提供了 WriteLine/WriteAll 作为写入接口,可以WriteLine写入头部或一行数据,也可以WriteAll写入一批数据。
示例如下:
var file = "data/test.csv";
var list = new List<Object[]>
{
new Object[] { 1234, "Stone", true, DateTime.Now },
new Object[] { 5678, "NewLife", false, DateTime.Today }
};
{
using var csv = new CsvFile(file, true);
csv.Separator = ',';
csv.Encoding = Encoding.UTF8;
csv.WriteLine(new[] { "Code", "Name", "Enable", "CreateTime" });
csv.WriteAll(list);
}
var lines = File.ReadAllLines(file.GetFullPath());
Assert.Equal(3, lines.Length);
Assert.Equal("Code,Name,Enable,CreateTime", lines[0]);
Assert.Equal($"1234,Stone,1,{((DateTime)list[0][3]).ToFullString()}", lines[1]);
Assert.Equal($"5678,NewLife,0,{((DateTime)list[1][3]).ToFullString()}", lines[2]);
读取文件
Csv读取时,也要区分第一行是否头部字段名。
CsvFile统一提供了 ReadLine/ReadAll 来读取头部或者数据。
示例如下:
using var csv = new CsvFile(file);
var headers = csv.ReadLine();
var all = csv.ReadAll();
Assert.Equal(4, headers.Length);
Assert.Equal("Code", headers[0]);
Assert.Equal("Name", headers[1]);
Assert.Equal(2, all.Length);