背景
在我們的日常開發中，我們會經常使用枚舉類型。枚舉類型（enum type）是具有一組命名常量的獨特的值類型。在以下示例中：
|
1
2
3
4
5
6
|
enum Color{ Red, Green, Blue} |
聲明一個名為 Color 的枚舉類型，該類型具有三個成員：Red、Green 和 Blue。
枚舉具體是怎么聲明呢？枚舉聲明用于聲明新的枚舉類型。枚舉聲明以關鍵字 enum 開始，然后定義該枚舉類型的名稱、可訪問性、基礎類型和成員。具體格式：
修飾詞（new、public、protected、internal、private）enum 枚舉類型名:整數類型
|
1
2
3
4
|
{ enum-member-declarations, enum-member-declaration} |
有時我們只需要顯示枚舉的值或者枚舉值對應名稱， 但是在某些場景下，我們可能需要將枚舉值顯示為不同的字符串。
例： 當前我們有如下枚舉Level
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
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枚舉類型編寫一個擴展方法。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
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枚舉類型。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
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類型添加擴展方法，并使用反射讀取當前枚舉值所對應的顯示值
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
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類型是所有枚舉類型的基類型，所以所有的枚舉類型都可以使用這個擴展方法。
總結
本篇博文中，我們講解了如果如何C#中如何為枚舉類型添加描述方法，它不僅可以減少重復代碼，還可以讓整個枚舉類型的內聚性更高。
原文鏈接：http://www.cnblogs.com/lwqlun/p/10380992.html
