【C#】CsvHelper 使用手冊

来源:https://www.cnblogs.com/gl1573/archive/2020/05/20/12922857.html

現在網上的 CsvHelper 教程都比較舊,本文基於 CsvHelper 最新版本 15.0.5 ...


本文代碼基於 CsvHelper 15.0.5

簡介

CsvHelper 是一個用於讀寫 CSV 文件的.NET庫。極其快速,靈活且易於使用。

CsvHelper 建立在.NET Standard 2.0 之上,幾乎可以在任何地方運行。

Github 地址:https://github.com/joshclose/csvhelper

模塊

模塊 功能
CsvHelper 讀寫 CSV 數據的核心類。
CsvHelper.Configuration 配置 CsvHelper 讀寫行為的類。
CsvHelper.Configuration.Attributes 配置 CsvHelper 的特性。
CsvHelper.Expressions 生成 LINQ 表達式的類。
CsvHelper.TypeConversion 將 CSV 欄位與 .NET 類型相互轉換的類。

讀取

測試類

public class Foo
{
    public int ID { get; set; }

    public string Name { get; set; }
}

csv 文件數據

ID,Name
1,Tom
2,Jerry

讀取所有記錄

using (var reader = new StreamReader("foo.csv"))
{
    using (var csv = new CsvReader(reader, CultureInfo.InvariantCulture))
    {
        var records = csv.GetRecords<Foo>();
    }
}

讀取 csv 文件時,空行將被忽略,若空行中包含空格,將報錯。
如果是 Excel 編輯的 CSV 文件,空行將會變成僅包含分隔符 , 的行,也會報錯。

逐條讀取

using (var reader = new StreamReader("foo.csv"))
{
    using (var csv = new CsvReader(reader, CultureInfo.InvariantCulture))
    {
        while (csv.Read())
        {
            var record = csv.GetRecord<Foo>();
        }
    }
}

GetRecords<T> 方法通過 yield 返回一個 IEnumerable<T>,並不會將內容一次全部讀進記憶體,除非調用了 ToListToArray 方法。所以這種逐條讀取的寫法沒有太多必要。

讀取單個欄位

using (var csv = new CsvReader(reader, CultureInfo.InvariantCulture))
{
    csv.Read();
    csv.ReadHeader();

    while (csv.Read())
    {
        var id = csv.GetField<int>(0);
        var name = csv.GetField<string>("Name");
    }
}

逐行讀取時,可以不管標題行,但是,這裡不行。

csv.Read(); 這句是讀取標題,如果沒有的話,while 迴圈第一次取到的是標題,肯定會報錯。

csv.ReadHeader(); 這句是給標題賦值,如果沒有的話,csv.GetField<string>("Name") 會報找不到標題。

使用 TryGetField 可以防止意外的報錯。

csv.TryGetField(0, out int id);

寫入

寫入所有記錄

var records = new List<Foo>
{
    new Foo { ID = 1, Name = "Tom" },
    new Foo { ID = 2, Name = "Jerry" },
};

using (var writer = new StreamWriter("foo.csv"))
{
    using (var csv = new CsvWriter(writer, CultureInfo.InvariantCulture))
    {
        csv.WriteRecords(records);
    }
}

逐條寫入

using (var writer = new StreamWriter("foo.csv"))
{
    using (var csv = new CsvWriter(writer, CultureInfo.InvariantCulture))
    {
        foreach (var record in records)
        {
            csv.WriteRecord(record);
        }
    }
}

逐欄位寫入

using (var writer = new StreamWriter("foo.csv"))
{
    using (var csv = new CsvWriter(writer, CultureInfo.InvariantCulture))
    {
        csv.WriteHeader<Foo>();
        csv.NextRecord();

        foreach (var record in records)
        {
            csv.WriteField(record.ID);
            csv.WriteField(record.Name);
            csv.NextRecord();
        }
    }
}

特性

Index

Index 特性用於標記欄位順序。

在讀取文件時,如果沒有標題,就只能通過順序來確定欄位。

public class Foo
{
    [Index(0)]
    public int ID { get; set; }

    [Index(1)]
    public string Name { get; set; }
}
    
using (var reader = new StreamReader("foo.csv"))
{
    using (var csv = new CsvReader(reader, CultureInfo.InvariantCulture))
    {
        csv.Configuration.HasHeaderRecord = false;

        var records = csv.GetRecords<Foo>().ToList();
    }
}

