【问题标题】:CsvHelper and immutable typesCsvHelper 和不可变类型
【发布时间】:2019-07-11 14:28:38
【问题描述】:

我有一个不可变的类,我想在 CSV 文件中写入和读取。问题是我在读取 CSV 时遇到异常,尽管已经映射了对象并设置了应该允许它工作的配置。

为此,我使用CsvHelper。不可变类如下所示。

public class ImmutableTest
{
    public Guid Id { get; }

    public string Name { get; }

    public ImmutableTest(string name) : this(Guid.NewGuid(), name)
    {
    }

    public ImmutableTest(Guid id, string name)
    {
        Id = id;
        Name = name;
    }
}

我将其写入 CSV 文件没有问题,但是当我尝试从文件中读取它时,出现以下异常。

没有为类型“CsvTest.Program+ImmutableTest”映射任何成员

但是,我已经在下面的地图类中映射了这个类的成员。

public sealed class ImmutableTestMap : ClassMap<ImmutableTest>
{
    public ImmutableTestMap()
    {
        Map(immutableTest => immutableTest.Id)
            .Index(0)
            .Name(nameof(ImmutableTest.Id).ToUpper());

        Map(immutableTest => immutableTest.Name)
            .Index(1)
            .Name(nameof(ImmutableTest.Name));
    }
}

我也尝试通过以下配置配置阅读器使用构造函数来构建对象。

Configuration config = new Configuration
{
    IgnoreBlankLines = true
};

config.RegisterClassMap<ImmutableTestMap>();
config.ShouldUseConstructorParameters = type => true;
config.GetConstructor = type => type.GetConstructors()
    .MaxBy(constructor => constructor.GetParameters().Length)
    .FirstOrDefault();

这些似乎都不起作用。我哪里错了?


完整的 MCVE .NET Framework 控制台示例

安装包

Install-Package CsvHelper
Install-Package morelinq

示例控制台程序

using System;
using System.IO;
using CsvHelper;
using CsvHelper.Configuration;
using MoreLinq;

namespace CsvTest
{
    class Program
    {
        static void Main()
        {
            Configuration config = new Configuration
            {
                IgnoreBlankLines = true
            };

            config.RegisterClassMap<ImmutableTestMap>();
            config.ShouldUseConstructorParameters = type => true;
            config.GetConstructor = type => type.GetConstructors()
                .MaxBy(constructor => constructor.GetParameters().Length)
                .FirstOrDefault();

            const string filePath = "Test.csv";
            using (FileStream file = new FileStream(filePath, FileMode.Create))
            using (StreamWriter fileWriter = new StreamWriter(file))
            using (CsvSerializer csvSerializer = new CsvSerializer(fileWriter, config))
            using (CsvWriter csvWriter = new CsvWriter(csvSerializer))
            {
                csvWriter.WriteHeader<ImmutableTest>();
                csvWriter.NextRecord();
                csvWriter.WriteRecord(new ImmutableTest("Test 1"));
                csvWriter.NextRecord();
                csvWriter.WriteRecord(new ImmutableTest("Test 2"));
                csvWriter.NextRecord();
            }

            using (FileStream file = new FileStream(filePath, FileMode.Open))
            using (StreamReader fileReader = new StreamReader(file))
            using (CsvReader csvReader = new CsvReader(fileReader, config))
            {
                foreach (ImmutableTest record in csvReader.GetRecords<ImmutableTest>())
                {
                    Console.WriteLine(record.Id);
                    Console.WriteLine(record.Name);
                    Console.WriteLine();
                }
            }
        }

        public sealed class ImmutableTestMap : ClassMap<ImmutableTest>
        {
            public ImmutableTestMap()
            {
                Map(immutableTest => immutableTest.Id)
                    .Index(0)
                    .Name(nameof(ImmutableTest.Id).ToUpper());

                Map(immutableTest => immutableTest.Name)
                    .Index(1)
                    .Name(nameof(ImmutableTest.Name));
            }
        }

        public class ImmutableTest
        {
            public Guid Id { get; }

            public string Name { get; }

