具有非默认构造函数的 CsvHelper

Question

我的问题如下。我想在 WPF C# 下借助 CsvHelper 将类属性写入 CSV 文件，然后再读回它们。引用的类之一具有非默认的参数化构造函数。如何让 CsvHelper 正确调用其构造函数？

因此我使用以下地图文件。

public class TradeLogRecMap : ClassMap<TradeLogRec>
{
    public TradeLogRecMap()
    {
        AutoMap(CSVConfig);
    }
}

有了这些类和结构

public class Liquidity
{
    static readonly Dictionary<int, string> Values = new Dictionary<int, string> 
    { 
        {0, "None"}, 
        {1, "Added Liquidity"}, 
        {2, "Removed Liquidity"}, 
        {3, "Liquidity Routed Out" }
    };

    public Liquidity(int p)
    {
        Value = Values.ContainsKey(p) ? p : 0;
    }

    public int Value { get; set; }

    public override string ToString()
    {
        return Values[Value];
    }
}

public class Execution
{
    public Liquidity LastLiquidity { get; set; }

    public Execution()
    {
        LastLiquidity = new Liquidity(0);
    }

}

public struct TradeLogRec
{
    public Execution execution { set; get; }
}

当我写入 CSV 文件时，看起来没问题。但读回来它说它错过了标题“p”。在 CSV 文件中添加“p”标头可以解决这个问题，但这样做不是一个选择。还添加默认构造函数

    public Liquidity()
    {
    }

解决了问题。但这不是以太的选择。

为什么它需要标题“p”呢？

是否可以通过映射文件或 CvsHelper 配置中的一些构造函数设置来解决它？

或者这是一个错误？

Answer 1

从 CsvHelper 27.1.1 开始，当 CsvHelper 尝试在读取期间构造类时，它将使用无参数构造函数（如果存在）。如果不存在，它将使用参数最多的 ^{参数化构造函数[1]}。当调用参数化构造函数时，CSV 列通过参数名称的精确匹配与构造函数参数进行匹配。在您的Liquidity类中，您想要映射到“值”列的参数被命名为p，因此无法进行匹配。

那么，你有什么选择呢？

首先，如果您可以修改您的Liquidity类，则可以将p构造函数参数重命名为Value：

public Liquidity(int Value)
{
    // Make the constructor parameter name match the property name exactly for CsvHelper
    this.Value = Values.ContainsKey(Value) ? Value : 0;
}

这样做之后，一切都会顺利进行。演示小提琴#1在这里。

其次，您可以修改Liquidity以添加[CsvHelper.Configuration.Attributes.Name("Value")]到p：

public Liquidity([CsvHelper.Configuration.Attributes.Name("Value")] int p)
{
    Value = Values.ContainsKey(p) ? p : 0;
}

演示小提琴#2在这里。

第三，如果您无法以任何方式修改您的类，您可以覆盖由 生成的默认引用映射AutoMap并为Liquidity.

创建以下内容ClassMap<Liquidity>：

public class LiquidityMap : ClassMap<Liquidity>
{
    public LiquidityMap()
    {
        Map(m => m.Value);
        Parameter("p").Name(nameof(Liquidity.Value));
    }
}   

并修改TradeLogRecMap为使用它如下：

public class TradeLogRecMap : ClassMap<TradeLogRec>
{
    public TradeLogRecMap()
    {
        // Automap TradeLogRecMap
        AutoMap(CSVConfig);  // CSVConfig was not shown in your question, I used new CsvConfiguration(CultureInfo.InvariantCulture) { }
        // Get the reference map for Execution
        var executionRefMap = ReferenceMaps.Find<TradeLogRec>(m => m.execution);
        // Get its reference map for LastLiquidity
        var liquidityRefMap = executionRefMap.Data.Mapping.ReferenceMaps.Find<Execution>(m => m.LastLiquidity);
        // Remove the auto-generated reference map for LastLiquidity
        executionRefMap.Data.Mapping.ReferenceMaps.Remove(liquidityRefMap);
        // And add a reference map for LastLiquidity using LiquidityMap
        executionRefMap.Data.Mapping.ReferenceMaps.Add(new MemberReferenceMap(liquidityRefMap.Data.Member, new LiquidityMap()));
    }
}   

演示小提琴#3在这里。

最后，您可以修改CsvConfiguration.PrepareHeaderForMatch以自动将任何名为“p”的列重新映射到“Value”：

public static CsvConfiguration CSVConfig => 
    new CsvConfiguration(CultureInfo.InvariantCulture)
    {
        PrepareHeaderForMatch = a => a.Header == "p" ? nameof(Liquidity.Value) : a.Header,
    };

然后在构建您的时使用它CsvReader：

public static List<TradeLogRec> DeserializeTradeLogRecMapFromCsv(TextReader reader)
{
    using (var csv = new CsvReader(reader, CSVConfig))
    {
        csv.Context.RegisterClassMap<TradeLogRecMap>();
        return csv.GetRecords<TradeLogRec>().ToList();
    }           
}

这看起来有点混乱，因为它将所有名为“Value”的列映射到“p”，而不仅仅是Liquidity- 但它确实有效。演示小提琴#4在这里。

CsvConfiguration.ShouldUseConstructorParameter[1] 此行为通过和配置CsvConfiguration.GetConstructor。