CsvHelper（Document Manipulation Libraries 一）

一、前言

官方地址：https://joshclose.github.io/CsvHelper/，也可以在NuGet中直接下载。

依赖：

• .NetFramework，Version=v4.5
• .NetFramework，Version=v4.7

注意，.netcore暂不支持。

二、Writing a CSV File

1、一次性写入多行

我们先自定义一个类，将这个类的对象写入csv文件中。

public class Foo
{
    public UInt16 Member1 { get; set; }

    public string Member2 { get; set; }

    public bool Member3 { get; set; }

    public byte[] Member4 { get; set; }
}

需要使用到CsvWriter类，CsvWriter的构造函数需要一个TextWriter对象，我们使用它的派生类StreamWriter。注意，先不要管Member4写入的格式。

    static void Main(string[] args)
    {
        List<Foo> foos = new List<Foo>
        {
            new Foo{ Member1=0x11,Member2="zhanghanyun1",Member3=true,Member4=new byte[]{ 0x22,0x33,0x44} },
             new Foo{ Member1=0x11,Member2="zhanghanyun2",Member3=true,Member4=new byte[]{ 0x22,0x33,0x44} },
              new Foo{ Member1=0x11,Member2="zhanghanyun3",Member3=true,Member4=new byte[]{ 0x22,0x33,0x44} },
        };

        string path = @"test.csv";
        using (StreamWriter sw=new StreamWriter(path))
        {
            using (CsvWriter cw = new CsvWriter(sw,CultureInfo.InvariantCulture))
            {
                cw.WriteRecords<Foo>(foos);
            }
        }
    }

output:
Member1,Member2,Member3,Member4
17,zhanghanyun1,True,0x223344
17,zhanghanyun2,True,0x223344
17,zhanghanyun3,True,0x223344

构造函数中的另一个参数我也不知道会有什么具体的影响。。。。值得一提的是，WriteRecords方法一次性写多行，每一行对应一个对象，并且在第一行自动加上了Header，名称与变量名称一致。

StreamWriter的构造函数中第二个参数，可以设置该文件是否以追加的方式写入。

2、单独写一行

还是将上述代码修改为：

        using (StreamWriter sw=new StreamWriter(path))
        {
            using (CsvWriter cw = new CsvWriter(sw,CultureInfo.InvariantCulture))
            {
                //单独写一行的时候，不会自动添加Header，并且写一行（Header或者数据）都不会自动换行，需要手动换行。
                cw.WriteHeader<Foo>();//写Header
                cw.NextRecord();//写Header后换行
                foreach (var foo in foos)
                {
                    cw.WriteRecord<Foo>(foo);//写一行数据
                    cw.NextRecord();//写一行数据后手动换行
                }
            }
        }

output:
Member1,Member2,Member3,Member4
17,zhanghanyun1,True,0x223344
17,zhanghanyun2,True,0x223344
17,zhanghanyun3,True,0x223344

个人觉得在做数据记录的时候，可能一次只能写一行的可能性比较多。

三、Reading a CSV File

1、一次性读多行

csv file:
Member1,Member2,Member3,Member4
17,zhanghanyun1,True,0x223344
17,zhanghanyun2,True,0x223344
17,zhanghanyun3,True,0x223344

public class Foo
{
    public UInt16 Member1 { get; set; }

    public string Member2 { get; set; }

    public bool Member3 { get; set; }

    public byte[] Member4 { get; set; }
}

        using (StreamReader sr = new StreamReader(path))
        {
            using (CsvReader cr = new CsvReader(sr, CultureInfo.InvariantCulture))
            {
                List<Foo> foo= cr.GetRecords<Foo>().ToList();
            }
        }

会根据属性的名称在csv文件中找对应的列。

那么问题来了，如果csv文件中没有列名称该怎么办？？？

2、csv file中没有列名称

csv file:
17,zhanghanyun1,True,0x223344
17,zhanghanyun2,True,0x223344
17,zhanghanyun3,True,0x223344

这种情况只需要两个步骤：

• 把CsvReader的Configuration.HasHeaderRecord 属性设置为 false（不然会漏掉第一行数据）
• 将Foo属性加上[Index(0)]特性，表示csv中对应的列数

    public class Foo
    {
        [Index(0)]
        public UInt16 Member1 { get; set; }

        [Index(1)]
        public string Member2 { get; set; }

        [Index(2)]
        public bool Member3 { get; set; }

        [Index(3)]
        public byte[] Member4 { get; set; }
    }

        using (StreamReader sr = new StreamReader(path))
        {
            using (CsvReader cr = new CsvReader(sr, CultureInfo.InvariantCulture))
            {
                cr.Configuration.HasHeaderRecord = false;
                List<Foo> foo= cr.GetRecords<Foo>().ToList();
            }
        }

3、csv file中的列Header和属性名称不一致

csv file：
m1,m2,m3,m4
17,zhanghanyun1,True,0x223344
17,zhanghanyun2,True,0x223344
17,zhanghanyun3,True,0x223344