csv.Configuration.HasHeaderRecord = false 配置告知 CsvReader 沒有標題。必須要加這一行,否則會預設第一行為標題而跳過,導致最後的結果中少了一行。如果數據量比較多,會很難發現這個 bug。

在寫入文件的時候,會按 Index 順序寫入。如果不想寫入標題,也需要添加 csv.Configuration.HasHeaderRecord = false;

Name

如果欄位名稱和列名不一致,可以使用 Name 屬性。

public class Foo
{
    [Name("id")]
    public int ID { get; set; }

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

NameIndex

NameIndex 用於處理 CSV 文件中的同名列。

public class Foo
{
    ...

    [Name("Name")]
    [NameIndex(0)]
    public string FirstName { get; set; }

    [Name("Name")]
    [NameIndex(1)]
    public string LastName { get; set; }
}

Ignore

忽略欄位

Optional

讀取時如果找不到匹配的欄位,則忽略。

public class Foo
{
    ...

    [Optional]
    public string Remarks { get; set; }
}

Default

當讀取的欄位為空時 Default 特性可為其指定預設值。

Default 特性僅在讀取時有效,寫入時是不會將空值替換為預設值寫入的。

NullValues

public class Foo
{
    ...

    [NullValues("None", "none", "Null", "null")]
    public string None { get; set; }
}

讀取文件時,若 CSV 文件中某欄位的值為空,那麼讀取後的值是 "",而非 null,標記 NullValues 特性後,若 CSV 文件中的某欄位值為 NullValues 指定的值,則讀取後為 null

若同時標記了 Default 特性,則此特性不起作用。

坑爹的是,在寫入文件時,此特性並不起作用。因此會引起讀寫不一致的問題。

Constant

Constant 特性為欄位指定一個常量值,讀寫時都使用此值,無論指定了什麼其他映射或配置。

Format

Format 指定類型轉換時使用的字元串格式。

例如數字和時間類型,我們經常會指定其格式。

public class Foo
{
    ...

    [Format("0.00")]
    public decimal Amount { get; set; }

    [Format("yyyy-MM-dd HH:mm:ss")]
    public DateTime JoinTime { get; set; }
}

BooleanTrueValues 和 BooleanFalseValues

這兩個特性用於將 bool 轉換成指定的形式顯示。

public class Foo
{
    ...

    [BooleanTrueValues("yes")]
    [BooleanFalseValues("no")]
    public bool Vip { get; set; }
}

NumberStyles

public class Foo
{
    ...

    [Format("X2")]
    [NumberStyles(NumberStyles.HexNumber)]
    public int Data { get; set; }
}

比較有用是 NumberStyles.HexNumberNumberStyles.AllowHexSpecifier,這兩個枚舉的作用差不多。此特性僅在讀取時有效,寫入時並不會轉成 16 進位寫入。這會導致讀寫不一致,可以用 Format 特性指定寫入格式。

映射

如果無法給要映射的類添加特性,在這種情況下,可以使用 ClassMap 方式進行映射。

使用映射和使用特性效果是一樣的,坑爹的地方也一樣坑爹。以下示例用屬性實現了上面特性的功能。

public class Foo2
{
    public int ID { get; set; }

    public string Name { get; set; }

    public decimal Amount { get; set; }

    public DateTime JoinTime { get; set; }

    public string Msg { get; set; }

    public string Msg2 { get; set; }

    public bool Vip { get; set; }

    public string Remarks { get; set; }

    public string None { get; set; }

