使用CSVHelper库读取CSV文件时的布尔值转换方案咨询

嘿，你遇到的这种包含YES/NO/True/False还有空值的布尔值转换场景，CSVHelper最新版本其实已经有很方便的解决方案啦，不用完全从零写自定义转换器，我给你详细说说两种处理方式：

一、优先用自带配置快速解决 #

CSVHelper的BooleanConverter本身支持自定义可识别的真值、假值，还能忽略大小写，处理空值也很灵活，具体步骤如下：

1. 针对单个字段配置（在ClassMap中设置） #

如果你只是某个特定字段需要这种转换，可以在实体的映射类里单独配置：

首先定义你的实体类：

public class Account
{
    public int AccountId { get; set; }
    // 如果空值要映射为null，这里用可空bool类型；如果要映射为false，用普通bool即可
    public bool? IsValid { get; set; }
}

然后创建映射类并配置布尔值选项：

public class AccountMap : ClassMap<Account>
{
    public AccountMap()
    {
        Map(m => m.AccountId).Name("ACCOUNTID");
        
        // 配置布尔值转换规则
        var boolOptions = new TypeConverterOptions
        {
            // 定义所有被视为"真"的值，大小写不敏感
            TrueValues = new[] { "YES", "TRUE" },
            // 定义所有被视为"假"的值
            FalseValues = new[] { "NO", "FALSE" },
            // 开启大小写忽略，这样yes、Yes都能被识别
            IgnoreCase = true,
            // 如果空值需要被视为null，添加这个配置（对应实体类里的bool?类型）
            NullValues = new[] { "" }
            // 如果你想把空值视为false，就把""加到FalseValues里即可
        };
        
        Map(m => m.IsValid).Name("IsValid").TypeConverterOptions(boolOptions);
    }
}

最后使用这个映射读取CSV：

using (var reader = new StreamReader("你的CSV文件路径.csv"))
using (var csv = new CsvReader(reader, CultureInfo.InvariantCulture))
{
    csv.Context.RegisterClassMap<AccountMap>();
    var accounts = csv.GetRecords<Account>().ToList();
}

2. 全局配置（所有布尔字段通用） #

如果你的CSV里多个布尔字段都需要同样的转换规则，可以直接全局配置，不用每个字段单独设置：

// 创建全局配置实例
var config = new CsvConfiguration(CultureInfo.InvariantCulture);

// 定义布尔值转换规则
var boolOptions = new TypeConverterOptions
{
    TrueValues = new[] { "YES", "TRUE" },
    FalseValues = new[] { "NO", "FALSE" },
    IgnoreCase = true,
    NullValues = new[] { "" }
};

// 把规则应用到普通bool和可空bool类型
config.TypeConverterOptionsCache.AddOptions<bool>(boolOptions);
config.TypeConverterOptionsCache.AddOptions<bool?>(boolOptions);

// 使用全局配置读取CSV
using (var reader = new StreamReader("你的CSV文件路径.csv"))
using (var csv = new CsvReader(reader, config))
{
    var accounts = csv.GetRecords<Account>().ToList();
}

二、特殊场景自定义转换器 #

如果自带的配置满足不了你的特殊需求（比如还有其他自定义的布尔值表述），可以自己写一个转换器：

public class CustomBooleanConverter : BooleanConverter
{
    public override object ConvertFromString(string text, IReaderRow row, MemberMapData memberMapData)
    {
        // 处理空值
        if (string.IsNullOrWhiteSpace(text))
        {
            // 根据实体字段类型返回null或者false
            return memberMapData.Member.MemberType == typeof(bool?) ? null : (object)false;
        }
        
        var lowerText = text.ToLowerInvariant();
        // 自定义你的真值、假值判断逻辑
        if (lowerText is "yes" or "true" or "y")
        {
            return true;
        }
        if (lowerText is "no" or "false" or "n")
        {
            return false;
        }
        
        // 遇到无法识别的值时，这里可以抛出异常或者返回默认值
        throw new InvalidCastException($"无法将值 '{text}' 转换为布尔类型");
    }
}

然后在映射里使用这个自定义转换器：

public class AccountMap : ClassMap<Account>
{
    public AccountMap()
    {
        Map(m => m.AccountId).Name("ACCOUNTID");
        Map(m => m.IsValid).Name("IsValid").TypeConverter<CustomBooleanConverter>();
    }
}

总的来说，大部分场景下用自带的配置就足够了，简单又省心，只有特殊需求时才需要自定义转换器哦。

备注：内容来源于stack exchange，提问作者user768853