            public ImmutableTest(string name) : this(Guid.NewGuid(), name)
            {
            }

            public ImmutableTest(Guid id, string name)
            {
                Id = id;
                Name = name;
            }
        }
    }
}

【问题讨论】:

    标签: c# csv


    【解决方案1】:

    如果类型是不可变的,它将使用构造函数映射。您的构造函数变量名称需要与标头名称匹配。您可以使用Configuration.PrepareHeaderForMatch 来执行此操作。

    void Main()
    {
        var s = new StringBuilder();
        s.AppendLine("Id,Name");
        s.AppendLine($"{Guid.NewGuid()},one");
        using (var reader = new StringReader(s.ToString()))
        using (var csv = new CsvReader(reader))
        {
            csv.Configuration.PrepareHeaderForMatch = (header, indexer) => header.ToLower();
            csv.GetRecords<ImmutableTest>().ToList().Dump();
        }
    }
    
    public class ImmutableTest
    {
        public Guid Id { get; }
    
        public string Name { get; }
    
        public ImmutableTest(string name) : this(Guid.NewGuid(), name)
        {
        }
    
        public ImmutableTest(Guid id, string name)
        {
            Id = id;
            Name = name;
        }
    }
    

    【讨论】:

    • 感谢您的回答。当参数有多个单词时会发生什么?像属性FirstName 和构造函数参数firstName?一个简单的ToLower 不会解决这个问题。你有什么建议吗?
    • @Dan 使用 camelCase 作为参数,您可以使用 header[0].ToString().ToLower() + header[1..] 而不是 header.ToLower()。请注意,此语法需要 C# 8,但您可以使用较低版本的 C# 使用不同的语法获得相同的结果。
    【解决方案2】:

    所以这里的问题是类映射中没有ParameterMaps。

    用上面的例子解决这个问题的简单方法是写类似

    public ImmutableTestMap()
    {
        AutoMap();
    
        Map(immutableTest => immutableTest.Id)
            .Index(0)
            .Name(nameof(ImmutableTest.Id).ToUpper());
    }
    

    但这会导致 CSV 文件中的列标题为ID、Name 并且生成的参数映射为id、name 的问题。它们彼此不相等,因此读者会抛出一个错误,说它找不到名称为ID 的列。它还说您可以将已验证的标头设置为空。在玩了这个之后,我最终到达了配置的位置

    Configuration config = new Configuration
    {
        IgnoreBlankLines = true,
        ShouldUseConstructorParameters = type => true,
        GetConstructor = type => type.GetConstructors()
            .MaxBy(constructor => constructor.GetParameters().Length)
            .FirstOrDefault(),
        HeaderValidated = null,
        MissingFieldFound = null
    };
    
    config.RegisterClassMap<ImmutableTestMap>();
    

    正在尝试解析空字段,但未能将其转换为 GUID。所以看起来那条路已经死了。

    为了解决这个问题,我检查了自动映射生成的每个参数映射的“id”值,然后将其替换为“ID”。但是,这也不起作用,因为自动生成的地图是使用空名称生成的。仅当在配置中注册地图期间调用 SetMapDefaults 时才会分配该名称。

    所以我进行了一个盲循环,将参数映射的名称设置为明确定义的成员映射。

    public ImmutableTestMap()
    {
        AutoMap();
        Map(immutableTest => immutableTest.Id)
            .Index(0)
            .Name(nameof(ImmutableTest.Id).ToUpper());
    
        Map(immutableTest => immutableTest.Name)
            .Index(0)
            .Name(nameof(ImmutableTest.Id));
    
        if (MemberMaps.Count != ParameterMaps.Count)
        {
            return;
        }
    
        for (int i = 0; i < MemberMaps.Count; i++)
        {
            ParameterMaps[i].Data.Name = MemberMaps[i].Data.Names[0];
        }
    }
    

    但是,我会说这与其说是一个修复,不如说是一个问题,并且肯定会接受其他答案。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2011-12-24
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2011-09-27
      • 1970-01-01
      相关资源
      最近更新 更多