使用ChoETL导入CSV时，如何将字符串映射到CustomString自定义类型？

问题背景 #

将销售订单CSV导入CsvSalesOrder对象时，该对象Address属性下的字段均为自定义CustomString结构体类型，但导入后Address字段全部为空。尝试添加类型转换器未生效，相关代码如下：

CustomString结构体定义 #

public struct CustomString
{
    public string Value { get; }

    public CustomString(string val)
    {
        if (string.IsNullOrWhiteSpace(val))
        {
            Value = null;
        }
        else
        {
            Value = val.ToUpper();
        }
    }

    public static implicit operator string(CustomString s) => s.Value;
    public static explicit operator CustomString(string s) => new CustomString(s);
    public override string ToString() => Value;
}

现有映射配置 #

var config = new ChoCSVRecordConfiguration<T>()
        .WithFirstLineHeader()
        .Configure(c => c.ThrowAndStopOnMissingField = false)
        .Configure(c => c.IgnoreEmptyLine = true)
        .Configure(c => c.FileHeaderConfiguration.IgnoreColumnsWithEmptyHeader = true);

foreach (var header in headers)
{
    if (mapping.TryGetValue(header, out var propName))
        config.Map(propName, header);
}

导入代码 #

using var reader = new ChoCSVReader<T>(stream, config)
        .WithMaxScanRows(2)
        .QuoteAllFields()
        .IgnoreFieldValueMode(ChoIgnoreFieldValueMode.Any);
return reader.AsTypedEnumerable<T>();

未生效的转换器尝试 #

ChoCSVRecordFieldConfiguration customStringConfig = new ChoCSVRecordFieldConfiguration("Address1");
customStringConfig.AddConverter(TypeDescriptor.GetConverter(typeof(CustomString)));
config.CSVRecordFieldConfigurations.Add(customStringConfig);

解决方案 #

之前的转换器未生效，核心原因是字段配置关联的是CSV表头名"Address1"，而非映射后的对象属性名，导致转换器未绑定到目标属性上。以下是几种可行的解决方式：

方式一：映射时直接指定转换逻辑 #

在循环映射表头时，针对CustomString类型的属性，直接利用已有的显式转换操作符添加转换规则：

foreach (var header in headers)
{
    if (mapping.TryGetValue(header, out var propName))
    {
        var property = typeof(T).GetProperty(propName);
        var mapConfig = config.Map(propName, header);
        
        // 检测属性类型是否为CustomString，添加转换逻辑
        if (property != null && property.PropertyType == typeof(CustomString))
        {
            mapConfig.WithConverter(input => (CustomString)input);
        }
    }
}

方式二：注册全局类型转换器 #

创建自定义类型转换器并全局注册，让ChoETL自动识别CustomString类型：

1. 定义类型转换器：

public class CustomStringConverter : TypeConverter
{
    public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType)
    {
        return sourceType == typeof(string) || base.CanConvertFrom(context, sourceType);
    }

    public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)
    {
        if (value is string strValue)
        {
            return (CustomString)strValue;
        }
        return base.ConvertFrom(context, culture, value);
    }
}

2. 在程序启动时全局注册：

TypeDescriptor.AddAttributes(typeof(CustomString), new TypeConverterAttribute(typeof(CustomStringConverter)));

注册后无需额外配置，ChoETL会自动使用该转换器处理所有CustomString类型的属性。

方式三：针对特定属性配置转换器 #

如果只需要对部分CustomString属性配置转换器，可以在映射时指定转换器类型：

// 示例：给Address.Address1属性配置转换器
config.Map(nameof(CsvSalesOrder.Address.Address1), "Address1")
      .WithConverter<CustomStringConverter>();

关键注意点 #

• 转换器必须绑定到对象属性名，而非CSV表头名，否则无法匹配到目标字段
• 利用CustomString已有的显式转换操作符可以简化转换逻辑，无需重复编写值处理代码
• 全局注册转换器适合项目中大量使用CustomString类型的场景，减少重复配置

内容的提问来源于stack exchange，提问作者Sora Teichman