技术解答CSV 文件的一个 .NET 库：CsvHelper 中文文档

概述技术解答CSV 文件的一个 .NET 库：CsvHelper 中文文档 CsvHelper 是读写 CSV 文件的一个 .NET 库。可以通过 Visual Studio 的包管理器下载 CsvHelper。自动映射定义：没有提供映射文件的情况下，默认为自动映射，自动映射会按顺序依次映射到类的属性中去。

GitHub 地址

读取读取所有的记录

var csv = new CsvReader( textReader );var records = csv.GetRecords<MyClass>(); // 把 CSV 记录映射到 MyClass，返回的 records 是个 IEnumerable<T> 对象

如果想要自定义映射关系，可以看下面映射一节。
由于 records 是个 IEnumerable<T> 对象，因此仅当访问的时候才会返回一个记录，访问一次就返回一个记录。如果想要想列表那样访问，可以作如下处理：

var csv = new CsvReader( textReader );var records = csv.GetRecords<MyClass>().ToList();

手动读取记录

可以按行循环读取每一行的数据

var csv = new CsvReader( textReader );while( csv.Read() ){    var record = csv.GetRecord<MyClass>();}

读取单独的字段

var csv = new CsvReader( textReader );while( csv.Read() ){    var intFIEld = csv.GetFIEld<int>( 0 );    var stringFIEld = csv.GetFIEld<string>( 1 );    var boolFIEld = csv.GetFIEld<bool>( "headername" );}

如果读取的类型跟预期的可能会不同，那么可以用 TryGetFIEld

