[小技巧]C#中如何為列舉型別新增描述方法

背景

在我們的日常開發中，我們會經常使用列舉型別。有時我們只需要顯示列舉的值或者列舉值對應名稱， 但是在某些場景下，我們可能需要將列舉值顯示為不同的字串。

例： 當前我們有如下列舉Level

這個列舉有4個可選值B, N, G, VG。 現在我們希望用Bad, Normal, Good, Very Good作為B, N, G, VG的顯示值。

那我們會怎麼做呢？通常我們最常想到的就是針對Level列舉型別編寫一個擴充套件方法。

以上的程式碼在我們的專案中很常用。但是這裡有2個潛在的問題：

• 我們的專案中可能不止一種列舉型別，所以我們可能就需要為每一種型別都新增一個對應的擴充套件方法。

• 列舉值和列舉的顯示值的程式碼位置是分離的，如果你查詢列舉值對應的顯示值，你就要先去找到對應的列舉擴充套件方法。

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

使用DescriptionAttribute重構程式碼

其實.NET中已經提供了一個文字描述屬性類DescriptionAttribute， 這個屬性類的建構式可以接收一段文字描述。

下麵我們使用DescriptionAttribute來改造Level列舉型別。

這樣我們上面提到的第二個問題就解決了，現在Level列舉型別的列舉值和顯示值就都封裝在了一起。

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

這裡我們可以針對Enum型別新增擴充套件方法，並使用反射讀取當前列舉值所對應的顯示值

由於Enum型別是所有列舉型別的基型別，所以所有的列舉型別都可以使用這個擴充套件方法。

總結

本篇博文中，我們講解瞭如果如何.NET內建的文字描述屬性類DescriptionAttribute來生成列舉值對應的文字，它不僅可以減少重覆程式碼，還可以讓整個列舉型別的內聚性更高。