通过 CSVHelper 使用属性使 headers 更易于阅读

Question

我正在尝试使用 CSVHelper 序列化由多个 classes 构建的数据库，如下所示。我想通过添加有关单位的信息（在适当的时候）和对数据进行排序以使 "Name" 始终首先出现，从而使 csv 更易于阅读。其余的可以按任何顺序出现。

我有一个 class 如下所示。

[DataContract(IsReference = true)]
public class OpaqueMaterial : LibraryComponent
{
    [DataMember]
    [Units("W/m.K")]
    public double Conductivity { get; set; } = 2.4;

    [DataMember]
    public string Roughness { get; set; } = "Rough";
}
[DataContract]
public abstract class LibraryComponent
{
     [DataMember, DefaultValue("No name")]
     public string Name { get; set; } = "No name";
}

为了避免为每个 class 编写单独的读写函数，我正在使用如下所示的模板函数进行读写：

public void writeLibCSV<T>(string fp, List<T> records)
{
    using (var sw = new StreamWriter(fp))
    {
        var csv = new CsvWriter(sw);
        csv.WriteRecords(records);
    }
}
public List<T> readLibCSV<T>(string fp)
{
    var records = new List<T>();
    using (var sr = new StreamReader(fp))
    {
        var csv = new CsvReader(sr);
        records = csv.GetRecords<T>().ToList();
    }
    return records;
}

然后我在代码中使用它来读写：

writeLibCSV<OpaqueMaterial>(folderPath + @"\OpaqueMaterial.csv", lib.OpaqueMaterial.ToList());
List<OpaqueMaterial> inOpaqueMaterial = readLibCSV<OpaqueMaterial>(folderPath + @"\OpaqueMaterial.csv");

CSV 输出如下所示：

Conductivity, Roughnes, Name
2.4, Rough, No Name

我想出柜：

Name, Conductivity [W/m.K], Roughness
No Name, 2.4, Rough

我知道可以使用以下地图重新排序：

public class MyClassMap : ClassMap<OpaqueMaterial>
{
    public MyClassMap()
    {
        Map(m => m.Name).Index(0);
        AutoMap();
    }
}

我想将其抽象化，这样我就不必对每个 class 应用不同的映射。我找不到可以帮助添加自定义 headers 的示例。任何建议或帮助将不胜感激。

Answer 1

您可以创建 ClassMap<T> 的通用版本，它将使用反射自动检查类型 T，然后根据它找到的属性和可能或可能存在的属性动态构建映射可能没有附加到它。

在不太了解 CsvHelper 库的情况下，像这样的东西应该可以工作：

public class AutoMap<T> : ClassMap<T>
{
    public AutoMap()
    {
        var properties = typeof(T).GetProperties();

        // map the name property first
        var nameProperty = properties.FirstOrDefault(p => p.Name == "Name");
        if (nameProperty != null)
            MapProperty(nameProperty).Index(0);

        foreach (var prop in properties.Where(p => p != nameProperty))
            MapProperty(prop);
    }

    private MemberMap MapProperty(PropertyInfo pi)
    {
        var map = Map(typeof(T), pi);

        // set name
        string name = pi.Name;
        var unitsAttribute = pi.GetCustomAttribute<UnitsAttribute>();
        if (unitsAttribute != null)
            name = $"{name} {unitsAttribute.Unit}";
        map.Name(name);

        // set default
        var defaultValueAttribute = pi.GetCustomAttribute<DefaultValueAttribute>();
        if (defaultValueAttribute != null)
            map.Default(defaultValueAttribute.Value);

        return map;
    }
}

现在，您只需为要支持的每个类型 T 创建一个 AutoMap<T>。

我已经为 UnitsAttribute 和 DefaultValueAttribute 添加了示例，如果您需要更多属性，应该可以让您了解如何处理更多属性。

通过 CSVHelper 使用属性使 headers 更易于阅读

Use attributes to make headers more human readable with CSVHelper

c#

attributes

csvhelper