var csv = new CsvReader( textReader );while( csv.Read() ){    int intFIEld;    if( !csv.TryGetFIEld( 0, out intFIEld ) )    {        // Do something when it can't convert.    }}

解析

想要每一行作为一个字符串返回可以使用 CsvParser 。

var parser = new CsvParser( textReader );while( true ){    var row = parser.Read(); // row 是个字符串    if( row == null )    {        break;    }}

写入写入所有记录

var csv = new CsvWriter( textWriter );csv.WriteRecords( records );

var csv = new CsvWriter( textWriter );foreach( var item in List ){    csv.WriteRecord( item );}

var csv = new CsvWriter( textWriter );foreach( var item in List ){    csv.WriteFIEld( "a" );    csv.WriteFIEld( 2 );    csv.WriteFIEld( true );    csv.NextRecord();}

映射自动映射

没有提供映射文件的情况下，默认为自动映射，自动映射会按顺序依次映射到类的属性中去。如果属性是一个自定义类，那么会继续依次按照这个自定义类的属性进行填入。如果出现了循环引用，那么自动映射会停止。

手动映射

如果 CSV 文件和自定义的类并不是完全的匹配，那么可以定义一个匹配类来处理。

public sealed class MyClassMap : CsvClassMap<MyClass>{    public MyClassMap()    {        Map( m => m.ID );        Map( m = > m.name );    }}

本文由 tangyikejun 翻译

引用映射

如果属性是一个自定义类，对应于CSV文件的多个列，那么可以使用引用映射。

public sealed class PersonMap : CsvClassMap<Person>{    public PersonMap()    {        Map( m => m.ID );        Map( m => m.name );        References<AddressMap>( m => m.Address );    }}public sealed class AddressMap : CsvClassMap<Address>{    public AddressMap()    {        Map( m => m.Street );        Map( m => m.City );        Map( m => m.State );        Map( m => m.Zip );    }}

下标指定

可以通过列下标指定映射

public sealed class MyClassMap : CsvClassMap<MyClass>{    public MyClassMap()    {        Map( m => m.ID ).Index( 0 );        Map( m => m.name ).Index( 1 );    }}

列名指定

也可以通过列名指定映射，这要求csv文件有一个头记录，也就是说第一行记录列名

public sealed class MyClassMap : CsvClassMap<MyClass>{    public MyClassMap()    {        Map( m => m.ID ).name( "The ID Column" );        Map( m => m.name ).name( "The name Column" );    }}

同名处理

public sealed class MyClassMap : CsvClassMap<MyClass>{    public MyClassMap()    {        Map( m => m.Firstname ).name( "name" ).nameIndex( 0 );        Map( m => m.Lastname ).name( "name" ).nameIndex( 1 );    }}

默认值

public sealed class MyClassMap : CsvClassMap<MyClass>{    public overrIDe voID MyClassMap()    {        Map( m => m.ID ).Index( 0 ).Default( -1 );        Map( m => m.name ).Index( 1 ).Default( "UnkNown" );    }}

类型转换

public sealed class MyClassMap : CsvClassMap<MyClass>{    public MyClassMap()    {        Map( m => m.ID ).Index( 0 ).TypeConverter<MyIDConverter>();    }}

可选类型转换

默认的转换器会处理大部分的类型转换，但是有时候我们可能需要做一些小的改变，这个时候可以尝试是用可选类型转换。

public sealed class MyClassMap : CsvClassMap<MyClass>{    public MyClassMap()    {        Map( m => m.Description ).Index( 0 ).TypeConverterOption( CultureInfo.InvariantCulture ); //         Map( m => m.TimeStamp ).Index( 1 ).TypeConverterOption( DateTimeStyles.AdjustToUniversal ); // 时间格式转换        Map( m => m.Cost ).Index( 2 ).TypeConverterOption( NumberStyles.Currency ); // 数值类型转换        Map( m => m.CurrencyFormat ).Index( 3 ).TypeConverterOption( "C" );        Map( m => m.BooleanValue ).Index( 4 ).TypeConverterOption( true, "sure" ).TypeConverterOption( false, "nope" ); // 内容转换    }}

ConvertUsing

public sealed class MyClassMap : CsvClassMap<MyClass>{    public MyClassMap()    {        // 常数        Map( m => m.Constant ).ConvertUsing( row => 3 );        // 把两列聚合在一起        Map( m => m.Aggregate ).ConvertUsing( row => row.GetFIEld<int>( 0 ) + row.GetFIEld<int>( 1 ) );        // Collection with a single value.        Map( m => m.names ).ConvertUsing( row => new List<string>{ row.GetFIEld<string>( "name" ) } );        // Just about anything.        Map( m => m.Anything ).ConvertUsing( row =>        {            // You can do anything you want in a block.            // Just make sure to return the same type as the property.        } );    }}

运行时映射

可以在运行时创建映射。

var customerMap = new DefaultCsvClassMap();// mapPing holds the Property - csv column mapPing foreach( string key in mapPing.Keys ){    var columnname = mapPing[key].ToString();    if( !String.IsNullOrEmpty( columnname ) )    {        var propertyInfo = typeof( Customer ).GetType().GetProperty( key );        var newMap = new CsvPropertyMap( propertyInfo );        newMap.name( columnname );        customerMap.PropertyMaps.Add( newMap );    }}csv.Configuration.RegisterClassMap(CustomerMap);

本文由 tangyikejun 翻译

配置允许注释

// Default valuecsv.Configuration.AllowComments = false;

自动映射

var generatedMap = csv.Configuration.autoMap<MyClass>();

缓存

TextReader 或 TextWriter 中读写的缓存

// Default valuecsv.Configuration.BufferSize = 2048;

注释

被注释掉的那行不会被加载进来

// Default valuecsv.Configuration.Comment = '#';

Byte 计数

记录当前读取了多少 Byte 了，需要设置 Configuration.EnCoding 与 CSV 文件一致。这个设置会影响解析的速度。

// Default valuecsv.Configuration.CountBytes = false;

Culture 信息

// Default valuecsv.Configuration.CultureInfo = CultureInfo.CurrentCulture;

分割符

// Default valuecsv.Configuration.Delimiter = ",";

列数变化

如果开启，发现列数变化会抛出 CsvBadDataException

// Default valuecsv.Configuration.DetectColumnCountChanges = false;

编码

// Default valuecsv.Configuration.EnCoding = EnCoding.UTF8;

是否有头记录

// Default valuecsv.Configuration.HasheaderRecord = true;

忽略列名空格

是否忽略列名中的空格

// Default valuecsv.Configuration.IgnoreheaderWhiteSpace = false;

忽略私有访问

读写的时候是否忽略私有访问器

// Default valuecsv.Configuration.IgnorePrivateAccessor = false;

忽略读取异常

读取发生异常之后仍继续读取

// Default valuecsv.Configuration.IgnoreReadingExceptions = false;

忽略引号

不把引号作为转义符

// Default valuecsv.Configuration.IgnoreQuotes = false;

列名是否大小写敏感

// Default valuecsv.Configuration.IsheaderCaseSensitive = true;

映射访问

可以对自定义的类映射进行访问

var myMap = csv.Configuration.Maps[typeof( MyClass )];

属性绑定标记

用来寻找自定义类的属性

// Default valuecsv.Configuration.PropertyBindingFlags = BindingFlags.Public | BindingFlags.Instance;

本文由 tang yi ke jun 翻译

Quote

定义用来转义包含分隔符，括号或者行尾的转义符

// Default valuecsv.Configuration.Quote = '"';

所有字段加引号

写入csv的时候是否对所有字段加引号。QuoteallFIElds 和 QuoteNoFIElds 不能同时为 true 。

// Default valuecsv.Configuration.QuoteallFIElds = false;

所有字段不加引号

QuoteallFIElds 和 QuoteNoFIElds 不能同时为 true 。

// Default valuecsv.Configuration.QuoteNoFIElds = false;

读取异常的回调

csv.Configuration.ReadingExceptionCallback = ( ex, row ) =>{    // Log the exception and current row information.};

注册类映射

使用了类映射的话，需要进行注册才会被实际使用到。

csv.Configuration.RegisterClassMap<MyClassMap>();csv.Configuration.RegisterClassMap<AnotherClassMap>();

跳过空白记录

如果所有字段都是空的，就会被认为是空字段

// Default valuecsv.Configuration.SkipEmptyRecords = false;

Trim 字段

把字段内容收尾的空白字符删去。

// Default valuecsv.Configuration.TrimFIElds = false;

Trim 列名

// Default valuecsv.Configuration.Trimheaders = false;

解绑类映射

// Unregister single map.csv.Configuration.UnregisterClassMap<MyClassMap>();// Unregister all class maps.csv.Configuration.UnregisterClassMap();

空字段是否抛出异常

// Default valuecsv.Configuration.WillThrowOnMissingFIEld = true;

类型转换

类型转换是 CsvHelper 把字符串转换为 .NET 类型（以及反过来）的方法。

其他查看异常信息

Exception.Data["CsvHelper"]// Row: '3' (1 based)// Type: 'CsvHelper.Tests.CsvReaderTests+TestBoolean'// FIEld Index: '0' (0 based)// FIEld name: 'BoolColumn'// FIEld Value: 'two'

DataReader 与 Datatable

DataReader 对象写入到 CSV

var hasheaderBeenWritten = false;while( dataReader.Read() ){    if( !hasheaderBeenWritten )    {        for( var i = 0; i < dataReader.FIEldCount; i++ )        {            csv.WriteFIEld( dataReader.Getname( i ) );        }        csv.NextRecord();        hasheaderBeenWritten = true;    }    for( var i = 0; i < dataReader.FIEldCount; i++ )    {        csv.WriteFIEld( dataReader[i] );    }    csv.NextRecord();}

Datatable 对象写入到 CSV

using( var dt = new Datatable() ){    dt.Load( dataReader );    foreach( DataColumn column in dt.Columns )    {        csv.WriteFIEld( column.Columnname );    }    csv.NextRecord();    foreach( DaTarow row in dt.Rows )    {        for( var i = 0; i < dt.Columns.Count; i++ )        {            csv.WriteFIEld( row[i] );        }        csv.NextRecord();    }}

CSV 转 Datatable

while( csv.Read() ){    var row = dt.NewRow();    foreach( DataColumn column in dt.Columns )    {        row[column.Columnname] = csv.GetFIEld( column.DataType, column.Columnname );    }    dt.Rows.Add( row );}

相关文章：

.net CsvHelper 2.0

jQuery EasyUI API 中文文档 - Documentation 文档_jquery

相关视频：

Ruby中文文档 总结

以上是内存溢出为你收集整理的技术解答CSV 文件的一个 .NET 库：CsvHelper 中文文档全部内容，希望文章能够帮你解决技术解答CSV 文件的一个 .NET 库：CsvHelper 中文文档所遇到的程序开发问题。

如果觉得内存溢出网站内容还不错，欢迎将内存溢出网站推荐给程序员好友。