[小技巧]C#中如何為列舉型別新增描述方法
背景
在我們的日常開發中,我們會經常使用列舉型別。有時我們只需要顯示列舉的值或者列舉值對應名稱, 但是在某些場景下,我們可能需要將列舉值顯示為不同的字串。
例: 當前我們有如下列舉 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
來生成列舉值對應的文字,它不僅可以減少重複程式碼,還可以讓整個列舉型別的內聚性更高。