多个枚举描述

Question

我已经定义了以下enum：

public enum DeviceType
{
    [Description("Set Top Box")]
    Stb = 1,
    Panel = 2,
    Monitor = 3,
    [Description("Wireless Keyboard")]
    WirelessKeyboard = 4
}

我正在利用Description 属性来允许我提取出一个更易于用户阅读的枚举版本以显示在 UI 中。我使用以下代码获得描述：

var fieldInfo = DeviceType.Stb.GetType().GetField(DeviceType.Stb.ToString());

var attributes = (DescriptionAttribute[])fieldInfo.GetCustomAttributes(typeof(DescriptionAttribute), false);

var description = (attributes.Length > 0 ? attributes[0].Description : DeviceType.Stb.ToString());

上面的代码会给我：description = "Set Top Box"。如果没有设置Description 属性，它会给我枚举的字符串值。

我现在想为每个枚举添加第二个/自定义属性（例如，称为“值”）。例如：

public enum DeviceType
{
    [Description("Set Top Box")]
    [Value("19.95")]
    Stb = 1,
    [Value("99")]
    Panel = 2,
    [Value("199.99")]
    Monitor = 3,
    [Description("Wireless Keyboard")]
    [Value("20")]
    WirelessKeyboard = 4
}

我需要拉出新的Value 属性，就像我目前对Description 属性所做的一样。

是否可以扩展现有的Description 属性以以某种方式包含新的Value 属性，或者最好单独创建新属性？

Answer 1

创建一个单独称为 DeviceInformation 的新属性...

[AttributeUsage(AttributeTargets.All)]
public class DeviceInformationAttribute : DescriptionAttribute
{
    public DeviceInformationAttribute(string description, string value)
    {
        this.Description = description;
        this.Value = value;
    }

    public string Description { get; set; }
    public string Value { get; set; }
}

你也可以使用扩展方法来获取任意属性的值

static void Main(string[] args)
{
    var info = DeviceType.Stb.GetAttribute<DeviceInformationAttribute>();
    Console.WriteLine("Description: {0}\nValue:{1}",info.Description, info.Value);

}

public static class Extensions
{
    public static TAttribute GetAttribute<TAttribute>(this Enum enumValue)
            where TAttribute : Attribute
    {
        return enumValue.GetType()
                        .GetMember(enumValue.ToString())
                        .First()
                        .GetCustomAttribute<TAttribute>();
    }
}

public enum DeviceType
{
    [DeviceInformation("foobar", "100")]
    Stb = 1,
}

---

编辑

回应评论

@Aydin Adn 我确实喜欢使用扩展方法，非常好！对于没有描述但需要 Value 属性的 DeviceType.Panel 的情况，您有解决方案吗？ （参见帕特里克的回答 cmets）

 [AttributeUsage(AttributeTargets.All)]
public class DeviceInformationAttribute : Attribute
{
    public DeviceInformationAttribute(string description)
    {
        this.Description = description;
    }

    public DeviceInformationAttribute(decimal value)
    {
        this.Description = string.Empty;
        this.Value = value;
    }

    public DeviceInformationAttribute(string description, decimal value)
    {
        this.Description = description;
        this.Value = value;
    }

  
    public string Description { get; set; }
    public decimal Value { get; set; }
}

Answer 2

是的，这很容易做到。只需派生现有的DescriptionAttribute 类：

[AttributeUsageAttribute(AttributeTargets.All)]
public class DescriptionWithValueAttribute : DescriptionAttribute
{
    public DescriptionWithValueAttribute(string description, string value) : base(description)
    {
        this.Value = value;
    }

    public string Value { get; private set; }
}

那么你可以这样使用它：

public enum DeviceType
{
    [DescriptionWithValue("Set Top Box", "19.95")]
    Stb = 1,
}

您检索属性的代码几乎保持不变，只需替换类型名称。

Answer 3

为什么不在一节课上做呢。一开始还需要做更多的工作，但是：

• 使用附加值更容易扩展
• 可以使用辅助函数来创建通用元素（参见Simple()）
• 在运行时更高效，因为无需反射来获取值
• 在 Wpf 中绑定更容易 "{Binding namespace:DeviceType.All}" 和 "{Binding SomeDeviceTypeProperty.Value}"
• 没有无效值，即var invalid = (DeviceType)100;

示例代码

public class DeviceType
{
    public static readonly DeviceType
        Stb = new DeviceType("Stb", "Set Top Box", 19.95),
        Panel = new DeviceType("Panel", 99),
        Monitor = new DeviceType("Monitor", 19.95),
        Cable = Simple("Cable"),
        Connector = Simple("Connector"),
        WirelessKeyboard = new DeviceType("WirelessKeyboard", "Wireless Keyboard", 20);

    private static readonly IEnumerable<DeviceType> _all = typeof(DeviceType)
        .GetFields(BindingFlags.Public | BindingFlags.Static).Select(f => (DeviceType)f.GetValue(null)).ToArray();
    public static IEnumerable<DeviceType> All { get { return _all; } }

    public static DeviceType Parse(string name)
    {
        foreach (var item in All)
        {
            if (item.Name == name)
                return item;
        }
        throw new KeyNotFoundException(name);
    }

    private static DeviceType Simple(string name)
    {
        return new DeviceType(name, name, 9.95);
    }
    private DeviceType(string name, decimal value) : this(name, name, value) { }
    private DeviceType(string name, string description, decimal value)
    {
        Name = name;
        Description = description;
        Value = value;
    }

    public string Name { get; private set; }
    public string Description { get; private set; }
    public decimal Value { get; private set; }

    public override string ToString()
    {
        return Name;
    }
}

Answer 4

您要做的是：创建一个属性来更具体地描述枚举：您可以这样做：

public class EnumValue : Attribute
{
    public Decimal Value { get; private set; }
    public EnumValue(Decimal value)
    {
        this.Value = value;
    }
}

这可以通过这个扩展方法来使用：

private static Decimal GetEnumCustomAttribute(this Enum leEnum, Typ typ)
    {
        try
        {
            if (leEnum == null) throw new ArgumentNullException("leEnum");

            Type type = leEnum.GetType();

            MemberInfo[] memInfo = type.GetMember(leEnum.ToString());

            if (memInfo != null && memInfo.Length > 0)
            {
                object[] attrs = memInfo[0].GetCustomAttributes(typeof(EnumValue), false);

                if (attrs != null && attrs.Length > 0)
                    return ((EnumValue)attrs[0]).Value;
            }

            return Decimal.MinValue;
        }
        catch (Exception)
        {
            throw;
        }
    }

试一试！