如何為枚舉類型添加說明

枚舉類型大家在平時程序中經常會用到，先看下面的列子

enum Orientation
        {
            East,
            South,
            West,
            North
        }

上面代碼定義了一個方向的枚舉類型，包括東、南、西、北四個值，這樣似乎也沒有問題，但是我們是中國人，有時候看中文會更加習慣一些，更重要的是在做數據顯示的時候，利用Enum.GetNames方法也只能獲得像“North”這樣的英文，而得不到理想中的“北”。這種情況，尤其是在數據綁定的時候將十分的麻煩，還需要另外寫代碼將“東、南、西、北”的字符定義出來，再與具體的枚舉值關聯起來。

為了解決這個問題，可以直接將值的字符串定義成中文，如下所示。

enum Orientation
        {
            東,
            南,
            西,
            北
        }

這樣，通過Enum.GetNames方法就可以獲得“東、南、西、北”這樣的字符了。但是這樣的編碼也太違背編碼習慣了，畢竟中文字符變量讓人看起來十分的別扭。如何解決這個問題呢？答案就是使用Attribute！下面就是示例代碼。

enum Orientation
        {
            [DescriptionAttribute("東")]
            East,
            [DescriptionAttribute("南")]
            South,
            [DescriptionAttribute("西")]
            West,
            [DescriptionAttribute("北")]
            North
        }

但又如何獲取DescriptionAttribute的內容呢？呵呵，答案就是通過反射。下面是我封裝獲取DescriptionAttribute內容的擴展方法。

static string GetDescription<T>(this T value)
        {
            var memInfo = value.GetType().GetMember(value.ToString());
            var attributes = memInfo[0].GetCustomAttributes(typeof(DescriptionAttribute), false).Cast<DescriptionAttribute>();
            if (attributes.Any())
                return attributes.First().Description;
            return string.Empty;
        }

下面就是測試的代碼以及測試結果

static class Program
    {
        enum Orientation
        {
            [DescriptionAttribute("東")]
            East,
            [DescriptionAttribute("南")]
            South,
            [DescriptionAttribute("西")]
            West,
            [DescriptionAttribute("北")]
            North
        }
        static string GetDescription<T>(this T value)
        {
            var memInfo = value.GetType().GetMember(value.ToString());
            var attributes = memInfo[0].GetCustomAttributes(typeof(DescriptionAttribute), false).Cast<DescriptionAttribute>();
            if (attributes.Any())
                return attributes.First().Description;
            return string.Empty;
        }
        static void Main()
        {
            foreach (var s in Enum.GetValues(typeof(Orientation)))
            {
                Console.WriteLine("值：{0}\t\t說明：{1}",s.ToString(),s.GetDescription());
            }
        }        
    }

 

從輸出可以看出，程序成功的獲取了枚舉值的說明內容，這樣就可以利用這種模式方便的對枚舉值添加中文說明，然后在需要的時候提取出來，如：需要做數據綁定的時候。