使用 csvWriter.WriteRecords 为 CSV 文件自定义标头

在使用 C# 编写读取或写入 CSV 文件的程序时，我们经常需要在文件的开头添加一个标头行来指明每一列数据的含义。CSVHelper 是一个流行的开源库，它提供了一个 csvWriter.WriteRecords 方法，可以帮助我们快速地写入数据到 CSV 文件。但是，它默认的行为是将数据的属性名作为标头行的内容，而我们可能需要为数据自定义一个不同的标头行。本文将介绍如何使用 csvWriter.WriteRecords 方法自定义 CSV 文件的标头行。

Step 1: 创建一个包含标头行的字符串列表

我们可以使用 C# 中的 List<string> 类型来存储 CSV 文件的标头行。首先，定义一个字符串列表变量，并将要写入文件的标头行添加到该列表中。

List<string> headers = new List<string>();
headers.Add("列1名称");
headers.Add("列2名称");
headers.Add("列3名称");

Step 2: 创建 CsvWriter 对象

使用 CSVHelper 库，我们需要创建一个 CsvWriter 对象来将数据写入 CSV 文件中。CsvWriter 可以通过 StreamWriter 对象的构造函数来创建。同时，我们还需要为 CsvWriter 指定 CSV 文件的配置，例如分隔符、引号等等。

CsvConfiguration config = new CsvConfiguration(CultureInfo.InvariantCulture)
{
    Delimiter = ",",
    HasHeaderRecord = true,
    Quote = '"',
    QuoteAllFields = true
};

using (StreamWriter sw = new StreamWriter("output.csv"))
{
    using (CsvWriter writer = new CsvWriter(sw, config))
    {
        // 向 CSV 文件写入标头行
        writer.WriteRecords(headers);
        // 写入数据行
        writer.WriteRecords(data);
    }
}

注意，我们将 HasHeaderRecord 属性设置为 true，表示我们希望 CSVHelper 库在写入数据前自动添加标头行。

Step 3: 写入数据行

在完成了标头行的写入后，我们可以继续使用 writer.WriteRecords 方法将数据写入 CSV 文件中。

List<MyData> data = GetData();
// 写入数据行
writer.WriteRecords(data);

这里的 GetData 方法返回一个包含数据的 List<MyData> 对象。

完整的示例代码

下面是一个完整的示例代码，展示了如何使用 csvWriter.WriteRecords 方法为 CSV 文件自定义标头行。

using System.Collections.Generic;
using System.Globalization;
using System.IO;
using CsvHelper;
using CsvHelper.Configuration;

public class MyData
{
    public int Column1 { get; set; }
    public string Column2 { get; set; }
    public bool Column3 { get; set; }
}

public static class CsvWriterDemo
{
    public static void WriteToCsv()
    {
        List<string> headers = new List<string>();
        headers.Add("列1名称");
        headers.Add("列2名称");
        headers.Add("列3名称");

        List<MyData> data = GetData();

        CsvConfiguration config = new CsvConfiguration(CultureInfo.InvariantCulture)
        {
            Delimiter = ",",
            HasHeaderRecord = true,
            Quote = '"',
            QuoteAllFields = true
        };

        using (StreamWriter sw = new StreamWriter("output.csv"))
        {
            using (CsvWriter writer = new CsvWriter(sw, config))
            {
                // 向 CSV 文件写入标头行
                writer.WriteRecords(headers);
                // 写入数据行
                writer.WriteRecords(data);
            }
        }
    }

    private static List<MyData> GetData()
    {
        List<MyData> data = new List<MyData>();
        data.Add(new MyData { Column1 = 1, Column2 = "abc", Column3 = true });
        data.Add(new MyData { Column1 = 2, Column2 = "def", Column3 = false });
        data.Add(new MyData { Column1 = 3, Column2 = "xyz", Column3 = true });
        return data;
    }
}