那么就需要将属性加上[Name(“m1”)]特性。

public class Foo
{
    [Name("m1")]
    public UInt16 Member1 { get; set; }

    [Name("m2")]
    public string Member2 { get; set; }

    [Name("m3")]
    public bool Member3 { get; set; }

    [Name("m4")]
    public byte[] Member4 { get; set; }
}

        using (StreamReader sr = new StreamReader(path))
        {
            using (CsvReader cr = new CsvReader(sr, CultureInfo.InvariantCulture))
            {
                List<Foo> foo= cr.GetRecords<Foo>().ToList();
            }
        }

关于给属性添加特性的写法，如果不方便在上面直接加特性，还有另外一种写法，就是需要ClassMap。

public class FooMap : ClassMap<Foo>
{
    public FooMap()
    {
        Map(m => m.Member1).Name("m1");
        Map(m => m.Member2).Name("m2");
        Map(m => m.Member3).Name("m3");
        Map(m => m.Member4).Name("m4");
    }
}

        using (StreamReader sr = new StreamReader(path))
        {
            using (CsvReader cr = new CsvReader(sr, CultureInfo.InvariantCulture))
            {
                cr.Configuration.RegisterClassMap<FooMap>();
                List<Foo> f = cr.GetRecords<Foo>().ToList() ;
            }
        }

其他的特性也可以这样。这中ClassMap在写的时候也是其作用的。

4、读一行

        using (StreamReader sr = new StreamReader(path))
        {
            using (CsvReader cr = new CsvReader(sr, CultureInfo.InvariantCulture))
            {
                cr.Read();
                cr.ReadHeader();//读Header的时候也需要读到下一行。
                while (cr.Read())//是否可以读到下一行
                {
                   Foo f= cr.GetRecord<Foo>();
                }
            }
        }

四、格式转换

最后一个问题就是格式转换，比如是否可以在csv中写入16进制数据，数组类型的数据该怎么存储等问题。

就需要使用到ITypeConverter接口，https://joshclose.github.io/CsvHelper/api/CsvHelper.TypeConversion这里都是它的实现类。

比如使用预定义好的ArrayConverter：

public class FooMap : ClassMap<Foo>
{
    public FooMap()
    {
        Map(m => m.Member1).Name("m1");
        Map(m => m.Member2).Name("m2");
        Map(m => m.Member3).Name("m3");
        Map(m => m.Member4).Name("m4").TypeConverter<ArrayConverter>();
    }
}

        using (StreamWriter sw = new StreamWriter(path))
        {
            using (CsvWriter cw = new CsvWriter(sw, CultureInfo.InvariantCulture))
            {
                cw.Configuration.RegisterClassMap<FooMap>();
                cw.WriteRecords<Foo>(foos);
            }
        }

output：
m1,m2,m3,m4
17,zhanghanyun1,True,34,51,68
17,zhanghanyun2,True,34,51,68
17,zhanghanyun3,True,34,51,68

这样写入的话，把数组给拆开放在不同的列了，那么在读取的时候是会有问题的。这种写法同样可以使用特性标注。

public class Foo
{
    public UInt16 Member1 { get; set; }

    public string Member2 { get; set; }

    public bool Member3 { get; set; }

    [TypeConverter(typeof(ArrayConverter))]
    public byte[] Member4 { get; set; }
}

最后，当然也可以自定义一个TypeConverter。举例一个十六进制字符串的。

public class DecimalToHexConverter : ITypeConverter
{
    public object ConvertFromString(string text, IReaderRow row, MemberMapData memberMapData)
    {
       return (UInt16)Convert.ToUInt16(text, 16);
    }

    public string ConvertToString(object value, IWriterRow row, MemberMapData memberMapData)
    {
        if (value is UInt16 t)
        {
            return "0x" + t.ToString("x4");
        }
        return "";
    }
}

public class FooMap : ClassMap<Foo>
{
    public FooMap()
    {
        Map(m => m.Member1).Name("m1").TypeConverter<DecimalToHexConverter>();
        Map(m => m.Member2).Name("m2");
        Map(m => m.Member3).Name("m3");
        Map(m => m.Member4).Name("m4");
    }
}

        using (StreamWriter sw = new StreamWriter(path))
        {
            using (CsvWriter cw = new CsvWriter(sw, CultureInfo.InvariantCulture))
            {
                cw.Configuration.RegisterClassMap<FooMap>();
                cw.WriteRecords<Foo>(foos);
            }
        }

        using (StreamReader sr = new StreamReader(path))
        {
            using (CsvReader cr = new CsvReader(sr, CultureInfo.InvariantCulture))
            {
                cr.Configuration.RegisterClassMap<FooMap>();
                List<Foo> f = cr.GetRecords<Foo>().ToList();

            }
        }

output:
m1,m2,m3,m4
0x0011,zhanghanyun1,True,0x223344
0x0011,zhanghanyun2,True,0x223344
0x0011,zhanghanyun3,True,0x223344