C#中如何爲枚舉類型添加描述方法【小技巧】

相信很多人對枚舉並不陌生，枚舉可以很方便和直觀的管理一組特定值。下面這篇文章主要給大家介紹了關於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來生成枚舉值對應的文本，它不僅可以減少重複代碼，還可以讓整個枚舉類型的內聚性更高。