- A+
所属分类:ASP.NET
在我们的日常开发中,我们会经常使用枚举类型。有时我们只需要显示枚举的值或者枚举值对应名称, 但是在某些场景下,我们可能需要将枚举值显示为不同的字符串。
- //例: 当前我们有如下枚举Level
- public enum Level
- {
- //Bad
- B = -1,
- //Normal
- N = 0,
- //Good
- G = 1,
- //Very Good
- VG = 2
- }
这个枚举有4个可选值B, N, G, VG。 现在我们希望用Bad, Normal, Good, Very Good作为B, N, G, VG的显示值。
那我们会怎么做呢?通常我们最常想到的就是针对Level枚举类型编写一个扩展方法。
- public static class LevelEnumExtension
- {
- public static string ToDescription(this Level level)
- {
- switch (level)
- {
- case Level.B:
- return "Bad";
- case Level.G:
- return "Good";
- case Level.N:
- return "Normal";
- case Level.VG:
- return "Very Good";
- default:
- return "Normal";
- }
- }
- }
-
以上的代码在我们的项目中很常用。但是这里有2个潜在的问题:
- 我们的项目中可能不止一种枚举类型,所以我们可能就需要为每一种类型都添加一个对应的扩展方法。
- 枚举值和枚举的显示值的代码位置是分离的,如果你查找枚举值对应的显示值,你就要先去找到对应的枚举扩展方法。
那么如何改进这部分代码,从而消除上述2个问题呢,这时候我们就要引入.NET中的文本描述属性类DescriptionAttribute。
使用DescriptionAttribute重构代码
其实.NET中已经提供了一个文本描述属性类DescriptionAttribute, 这个属性类的构造函数可以接收一段文字描述。
- //下面我们使用DescriptionAttribute来改造Level枚举类型。
- public enum Level
- {
- //Bad
- [Description("Bad")]
- B = -1,
- //Normal
- [Description("Normal")]
- N = 0,
- //Good
- [Description("Good")]
- G = 1,
- //Very Good
- [Description("Very Good")]
- VG = 2
- }
这样我们上面提到的第二个问题就解决了,现在Level枚举类型的枚举值和显示值就都封装在了一起。
那么第一个问题该怎么解决呢?
这里我们可以针对Enum类型添加扩展方法,并使用反射读取当前枚举值所对应的显示值
- public static class EnumExtension
- {
- public static string ToDescription(this Enum val)
- {
- var type = val.GetType();
- var memberInfo = type.GetMember(val.ToString());
- var attributes = memberInfo[0].GetCustomAttributes(typeof(DescriptionAttribute), false);
- if (attributes == null || attributes.Length != 1)
- {
- //如果没有定义描述,就把当前枚举值的对应名称返回
- return val.ToString();
- }
- return (attributes.Single() as DescriptionAttribute).Description;
- }
- }
由于Enum类型是所有枚举类型的基类型,所以所有的枚举类型都可以使用这个扩展方法。
总结
本篇博文中,我们讲解了如果如何.NET内置的文本描述属性类DescriptionAttribute来生成枚举值对应的文本,它不仅可以减少重复代码,还可以让整个枚举类型的内聚性更高。