    public int Data { get; set; }
}

public class Foo2Map : ClassMap<Foo2>
{
    public Foo2Map()
    {
        Map(m => m.ID).Index(0).Name("id");
        Map(m => m.Name).Index(1).Name("name");
        Map(m => m.Amount).TypeConverterOption.Format("0.00");
        Map(m => m.JoinTime).TypeConverterOption.Format("yyyy-MM-dd HH:mm:ss");
        Map(m => m.Msg).Default("Hello");
        Map(m => m.Msg2).Ignore();
        Map(m => m.Vip)
            .TypeConverterOption.BooleanValues(true, true, new string[] { "yes" })
            .TypeConverterOption.BooleanValues(false, true, new string[] { "no" });
        Map(m => m.Remarks).Optional();
        Map(m => m.None).TypeConverterOption.NullValues("None", "none", "Null", "null");
        Map(m => m.Data)
            .TypeConverterOption.NumberStyles(NumberStyles.HexNumber)
            .TypeConverterOption.Format("X2");
    }
}

在使用映射前,需要先註冊

csv.Configuration.RegisterClassMap<Foo2Map>();

ConvertUsing

ConvertUsing 允許使用一個委托方法實現類型轉換。

// 常數
Map(m => m.Constant).ConvertUsing(row => 3);

// 把兩列聚合在一起
Map(m => m.Name).ConvertUsing(row => $"{row.GetField<string>("FirstName")} {row.GetField<string>("LastName")}");

Map(m => m.Names).ConvertUsing(row => new List<string> { row.GetField<string>("Name") } );

配置

Delimiter

分隔符

csv.Configuration.Delimiter = ",";

HasHeaderRecord

此配置前文已經提到過,是否將第一行作為標題

csv.Configuration.HasHeaderRecord = false;

IgnoreBlankLines

是否忽略空行,預設 true

csv.Configuration.IgnoreBlankLines = false;

無法忽略一個僅包含空格或 , 的行。

AllowComments

是否允許註釋,註釋以 # 開頭。

csv.Configuration.AllowComments = true;

Comment

獲取或設置用於表示註釋掉的行的字元。預設是 #

csv.Configuration.Comment = '/';

BadDataFound

設置一個函數,該函數會在數據不正確時觸發,可用於記錄日誌。

IgnoreQuotes

獲取或設置一個值,該值指示在解析時是否應忽略引號並將其與其他任何字元一樣對待。

預設是 false,如果字元串中有引號,必須是 3 個 " 連在一起,讀取到的字元串中才會有一個 ",如果是 1 個則忽略,2 個則報錯。

如果為 true,則會將 " 當做字元串原樣返回。

csv.Configuration.IgnoreQuotes = true;

CsvWriter 中是沒有這個屬性的,一旦字元串中包含 ",寫出來就是 3 個 " 連在一起。

TrimOptions

去除欄位首尾空格

csv.Configuration.TrimOptions = TrimOptions.Trim;

PrepareHeaderForMatch

PrepareHeaderForMatch 定義了屬性名稱與標題進行匹配的函數。標題和屬性名稱均通過該函數運行。此功能可用於刪除標題中的空格,或者當標題和屬性名稱大小寫不一致時統一大小寫後比較。

csv.Configuration.PrepareHeaderForMatch = (string header, int index) => header.ToLower();

您的分享是我們最大的動力!

更多相關文章
  • 0. 前言 今天是NHibernate的第二篇內容,通過上一篇的內容,我們初步瞭解了NHibernate的創建和使用。這一篇,我繼續探索NHibernate背後的秘密。嗯,就是這樣。 1. NHibernate結構 先給小伙伴們放個圖: 這是NHibernate的整體結構圖。NHibernate通過 ...
  • 隨著信息技術對人們工作生活的影響越來越大,人們對於應用程式的依賴性也越來越大,越來越多的人使用應用程式來解決自己工作和生活中的問題,這也導致應用程式的開發需求越來越高,傳統的應用程式開發方法已經沒有辦法滿足市場的需求,低代碼開發平臺在這樣的背景下誕生了。 力軟低代碼開發平臺可以減少開發成本,代碼、功 ...
  • C#手動建立Table後,並設置列和賦值 public DataTable CreateTable() { //創建Table1 DataTable dt = new DataTable(); //對Table1添加列名,並設置列值類型 DataTable dt1 = new DataTable() ...
  • C#中的關於Table的Merge() 簡介: Merge()方法可以實現對兩個table具有相同欄位的進行Morge,也可以實現對兩個table具有不同欄位的進行Merge。但是實現後的結果可能不太一樣。 一、對兩個table具有相同的欄位進行Merge的時候,所得到Merge後的table行數小 ...
  • 倉儲物流的過程中往往少不了一些使用熱敏印表機或者碳帶印表機列印一些條碼、信息貼在實物或者包裹上 最好的實現方式不過於直接使用熱敏代碼形成文本直接輸出到印表機做列印 但是熱敏代碼也是一門需要特殊的語言,需要學習 故為了更快更方便的實現,就用到了畫布繪製後形成image輸出到印表機 而image也是有要 ...
  • 關於讀取Excel模板對模板讀寫操作 1.根據文件名稱(帶盤符的文件目錄),建立SLDocument對象 SLDocument sldocument = new SLDocument(filename); sldocument.SelectWorksheet("Sheet1"); 2.讀取某一單元格 ...
  • 上一篇文章(https://www.cnblogs.com/meowv/p/12913676.html)我們用Code First的方式創建了博客所需的實體類,生成了資料庫表,完成了對EF Core的封裝。 本篇說一下自定義倉儲的實現方式,其實在abp框架中已經預設給我們實現了預設的通用(泛型)倉儲 ...
  • ketcup git地址:https://github.com/simple-gr/ketchup rabbitmq 安裝 1.docker pull rabbitmq:management 2.docker run -itd --name rabbitmq --restart=always -p ...
一周排行
  • C#6.0新特性 C#7.0新特性 C#8.0新特性 ...
  • out變數 可以直接在方法中使用out申明變數 int.TryParse("123", out var result); 元組 元組的申明 var alphaBetaStart = (alpha: "a", beta: "b"); Console.WriteLine($"{alphaBetaStar ...
  • 在我們的項目中,通常會把數據存儲到關係型資料庫中,比如Oracle,SQL Server,Mysql等,但是關係型資料庫對於併發的支持並不是很強大,這樣就會造成系統的性能不佳,而且存儲的數據多為結構化數據,對於非結構數據(比如文本)和半結構化數據(比如JSon) 就顯得不夠靈活,而非關係型資料庫則很 ...
  • 這幾天終於弄懂了async和await的模式,也搞明白了一直在心裡面積壓著的許多問題,所以寫一篇博客來和大家分享一下。 關於非同步機制我認為只要記住的以下幾點,就可以弄明白了: 1.我認為async和awwait兩個修飾符中最關鍵的是await,async是由於方法中包含await修飾符之後才在方法定 ...
  • 實現WCF的步驟如下: 設計服務協議 實現服務協議 配置服務 托管服務 生成客戶端(這步可有可無) 設計或定義服務協議要麼使用介面,要麼使用類。建議介面,使用介面好處一堆例如修改介面的實現,但是服務協定有無需改變。 設計服務協議,介面上使用 ServiceContractAttribute ,方法上 ...
  • 什麼鬼,我的CPF快寫好了,你居然也要搞跨平臺UI框架?什麼Maui? 之前怎麼不早說要搞跨平臺UI框架呢?看到谷歌搞flutter眼紅了?明年年底發佈?又搞這種追別人屁股的爛事情。 什麼MVU模式?模仿Dart?用C#代碼直接寫UI的模式和我的CPF很像啊。 當初我考慮過XML,Json來描述UI ...
  • 寫在前面 Docker作為開源的應用容器引擎,可以讓我們很輕鬆的構建一個輕量級、易移植的容器,通過Docker方式進行持續交付、測試和部署,都是極為方便的,並且對於我們開發來說,最直觀的優點還是解決了日常開發中的環境配置與部署環境配置上的差異所帶來的種種疑難雜症,從此推脫產品的措辭也少了——“我電腦 ...
  • 一、前言 回顧:認證授權方案之授權初識 從上一節中,我們在對授權系統已經有了初步的認識和使用,可以發現,asp.net core為我們提供的授權策略是一個非常強大豐富且靈活的認證授權方案,能夠滿足大部分的授權場景。 在ConfigureServices中配置服務:將授權服務添加到容器 public ...
  • 項目背景: 工作之餘兼職一家公司(方向是工業4.0)給做IM系統,主要功能包括:文字、 圖片、文件傳輸、遠程協助、視頻語音等等。這些功能都是基於群會話, 比如工廠操作工人遇到問題,請求遠程專家,這個初級專家不能解決問題,會邀請一個高級專家進來解決。開發過程中主要遇到的問題是視頻和語音這一塊,像其他的... ...
  • 基礎概念 Microsoft中間語言(MSIL),也成為通用中間語言(CIL),是一組與平臺無關的指令,由特定於語言的編譯器從源代碼生成。MSIL是獨立於平臺的,因此,他可以在任何公共語言基礎架構支持特定的環境上執行。 通過JIT編譯器將MSIL轉換為特定電腦環境的特定機器代碼。這是在執行MSIL ...