如何使用FileHelpers导出含Dictionary属性的类为CSV？

FileHelpers默认不支持直接将Dictionary类型的属性拆分为CSV列，针对这个问题，以下是几种实用的解决方案：

方案1：自定义转换器+动态类生成 #

这种方案保留FileHelpers的核心特性，通过动态构建类定义来适配字典的键作为列：

代码示例 #

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.CodeDom.Compiler;
using Microsoft.CSharp;
using FileHelpers;

// 原始Customer类
public class Customer
{
    public string Id { get; set; }
    public string Name { get; set; }
    public Dictionary<string, string> Props { get; set; }
}

// 自定义字典值转换器
public class DictionaryValueConverter : ConverterBase
{
    private readonly string _targetKey;

    public DictionaryValueConverter(string key)
    {
        _targetKey = key;
    }

    // 导出场景不需要实现StringToField
    public override object StringToField(string from) => throw new NotImplementedException();

    public override string FieldToString(object fieldValue)
    {
        if (fieldValue is Dictionary<string, string> propsDict)
        {
            return propsDict.TryGetValue(_targetKey, out var value) ? value : string.Empty;
        }
        return string.Empty;
    }
}

// 导出逻辑
public void ExportCustomers(List<Customer> customers)
{
    // 收集所有字典键
    var allPropsKeys = customers.SelectMany(c => c.Props.Keys).Distinct().ToList();

    // 构建动态类的代码字符串
    var classBuilder = new StringBuilder();
    classBuilder.AppendLine("[DelimitedRecord(\",\")]");
    classBuilder.AppendLine("public class DynamicCustomer");
    classBuilder.AppendLine("{");
    // 添加Customer的常规属性
    classBuilder.AppendLine("    public string Id;");
    classBuilder.AppendLine("    public string Name;");
    // 为每个字典键添加对应字段，并绑定自定义转换器
    foreach (var key in allPropsKeys)
    {
        classBuilder.AppendLine($"    [Converter(typeof(DictionaryValueConverter), \"{key}\")]");
        classBuilder.AppendLine($"    public Dictionary<string, string> Props;");
    }
    classBuilder.AppendLine("}");

    // 编译动态类
    var codeProvider = new CSharpCodeProvider();
    var compileParams = new CompilerParameters
    {
        ReferencedAssemblies = { "FileHelpers.dll", typeof(Customer).Assembly.Location }
    };
    var compileResult = codeProvider.CompileAssemblyFromSource(compileParams, classBuilder.ToString());
    var dynamicCustomerType = compileResult.CompiledAssembly.GetType("DynamicCustomer");

    // 转换原始数据到动态类实例
    var dynamicData = customers.Select(c =>
    {
        var instance = Activator.CreateInstance(dynamicCustomerType);
        dynamicCustomerType.GetField("Id").SetValue(instance, c.Id);
        dynamicCustomerType.GetField("Name").SetValue(instance, c.Name);
        dynamicCustomerType.GetField("Props").SetValue(instance, c.Props);
        return instance;
    }).ToList();

    // 导出CSV
    var engine = new FileHelperEngine(dynamicCustomerType);
    engine.WriteFile("customers_output.csv", dynamicData);
}

方案2：使用DynamicFileHelper简化实现 #

利用FileHelpers的DynamicFileHelper，结合ExpandoObject构建动态行数据，无需手动编译类：

代码示例 #

using System;
using System.Collections.Generic;
using System.Dynamic;
using System.Linq;
using FileHelpers;

public void ExportWithDynamic(List<Customer> customers)
{
    var allPropsKeys = customers.SelectMany(c => c.Props.Keys).Distinct().ToList();
    // 组合完整列头：常规属性 + 字典键
    var allHeaders = new List<string> { "Id", "Name" };
    allHeaders.AddRange(allPropsKeys);

    // 构建动态行数据
    var dynamicRows = new List<dynamic>();
    foreach (var customer in customers)
    {
        dynamic row = new ExpandoObject();
        row.Id = customer.Id;
        row.Name = customer.Name;
        
        var rowDict = (IDictionary<string, object>)row;
        foreach (var key in allPropsKeys)
        {
            rowDict[key] = customer.Props.TryGetValue(key, out var val) ? val : string.Empty;
        }
        dynamicRows.Add(row);
    }

    // 使用DynamicFileHelper导出
    var dynamicEngine = new DynamicFileHelper(DelimitedClassBuilder.MakeDelimitedClass(allHeaders));
    dynamicEngine.WriteFile("dynamic_customers.csv", dynamicRows);
}

方案3：手动生成CSV（轻量场景） #

如果不需要FileHelpers的额外特性，直接手动拼接CSV是最直接的方式，避免转换器的复杂配置：

代码示例 #

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;

public void ManualCsvExport(List<Customer> customers)
{
    var allPropsKeys = customers.SelectMany(c => c.Props.Keys).Distinct().ToList();
    // 生成列头
    var headerLine = $"Id,Name,{string.Join(",", allPropsKeys)}";
    var csvLines = new List<string> { headerLine };

    foreach (var customer in customers)
    {
        // 拼接常规属性
        var parts = new List<string> { EscapeCsvField(customer.Id), EscapeCsvField(customer.Name) };
        // 拼接字典对应值
        parts.AddRange(allPropsKeys.Select(key => 
            EscapeCsvField(customer.Props.TryGetValue(key, out var val) ? val : string.Empty)));
        csvLines.Add(string.Join(",", parts));
    }

    File.WriteAllLines("manual_customers.csv", csvLines);
}

// 处理CSV字段的转义（包含逗号、引号的情况）
private string EscapeCsvField(string field)
{
    if (field.Contains(",") || field.Contains("\""))
    {
        return $"\"{field.Replace("\"", "\"\"")}\"";
    }
    return field;
}

最佳实践建议 #

• 若需要FileHelpers的验证、格式处理等特性，优先选择方案2，代码更简洁且无需动态编译
• 若需高度自定义字段逻辑，方案1的自定义转换器更灵活
• 简单场景或小数据量下，方案3的手动拼接最直接，无额外依赖

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