手艺解答CSV 文件的一个 .NET 库：CsvHelper 中文文档【C#.Net教程】,c#,csv

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 value
csv.Configuration.AllowComments = false;

自动映照

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

缓存

TextReader 或 TextWriter 中读写的缓存

// Default value
csv.Configuration.BufferSize = 2048;

解释

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

// Default value
csv.Configuration.Comment = '#';

Byte 计数

纪录当前读取了若干 Byte 了，须要设置 Configuration.Encoding 与 CSV 文件一致。这个设置会影响剖析的速率。

// Default value
csv.Configuration.CountBytes = false;

Culture 信息

// Default value
csv.Configuration.CultureInfo = CultureInfo.CurrentCulture;

支解符

// Default value
csv.Configuration.Delimiter = ",";

列数变化

假如开启，发明列数变化会抛出 CsvBadDataException

// Default value
csv.Configuration.DetectColumnCountChanges = false;

编码

// Default value
csv.Configuration.Encoding = Encoding.UTF8;

是不是有头纪录

// Default value
csv.Configuration.HasHeaderRecord = true;

疏忽列名空格

是不是疏忽列名中的空格

// Default value
csv.Configuration.IgnoreHeaderWhiteSpace = false;

疏忽私有接见

读写的时刻是不是疏忽私有接见器

// Default value
csv.Configuration.IgnorePrivateAccessor = false;

疏忽读取非常

读取发作非常以后仍继承读取

// Default value
csv.Configuration.IgnoreReadingExceptions = false;

疏忽引号

不把引号作为转义符

// Default value
csv.Configuration.IgnoreQuotes = false;

列名是不是大小写敏感

// Default value
csv.Configuration.IsHeaderCaseSensitive = true;

映照接见

能够对自定义的类映照举行接见

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

属性绑定标记

用来寻觅自定义类的属性

// Default value
csv.Configuration.PropertyBindingFlags = BindingFlags.Public | BindingFlags.Instance;

本文由 tang yi ke jun 翻译

Quote

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

// Default value
csv.Configuration.Quote = '"';

一切字段加引号

写入csv的时刻是不是对一切字段加引号。QuoteAllFields 和 QuoteNoFields 不能同时为 true 。

// Default value
csv.Configuration.QuoteAllFields = false;

一切字段不加引号

QuoteAllFields 和 QuoteNoFields 不能同时为 true 。

// Default value
csv.Configuration.QuoteNoFields = false;

读取非常的回调

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

注册类映照

运用了类映照的话，须要举行注册才会被实际运用到。

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

跳过空缺纪录

假如一切字段都是空的，就会被以为是空字段

// Default value
csv.Configuration.SkipEmptyRecords = false;

Trim 字段

把字段内容扫尾的空缺字符删去。

// Default value
csv.Configuration.TrimFields = false;

Trim 列名

// Default value
csv.Configuration.TrimHeaders = false;

解绑类映照

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

空字段是不是抛出非常

// Default value
csv.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 中文文档的细致内容，更多请关注ki4网别的相干文章！

读取

读取一切的纪录

手动读取纪录

读取零丁的字段

剖析

写入

写入一切纪录

映照

自动映照

手动映照

援用映照

下标指定

列名指定

同名处置惩罚

默许值

范例转换

可选范例转换

ConvertUsing

运行时映照

设置

许可解释

自动映照

缓存

解释

Byte 计数

Culture 信息

支解符

列数变化

编码

是不是有头纪录

疏忽列名空格

疏忽私有接见

疏忽读取非常

疏忽引号

列名是不是大小写敏感

映照接见

属性绑定标记

Quote

一切字段加引号

一切字段不加引号

读取非常的回调

注册类映照

跳过空缺纪录

Trim 字段

Trim 列名

解绑类映照

空字段是不是抛出非常

范例转换

其他

检察非常信息

DataReader 与 DataTable

相关阅读

关于验证码生成要领的汇总引见【C#.Net教程】,

c言语“或”标记【C#.Net教程】,c语言,或符号

.net和c#有什么区别【C#.Net教程】,.net,c#

伪代码是什么？如何写一个伪代码？【C#.Net教程】,伪代码,c语言,算法