萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> .NET 程式設計

C# 列舉加上 Description 屬性並轉換為鍵值對集合

C# 列舉常用於狀態值,但預設 ToString() 僅輸出名稱 (如 "Spring"),無法直接顯示友善文字 (如 "春天")。本文示範使用 DescriptionAttribute 標記列舉值,並提供擴充方法取得描述與轉換為字典。

定義帶描述的列舉

using System.ComponentModel;

public enum Season {
    [Description("春天")] Spring = 1,
    [Description("夏天")] Summer = 2,
    // Autumn 未加 Description,將回傳名稱 "Autumn"
    Autumn = 3,
    [Description("冬天")] Winter = 4
}

注意:列舉名稱不能包含空格、括號、斜線等特殊字元。

擴充方法:取得 Description

public static class EnumExtensions {
    /// <summary>
    /// 取得列舉值的 Description 屬性文字
    /// </summary>
    /// <param name="value">列舉值</param>
    /// <param name="nameInstead">無 Description 時是否回傳名稱,預設 true</param>
    /// <returns>Description 文字或 null</returns>
    public static string GetDescription(this Enum value, bool nameInstead = true) {
        Type type = value.GetType();
        string name = Enum.GetName(type, value);
        if (name == null) return null;

        FieldInfo field = type.GetField(name);
        var attr = Attribute.GetCustomAttribute(field, typeof(DescriptionAttribute)) as DescriptionAttribute;

        if (attr == null && nameInstead) return name;
        return attr == null ? null : attr.Description;
    }

    /// <summary>
    /// 將列舉轉換為 Dictionary<int, string> (值 -> 文字)
    /// </summary>
    /// <param name="enumType">列舉型別</param>
    /// <param name="getText">取得顯示文字的委派</param>
    /// <returns>鍵值對字典</returns>
    public static Dictionary<int, string> ToDictionary(this Type enumType, Func<Enum, string> getText) {
        if (!enumType.IsEnum)
            throw new ArgumentException("參數必須是列舉型別!", "enumType");

        var dict = new Dictionary<int, string>();
        var values = Enum.GetValues(enumType);
        foreach (Enum val in values) {
            int key = Convert.ToInt32(val);
            string text = getText(val);
            dict.Add(key, text);
        }
        return dict;
    }
}

使用範例

class Program {
    static void Main() {
        Season s = Season.Spring;

        // 1. 取得列舉名稱
        Console.WriteLine(s.ToString()); // "Spring"

        // 2. 取得 Description
        Console.WriteLine(s.GetDescription()); // "春天"

        // 3. 列舉轉字典:使用 Description (缺失時回傳名稱)
        var dic1 = typeof(Season).ToDictionary(e => e.GetDescription());
        PrintDic(dic1);
        /* 輸出:
        1 = 春天
        2 = 夏天
        3 = Autumn   (無 Description,回傳名稱)
        4 = 冬天
        */

        // 4. 列舉轉字典:使用 Description (缺失時回傳 null)
        var dic2 = typeof(Season).ToDictionary(e => e.GetDescription(false));
        PrintDic(dic2);
        /* 輸出:
        1 = 春天
        2 = 夏天
        3 =         (null)
        4 = 冬天
        */

        // 5. 列舉轉字典:直接使用名稱
        var dic3 = typeof(Season).ToDictionary(e => e.ToString());
        PrintDic(dic3);
    }

    static void PrintDic(Dictionary<int, string> dic) {
        foreach (var kv in dic) Console.WriteLine($"{kv.Key} = {kv.Value}");
        Console.WriteLine("---");
    }
}

應用場景

  • 下拉選單繫結:ddl.DataSource = typeof(Status).ToDictionary(e => e.GetDescription()); ddl.DataValueField = "Key"; ddl.DataTextField = "Value";
  • API 回應:將狀態碼轉為人類可讀文字
  • 日誌記錄:記錄具意義的狀態名而非數字
  • 資料庫種子資料:同步列舉定義至查詢表

進階提示

  • 可建立自訂屬性 [DisplayName]、[SortOrder] 擴充更多中繼資料
  • 搭配 System.ComponentModel.DataAnnotations 進行驗證
  • 大型專案建議使用原始碼產生器 (T4/Source Generator) 自動同步列舉與資料庫/前端定義
copyright © 萬盛學電腦網 all rights reserved