快捷導(dǎo)航

在.NET Core中獲取枚舉值中文描述的方法詳解

更新時(shí)間：2025年10月16日 09:07:07 作者：MartinYangHJ

這篇文章主要為大家詳細(xì)介紹了在.NET Core中獲取枚舉值中文描述的相關(guān)方法,文中的示例代碼講解詳細(xì),感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下

1. 創(chuàng)建自定義特性

using System;

/// <summary>
/// 枚舉描述特性
/// </summary>
public class DescriptionAttribute : Attribute
{
    public string Description { get; }

    public DescriptionAttribute(string description)
    {
        Description = description;
    }
}

2. 定義使用中文描述的枚舉

public enum UserStatus
{
    [Description("未激活")]
    Inactive = 0,
    
    [Description("已激活")]
    Active = 1,
    
    [Description("已禁用")]
    Disabled = 2,
    
    [Description("待審核")]
    Pending = 3
}

3. 創(chuàng)建擴(kuò)展方法

using System;
using System.ComponentModel;
using System.Reflection;

public static class EnumExtensions
{
    /// <summary>
    /// 獲取枚舉值的描述
    /// </summary>
    /// <param name="value">枚舉值</param>
    /// <returns>描述信息</returns>
    public static string GetDescription(this Enum value)
    {
        if (value == null)
            return string.Empty;

        var field = value.GetType().GetField(value.ToString());
        if (field == null)
            return value.ToString();

        // 嘗試獲取DescriptionAttribute
        var attribute = field.GetCustomAttribute<DescriptionAttribute>();
        if (attribute != null)
            return attribute.Description;

        // 如果沒有DescriptionAttribute，返回枚舉名稱
        return value.ToString();
    }

    /// <summary>
    /// 獲取枚舉類型的所有值和描述
    /// </summary>
    /// <typeparam name="T">枚舉類型</typeparam>
    /// <returns>值和描述的字典</returns>
    public static Dictionary<int, string> GetEnumDescriptions<T>() where T : Enum
    {
        var result = new Dictionary<int, string>();
        var values = Enum.GetValues(typeof(T));

        foreach (T value in values)
        {
            result.Add(Convert.ToInt32(value), value.GetDescription());
        }

        return result;
    }

     /// <summary>
     /// 獲取枚舉類型的所有值和描述
     /// </summary>
     /// <typeparam name="T">枚舉類型</typeparam>
     /// <returns>值和描述的字典</returns>
     public static Dictionary<T, string> GetEnumDescriptionsDict<T>() where T : Enum
     {
         return Enum.GetValues(typeof(T))
                    .Cast<T>()
                    .ToDictionary(e => e, e => e.GetDescription());
     }
}

4. 使用示例

Console.WriteLine("Hello, World!");

// 示例1：獲取單個(gè)枚舉值的描述
UserStatus status = UserStatus.Active;
string description = status.GetDescription();
Console.WriteLine($"狀態(tài)描述: {description}"); // 輸出: 狀態(tài)描述: 已激活

// 示例2：遍歷所有枚舉值
foreach (UserStatus value in Enum.GetValues(typeof(UserStatus)))
{
    Console.WriteLine($"{value}: {value.GetDescription()}");
}

// 示例3：獲取所有枚舉值的字典
var statusDict = EnumExtensions.GetEnumDescriptions<UserStatus>();
foreach (var item in statusDict)
{
    Console.WriteLine($"值: {item.Key}, 描述: {item.Value}");
}
Console.ReadKey();

打印結(jié)果：

Hello, World!
狀態(tài)描述: 已激活
Inactive: 未激活
Active: 已激活
Disabled: 已禁用
Pending: 待審核
值: 0, 描述: 未激活
值: 1, 描述: 已激活
值: 2, 描述: 已禁用
值: 3, 描述: 待審核

5. 替代方案：使用 System.ComponentModel.DescriptionAttribute

如果不想創(chuàng)建自定義特性，也可以直接使用 .NET 內(nèi)置的 DescriptionAttribute，代碼如下：

using System.ComponentModel;

public enum UserStatus
{
    [Description("未激活")]
    Inactive = 0,
    
    [Description("已激活")]
    Active = 1
}

// 修改擴(kuò)展方法中的引用
public static class EnumExtensions
{
    public static string GetDescription(this Enum value)
    {
        if (value == null)
            return string.Empty;

        var field = value.GetType().GetField(value.ToString());
        if (field == null)
            return value.ToString();

        // 使用System.ComponentModel.DescriptionAttribute
        var attribute = field.GetCustomAttribute<DescriptionAttribute>();
        if (attribute != null)
            return attribute.Description;

        return value.ToString();
    }
}

到此這篇關(guān)于在.NET Core中獲取枚舉值中文描述的方法詳解的文章就介紹到這了,更多相關(guān).NET Core獲取枚舉值中文描述內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: