C#怎么实现枚举Enum转中文描述_C#利用Description特性显示名称【小工具】

落静同学_9462

落静同学_9462

2026-04-23

835人浏览

原创

正确做法是用DescriptionAttribute为枚举成员附加中文描述元数据,配合反射安全获取(需判空),高频场景应预缓存字典,对外部非法值须先校验IsDefined再转换。

c#怎么实现枚举enum转中文描述_c#利用description特性显示名称【小工具】

用 DescriptionAttribute 给枚举加中文描述,不是直接写字符串

枚举值默认只能显示英文标识符(比如 Gender.Male 显示为 Male),想显示“男”“女”,不能靠重命名枚举成员——那会破坏代码可读性和序列化兼容性。正确做法是用 DescriptionAttribute 附加元数据。

实操时注意三点:

  • DescriptionAttribute 在 System.ComponentModel 命名空间下,别漏引用 using System.ComponentModel;
  • 必须写在枚举成员上,不是枚举类型上;每个成员单独加,不继承
  • 别和 DisplayAttribute 混用(后者属于 ASP.NET Core,依赖更多包,纯控制台或 WinForms 项目里用 DescriptionAttribute 更轻量)
public enum Gender
{
    [Description("未知")]
    Unknown,
    [Description("男")]
    Male,
    [Description("女")]
    Female
}

用反射 + GetCustomAttribute 取出 Description 文本

取值逻辑很简单:拿到枚举值 → 获取其 FieldInfo → 查 DescriptionAttribute → 读 Description 属性。但容易错在没判空或忽略非匹配情况。

常见错误现象:NullReferenceException 或返回空字符串,通常是因为:

  • 枚举成员没加 [Description(...)],GetCustomAttribute 返回 null
  • 误用了 typeof(Gender).GetField(value.ToString()),但 ToString() 对带 Flag 的枚举或数字值不可靠(比如 (Gender)99 没对应成员)
  • 用 GetCustomAttributes(复数)却只取第一个,没检查数组长度

推荐写法(安全、简洁):

public static string GetDescription(this Enum value)
{
    var field = value.GetType().GetField(value.ToString());
    if (field == null) return value.ToString();
    
    var attr = field.GetCustomAttribute<descriptionattribute>();
    return attr?.Description ?? value.ToString();
}</descriptionattribute>

性能敏感场景别每次反射——缓存 Dictionary

如果在高频循环(如 DataGridView 大量绑定、日志批量输出)里反复调用 GetDescription,反射开销明显。.NET 6+ 可用 Enum.GetNames + 静态构造函数预热缓存;老版本建议手动建字典。

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载

关键点:

  • 缓存必须是静态的,且按枚举类型分桶(不能所有枚举共用一个字典)
  • 初始化时机选在第一次访问,避免类加载时就触发反射(影响启动速度)
  • 别用 ConcurrentDictionary——单次初始化无并发,反而增加复杂度

示例(线程安全的懒初始化):

private static readonly Dictionary<gender string> _genderDescCache = 
    Enum.GetValues<gender>()
        .ToDictionary(x => x, x => x.GetDescription());</gender></gender>

遇到 ArgumentException: 未找到名称为“xxx”的枚举常量 怎么办

这个错误通常出现在把整数(比如数据库查出的 int)强制转枚举再取描述时,例如:((Gender)dbValue).GetDescription()。问题在于 dbValue 是非法值(如 -1、99),ToString() 会失败。

解决路径很明确:

  • 先用 Enum.IsDefined(typeof(Gender), dbValue) 校验合法性
  • 不合法时,要么抛业务异常,要么 fallback 到默认描述(如“无效”)
  • 别依赖 try/catch 捕获 ArgumentException——性能差,且掩盖了数据一致性问题

更稳妥的扩展方法:

public static string GetDescriptionSafely(this Type enumType, object value)
{
    if (!Enum.IsDefined(enumType, value)) 
        return "未知";
    return ((Enum)Enum.ToObject(enumType, value)).GetDescription();
}

实际用的时候,最常被忽略的是缓存粒度和非法值兜底——尤其当枚举用于前后端交互或数据库映射时,外部输入永远比你想象中更“野”。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

c#

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3469

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2408

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1340

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1278

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1396

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2298

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3740

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

17435

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Gradle 安全最佳实践
Gradle 安全最佳实践

共0课时 | 0人学习

Gradle Wrapper 使用与安全指南
Gradle Wrapper 使用与安全指南

共0课时 | 0人学习

Golangci-lint命令行使用演示
Golangci-lint命令行使用演示

共0课时 | 0人学习