【C#】CsvHelper 使用手冊

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

現在網上的 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>，並不會將內容一次全部讀進記憶體，除非調用了 ToList 或 ToArray 方法。所以這種逐條讀取的寫法沒有太多必要。

讀取單個欄位

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.HexNumber 和 NumberStyles.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();

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

-Advertisement-
Play Games
更多相關文章
  • C# 數據操作系列 - 11 NHibernate 配置和結構介紹
    0. 前言 今天是NHibernate的第二篇內容，通過上一篇的內容，我們初步瞭解了NHibernate的創建和使用。這一篇，我繼續探索NHibernate背後的秘密。嗯，就是這樣。 1. NHibernate結構 先給小伙伴們放個圖： 這是NHibernate的整體結構圖。NHibernate通過 ...
  • 低代碼開發平臺選擇方案分析
    隨著信息技術對人們工作生活的影響越來越大，人們對於應用程式的依賴性也越來越大，越來越多的人使用應用程式來解決自己工作和生活中的問題，這也導致應用程式的開發需求越來越高，傳統的應用程式開發方法已經沒有辦法滿足市場的需求，低代碼開發平臺在這樣的背景下誕生了。 力軟低代碼開發平臺可以減少開發成本，代碼、功 ...
  • C#手動建立Table後，並設置列和賦值
    C#手動建立Table後，並設置列和賦值 public DataTable CreateTable() { //創建Table1 DataTable dt = new DataTable(); //對Table1添加列名，並設置列值類型 DataTable dt1 = new DataTable() ...
  • C#中的關於Table的Merge()
    C#中的關於Table的Merge() 簡介： Merge()方法可以實現對兩個table具有相同欄位的進行Morge,也可以實現對兩個table具有不同欄位的進行Merge。但是實現後的結果可能不太一樣。 一、對兩個table具有相同的欄位進行Merge的時候，所得到Merge後的table行數小 ...
  • 不幹膠、熱敏列印
    倉儲物流的過程中往往少不了一些使用熱敏印表機或者碳帶印表機列印一些條碼、信息貼在實物或者包裹上 最好的實現方式不過於直接使用熱敏代碼形成文本直接輸出到印表機做列印 但是熱敏代碼也是一門需要特殊的語言，需要學習 故為了更快更方便的實現，就用到了畫布繪製後形成image輸出到印表機 而image也是有要 ...
  • 關於讀取Excel模板對模板讀寫操作
    關於讀取Excel模板對模板讀寫操作 1.根據文件名稱(帶盤符的文件目錄)，建立SLDocument對象 SLDocument sldocument = new SLDocument(filename); sldocument.SelectWorksheet("Sheet1"); 2.讀取某一單元格 ...
  • 基於 abp vNext 和 .NET Core 開發博客項目 - 自定義倉儲之增刪改查
    上一篇文章(https://www.cnblogs.com/meowv/p/12913676.html)我們用Code First的方式創建了博客所需的實體類，生成了資料庫表，完成了對EF Core的封裝。 本篇說一下自定義倉儲的實現方式，其實在abp框架中已經預設給我們實現了預設的通用(泛型)倉儲 ...
  • ketchup 消息隊列rabbitmq使用
    ketcup git地址：https://github.com/simple-gr/ketchup rabbitmq 安裝 1.docker pull rabbitmq:management 2.docker run -itd --name rabbitmq --restart=always -p ...
一周排行
    -Advertisement-
    Play Games
  • Dapr Outbox 執行流程
    Dapr Outbox 是1.12中的功能。 本文只介紹Dapr Outbox 執行流程，Dapr Outbox基本用法請閱讀官方文檔 。本文中appID=order-processor，topic=orders 本文前提知識：熟悉Dapr狀態管理、Dapr發佈訂閱和Outbox 模式。 Outbo ...
  • Advanced .Net Debugging 7：托管堆與垃圾收集
    引言 在前幾章我們深度講解了單元測試和集成測試的基礎知識，這一章我們來講解一下代碼覆蓋率,代碼覆蓋率是單元測試運行的度量值,覆蓋率通常以百分比表示，用於衡量代碼被測試覆蓋的程度，幫助開發人員評估測試用例的質量和代碼的健壯性。常見的覆蓋率包括語句覆蓋率（Line Coverage）、分支覆蓋率（Bra ...
  • C#S7.NET實現西門子PLCDB塊數據採集的完整步驟
    前言 本文介紹瞭如何使用S7.NET庫實現對西門子PLC DB塊數據的讀寫，記錄了使用電腦模擬，模擬PLC，自至完成測試的詳細流程，並重點介紹了在這個過程中的易錯點，供參考。 用到的軟體： 1.Windows環境下鏈路層網路訪問的行業標準工具（WinPcap_4_1_3.exe）下載鏈接：http ...
  • WPF控制項：密碼框綁定MVVM
    從依賴倒置原則（Dependency Inversion Principle, DIP）到控制反轉（Inversion of Control, IoC）再到依賴註入（Dependency Injection, DI）的演進過程，我們可以理解為一種逐步抽象和解耦的設計思想。這種思想在C#等面向對象的編 ...
  • Python中的私有屬性與私有方法
    關於Python中的私有屬性和私有方法 Python對於類的成員沒有嚴格的訪問控制限制，這與其他面相對對象語言有區別。關於私有屬性和私有方法，有如下要點： 1、通常我們約定，兩個下劃線開頭的屬性是私有的（private）。其他為公共的（public）； 2、類內部可以訪問私有屬性（方法）； 3、類外 ...
  • C++ 訪問說明符詳解：封裝數據，控制訪問，提升安全性
    C++ 訪問說明符 訪問說明符是 C++ 中控制類成員（屬性和方法）可訪問性的關鍵字。它們用於封裝類數據並保護其免受意外修改或濫用。 三種訪問說明符： public：允許從類外部的任何地方訪問成員。 private：僅允許在類內部訪問成員。 protected：允許在類內部及其派生類中訪問成員。 示 ...
  • static_cast與dynamic_cast到底是什麼？
    寫這個隨筆說一下C++的static_cast和dynamic_cast用在子類與父類的指針轉換時的一些事宜。首先，【static_cast，dynamic_cast】【父類指針，子類指針】，兩兩一組，共有4種組合：用 static_cast 父類轉子類、用 static_cast 子類轉父類、使用 ...
  • C語言數據結構：雙向鏈表的增刪操作
    /******************************************************************************************************** * * * 設計雙向鏈表的介面 * * * * Copyright (c) 2023-2 ...
  • @ComponentScan註解的實現，Spring掃描包的過程
    相信接觸過spring做開發的小伙伴們一定使用過@ComponentScan註解 @ComponentScan("com.wangm.lifecycle") public class AppConfig { } @ComponentScan指定basePackage，將包下的類按照一定規則註冊成Be ...
  • opensips開啟python支持
    操作系統 ：CentOS 7.6_x64 opensips版本： 2.4.9 python版本：2.7.5 python作為腳本語言，使用起來很方便，查了下opensips的文檔，支持使用python腳本寫邏輯代碼。今天整理下CentOS7環境下opensips2.4.9的python模塊筆記及使用 ...
所有分類