在.NET Core中获取枚举值中文描述的方法详解

更新时间：2025年10月16日 09:07:07 作者：MartinYangHJ

这篇文章主要为大家详细介绍了在.NET Core中获取枚举值中文描述的相关方法,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下

1. 创建自定义特性

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. 创建扩展方法

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：获取单个枚举值的描述
UserStatus status = UserStatus.Active;
string description = status.GetDescription();
Console.WriteLine($"状态描述: {description}"); // 输出: 状态描述: 已激活

// 示例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();

打印结果：

Hello, World!
状态描述: 已激活
Inactive: 未激活
Active: 已激活
Disabled: 已禁用
Pending: 待审核
值: 0, 描述: 未激活
值: 1, 描述: 已激活
值: 2, 描述: 已禁用
值: 3, 描述: 待审核

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

如果不想创建自定义特性，也可以直接使用 .NET 内置的 DescriptionAttribute，代码如下：

using System.ComponentModel;

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

// 修改扩展方法中的引用
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();
    }
}

到此这篇关于在.NET Core中获取枚举值中文描述的方法详解的文章就介绍到这了,更多相关.NET Core获取枚举值中文描述内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

.NET适配器模式讲解
这篇文章主要为大家详细介绍了ASP.NET适配器模式的相关资料,具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2016-11-11
Asp.Net使用Npoi导入导出Excel的方法
这篇文章主要介绍了Asp.Net使用Npoi导入导出Excel的方法,采用该方法在导出Excel的时候不需要office组件的支持,而在导入Excel的时候采用OleDb的方式，需要office组件的支持。是一个非常实用的技巧,需要的朋友可以参考下
2014-09-09
ASP.NET中日历控件和JS版日历控件的使用方法(第5节)
这篇文章主要为大家详细介绍了ASP.NET中日历控件和JS版日历控件的使用方法，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2015-08-08
.NET 水晶报表使用代码
下面就是介绍在.net下，如何使用水晶报表的方法。
2009-04-04
.NET异步编程模式的三种类型介绍
这篇文章介绍了.NET异步编程模式的三种类型，文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2022-03-03
.NET中如何使用依赖注入DI
依赖注入简称DI,是一种软件设计模式,其核心思想是将对象依赖关系的管理交由外部容器负责,而不是由对象自身管理,下面我们就来看看.NET中如何使用依赖注入DI吧
2024-12-12
ASP.NET全栈开发教程之在MVC中使用服务端验证的方法
这篇文章主要给大家介绍了关于ASP.NET全栈开发教程之在MVC中使用服务端验证的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2018-07-07
把字符串转为HtmlTable演示动画
怎样将字符串转为.cs页面中的HtmlTable，在论坛上看到了这样一个问题，想试着把它解决下，感兴趣的朋友可以观看下本文的动画，或许对你有所帮助
2013-03-03
ASP.NET下上传图片到数据库，并且读出图片的代码(详细版)
上传图片到数据库，从数据库的创建到数据库中图片的现实都给出了具体的代码，因为asp.net版本的问题，大家可能需要稍微修改下。
2010-07-07
c# NameValueCollection类读取配置信息
c#中的NameValueCollection类读取配置信息,大家可以参考下。
2009-04-04