CsvHelper使用

V1ncent_xuan

已于 2024-05-06 08:31:00 修改

阅读量442

点赞数 6

分类专栏： HelperTool 文章标签： c#

于 2024-04-30 09:43:37 首次发布

本文链接：https://blog.csdn.net/qq_33847063/article/details/138335069

版权

HelperTool 专栏收录该内容

11 篇文章

订阅专栏

本文介绍了如何使用CsvHelper库在.NET中创建、读写CSV文件，包括创建ProductData类、MyCsv操作类的方法，以及常用特性如Index和Name的使用示例。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

CsvHelper 使用手册

记录CsvHelper的使用方法

记录CsvHelper的使用方法

简介
CsvHelper 是一个用于读写 CSV 文件的.NET库。极其快速，灵活且易于使用。

CsvHelper 建立在.NET Standard 2.0 之上，几乎可以在任何地方运行。

我一般使用在对设备数据进行记录和读写。

1创建一个设备数据类

 public class ProductData
    {
        [Name("序号")]
        public int ID { get; set; }
        [Name("姓名")]
        public string Name { get; set; }
    }

2创建一个CSV的操作类

    public class MyCsv
    {
        private string _filrPath;

        public string FilePath
        {
            get { return _filrPath; }
            set { _filrPath = value; }
        }
        public MyCsv(string StrFilePath)
        {
            _filrPath = StrFilePath;
        }
        public void CreateCSVFileAndHeader()
        {
            if (!File.Exists(FilePath))
            {
                using (var writer = new StreamWriter(FilePath, true, Encoding.Default))
                using (var csv = new CsvWriter(writer, CultureInfo.InvariantCulture))
                {
                    csv.WriteRecords(new List<ProductData> { });
                }
            }
        }
        public void AppendData(List<ProductData> listdata)
        {
            // 使用追加模式打开文件，写入数据
            using (var streamWriter = new StreamWriter(FilePath, true, Encoding.Default))
            using (var csv = new CsvWriter(streamWriter, CultureInfo.InvariantCulture))
            {
                foreach (var record in listdata)
                {
                    csv.WriteRecord(record);
                    csv.NextRecord();
                }
            }
        }

        public List<ProductData> ReadCsvData()
        {
            if (File.Exists(FilePath))
            {
                using (var reader = new StreamReader(FilePath, Encoding.Default))
                {
                    using (var csv = new CsvReader(reader, CultureInfo.InvariantCulture))
                    {
                        List<ProductData> dataRecords = csv.GetRecords<ProductData>().ToList();
                        return dataRecords;
                    }
                }
            }
            else
            {
                return null;
            }      
        }
    }

3调用测试

1创建文件

  string filePath = "data.csv";
  MyCsv myCsv = new MyCsv(filePath);
 if (!File.Exists(filePath))
 {
 myCsv.CreateCSVFileAndHeader();            
 }

2追加数据

  var records = new List<ProductData>
{
    new ProductData { ID = 3, Name = "元方" },
    new ProductData { ID = 4, Name = "伽罗" },
};
 MyCsv myCsv = new MyCsv("data.csv");
 myCsv.AppendData(records);

3读取数据

   MyCsv myCsv = new MyCsv("data.csv");
 var dataRecords = myCsv.ReadCsvData();
 
 dgv.DataSource = dataRecords;
  var data = dataRecords.Where(p => p.Name == "元方").FirstOrDefault()?.ID;

图片:
![外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传](https://img-home.csdnimg.cn/images/20230724024159.png?origin 在这里插入图片描述

常用特性记录

Index
Index 特性用于标记字段顺序。
在读取文件时，如果没有标题，就只能通过顺序来确定字段。
在写入文件的时候，会按 Index 顺序写入。如果不想写入标题，也需要添加 csv.Configuration.HasHeaderRecord = false;

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

    [Index(1)]
    public string Name { get; set; }
}

Name
如果字段名称和列名不一致，可以使用 Name 属性。

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

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