使用属性可以使用CSVHelper使标题更具人性化

时间:2018-01-29 20:40:03

标签: c# attributes csvhelper

我正在尝试使用CSVHelper序列化由多个类构成的数据库,如下所示。我想通过添加单位信息(适当时)和排序数据使得“名称”始终首先出现,使csv更具人性化。其余的可以按任何顺序排列。

我有一个如下所示的课程。

[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";
}

为了避免为每个类编写seprarate读写函数,我正在使用模板化函数进行读写,如下所示:

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();
    }
}

我想将这个抽象化,以便我不必对每个类应用不同的映射。我无法找到可以帮助添加自定义标头的示例。任何建议或帮助将不胜感激。

1 个答案:

答案 0 :(得分:2)

您可以创建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;
    }
}

现在,您只需要为要支持的每种类型AutoMap<T>创建T

我添加了UnitsAttributeDefaultValueAttribute的示例,如果您需要更多内容,应该可以了解如何继续使用更多属性。