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

背景

為南皮等地區(qū)用戶提供了全套網(wǎng)頁設(shè)計制作服務(wù)，及南皮網(wǎng)站建設(shè)行業(yè)解決方案。主營業(yè)務(wù)為網(wǎng)站設(shè)計、做網(wǎng)站、南皮網(wǎng)站設(shè)計，以傳統(tǒng)方式定制建設(shè)網(wǎng)站，并提供域名空間備案等一條龍服務(wù)，秉承以專業(yè)、用心的態(tài)度為用戶提供真誠的服務(wù)。我們深信只要達到每一位用戶的要求，就會得到認可，從而選擇與我們長期合作。這樣，我們也可以走得更遠！

在我們的日常開發(fā)中，我們會經(jīng)常使用枚舉類型。枚舉類型（enum type）是具有一組命名常量的獨特的值類型。在以下示例中：

enum Color
{ 
  Red,
  Green,
  Blue
}

聲明一個名為 Color 的枚舉類型，該類型具有三個成員：Red、Green 和 Blue。

枚舉具體是怎么聲明呢？枚舉聲明用于聲明新的枚舉類型。枚舉聲明以關(guān)鍵字 enum 開始，然后定義該枚舉類型的名稱、可訪問性、基礎(chǔ)類型和成員。具體格式：

修飾詞（new、public、protected、internal、private）enum 枚舉類型名:整數(shù)類型

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

有時我們只需要顯示枚舉的值或者枚舉值對應(yīng)名稱，但是在某些場景下，我們可能需要將枚舉值顯示為不同的字符串。

例：當(dāng)前我們有如下枚舉Level

 public enum Level
 {
  //Bad
  B = -1,

  //Normal
  N = 0,

  //Good
  G = 1,

  //Very Good 
  VG = 2
 }

這個枚舉有4個可選值B, N, G, VG。現(xiàn)在我們希望用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個潛在的問題：

我們的項目中可能不止一種枚舉類型，所以我們可能就需要為每一種類型都添加一個對應(yīng)的擴展方法。
枚舉值和枚舉的顯示值的代碼位置是分離的，如果你查找枚舉值對應(yīng)的顯示值，你就要先去找到對應(yīng)的枚舉擴展方法。

那么如何改進這部分代碼，從而消除上述2個問題呢，這時候我們就要引入.NET中的文本描述屬性類DescriptionAttribute。

使用DescriptionAttribute重構(gòu)代碼

其實.NET中已經(jīng)提供了一個文本描述屬性類DescriptionAttribute，這個屬性類的構(gòu)造函數(shù)可以接收一段文字描述。

下面我們使用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
 }

這樣我們上面提到的第二個問題就解決了，現(xiàn)在Level枚舉類型的枚舉值和顯示值就都封裝在了一起。

那么第一個問題該怎么解決呢？

這里我們可以針對Enum類型添加擴展方法，并使用反射讀取當(dāng)前枚舉值所對應(yīng)的顯示值

 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)
   {
    //如果沒有定義描述，就把當(dāng)前枚舉值的對應(yīng)名稱返回
    return val.ToString();
   }

   return (attributes.Single() as DescriptionAttribute).Description;
  }
 }

由于Enum類型是所有枚舉類型的基類型，所以所有的枚舉類型都可以使用這個擴展方法。

總結(jié)

本篇博文中，我們講解了如果如何.NET內(nèi)置的文本描述屬性類DescriptionAttribute來生成枚舉值對應(yīng)的文本，它不僅可以減少重復(fù)代碼，還可以讓整個枚舉類型的內(nèi)聚性更高。

本文標題：C#中如何為枚舉類型添加描述方法【小技巧】
文章地址：http://muchs.cn/article42/jpgjhc.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供微信小程序、靜態(tài)網(wǎng)站、手機網(wǎng)站建設(shè)、云服務(wù)器、定制開發(fā)、定制網(wǎng)站

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請盡快告知，我們將會在第一時間刪除。文章觀點不代表本網(wǎng)站立場，如需處理請聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時需注明來源：創(chuàng)新互聯(lián)

猜你還喜歡下面的內(nèi)容