如何使用枚举转换器与CsvHelper

本文关键字：CsvHelper 转换器 枚举 何使用 | 更新日期: 2023-09-27 18:05:07

我使用CsvHelper将一个类序列化为csv文件-直到这里一切正常。

现在我正试图找到一种方法将类的枚举属性转换为csv中的int值，这样我就可以使用csv进行批量插入。

我在CsvHelper中找到了EnumConverter类，但我不知道如何正确使用它，因为我所有的尝试都失败了。

这是我的映射类代码

 public sealed class MyMapping : CsvClassMap<TradingCalendarException>
    {
        public MyMapping()
        {
            EnumConverter enumConverter = new EnumConverter(typeof(CalendarExceptionEntityType));
            Map(m => m.ExceptionEntityType).Index(0).Name("EXCEPTION_ENTITY_TYPE").TypeConverter(enumConverter);
            Map(m => m.ExceptionEntityIdentifier).Index(1).Name("EXCEPTION_ENTITY_IDENTIFIER");
            Map(m => m.OptionType).Index(2).Name("OPTION_TYPE");
            Map(m => m.StartDatetime).Index(3).Name("EXCEPTION_START_DATETIME");
            Map(m => m.EndDatetime).Index(4).Name("EXCEPTION_END_DATETIME");
            Map(m => m.DataSourceType).Index(5).Name("DATA_SOURCE_TYPE");
            Map(m => m.Description).Index(6).Name("DESCRIPTION");
        }
    }

和书写部分

using (StreamWriter file = new StreamWriter(filePath, false, Encoding.UTF8))
        {
            CsvWriter writer = new CsvWriter(file);
            MyMapping mapping = new MyMapping();
            writer.Configuration.RegisterClassMap(mapping);
            writer.WriteRecords(calendarExceptionList);
        }

其余的映射(索引和命名)是工作的，它只是EnumConverter不做任何改变。

我在网上找不到任何例子。

谢谢!

如何使用枚举转换器与CsvHelper

这是我的解决方案:

public class CalendarExceptionEnumConverter<T> : DefaultTypeConverter  where T : struct
    {
        public override string ConvertToString(TypeConverterOptions options, object value)
        {
            T result;
            if(Enum.TryParse<T>(value.ToString(),out result))
            {
                return (Convert.ToInt32(result)).ToString();
            }
            throw new InvalidCastException(String.Format("Invalid value to EnumConverter. Type: {0} Value: {1}",typeof(T),value));
        }
    }

，并使用如下:

Map(m => m.ExceptionEntityType).TypeConverter<CalendarExceptionEnumConverter<CalendarExceptionEntityType>>();

我使用了Yarimi的解决方案，但发现它无法从。csv(可以写ok)中读取enum值

我的解决方案是使类从EnumTypeConverter扩展，而不是DefaultTypeConverter。

这里是完整的代码

    public class OurEnumConverter<T> : CsvHelper.TypeConversion.EnumConverter where T : struct
    {
        public OurEnumConverter(): base(typeof(T))
        { }
        public override string ConvertToString(CsvHelper.TypeConversion.TypeConverterOptions options, object value)
        {
            T result;
            if (Enum.TryParse<T>(value.ToString(), out result))
            {
                return (Convert.ToInt32(result)).ToString();
            }
            return base.ConvertToString(options, value);
            //throw new InvalidCastException(String.Format("Invalid value to EnumConverter. Type: {0} Value: {1}", typeof (T), value));
        }
        public override object ConvertFromString(TypeConverterOptions options, string text)
        {
            int parsedValue;
            //System.Diagnostics.Debug.WriteLine($"{typeof(T).Name} = {text}");
            if (Int32.TryParse(text, out parsedValue))
            {
                return (T)(object)parsedValue;
            }
            return base.ConvertFromString(options, text);
            //throw new InvalidCastException(String.Format("Invalid value to EnumConverter. Type: {0} Value: {1}", typeof(T), text));
        }
    }

的用法

public class TickTradeClassMap : CsvHelper.Configuration.CsvClassMap<TickData.TickTrade>
    {
        public TickTradeClassMap()
        {
            Map(m => m.price);
            Map(m => m.size);
            Map(m => m.exchange).TypeConverter<OurEnumConverter<ATExchangeEnum>>();
            Map(m => m.condition1).TypeConverter<OurEnumConverter<ATTradeConditionEnum>>();
        }
    }

这是我为CSV Helper的最新版本7.1.1所做的:

public class AggregateEnumConverter<T> : EnumConverter where T : struct
{
    public AggregateEnumConverter() : base(typeof(T)) { }
    public override object ConvertFromString(string text, IReaderRow row, MemberMapData memberMapData)
    {
        if(!Enum.TryParse(text, out AggregateType aggregateType))
        {
            // This is just to make the user life simpler...
            if(text == "24HAVG")
            {
                return AggregateType._24HAVG;
            }
            // If an invalid value is found in the CSV for the Aggregate column, throw an exception...
            throw new InvalidCastException($"Invalid value to EnumConverter. Type: {typeof(T)} Value: {text}");
        }
        return aggregateType;
    }
}

注意:上面的代码使用了c# 7新的内联输出变量。
更多信息在这里:如何在c#中将字符串转换为enum ?

这是如何使用自定义的EnumConverter:

/// <summary>
/// Maps Tag class properties to the CSV columns' names
/// </summary>
public sealed class TagMap : ClassMap<Tag>
{
    public TagMap(ILogger<CsvImporter> logger)
    {
        Map(tag => tag.Aggregate).Name("aggregate").TypeConverter<AggregateEnumConverter<AggregateType>>();
    }
}

为您的TradingCalendarException类添加一个int属性，该属性将来回转换为您的自定义enum CalendarExceptionEntityType，如:

public int ExceptionEntityTypeInt { 
    get { return (int)ExceptionEntityType; } 
    set { ExceptionEntityType = (CalendarExceptionEntityType)value; } 
}

使用Map(m => m.ExceptionEntityTypeInt).Index(0).Name("EXCEPTION_ENTITY_TYPE_INT")代替枚举转换器Map(m => m.ExceptionEntityType).Index(0).Name("EXCEPTION_ENTITY_TYPE").TypeConverter(new MyMapping())

相关文章：