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 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 );
}