C#中如何为枚举类型添加描述方法【小技巧】

背景

在我们的日常开发中，我们会经常使用枚举类型。枚举类型（enum type）是具有一组命名常量的独特的值类型。在以下示例中：

enum color
{ 
  red,
  green,
  blue
}

声明一个名为 color 的枚举类型，该类型具有三个成员：red、green 和 blue。

枚举具体是怎么声明呢？枚举声明用于声明新的枚举类型。枚举声明以关键字 enum 开始，然后定义该枚举类型的名称、可访问性、基础类型和成员。具体格式：

修饰词（new、public、protected、internal、private）enum 枚举类型名:整数类型

{ 
  enum-member-declarations,
  enum-member-declaration
}

有时我们只需要显示枚举的值或者枚举值对应名称， 但是在某些场景下，我们可能需要将枚举值显示为不同的字符串。

例： 当前我们有如下枚举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来生成枚举值对应的文本，它不仅可以减少重复代码，还可以让整个枚举类型的内聚性更高。