讲师中心 微信公众号
AI工具推荐 视频效率加速

C#怎么获取枚举描述信息_C# Enum自定义Description读取【核心】

小浩姑娘_5235

小浩姑娘_5235

发布时间:2026-05-04 09:28:36

|

738人浏览过

|

来源于php中文网

原创

GetCustomAttribute读取枚举项的DescriptionAttribute需手动为每个枚举值添加[Description("xxx")]特性,反射获取时必须针对字段而非类型,未添加则返回null,不可fallback到字段名;推荐封装扩展方法并缓存结果。

c#怎么获取枚举描述信息_c# enum自定义description读取【核心】

用 GetCustomAttribute 读取枚举项的 DescriptionAttribute

直接上核心:C# 枚举本身不带描述信息,必须手动给每个值加 [Description("xxx")],再用反射读取。没加这个特性,GetCustomAttribute 就返回 null,不会 fallback 到字段名。

常见错误是以为加了注释或 XML doc 就能读到——不行,只有 DescriptionAttribute 才被标准方式识别。

  • Enum.GetNames(typeof(MyEnum)) 只返回字段名字符串,不涉及任何自定义属性
  • 必须对每个枚举值(而非类型)调用 GetCustomAttribute<DescriptionAttribute>()
  • 推荐封装成扩展方法,避免每次重复写反射逻辑
public static string GetDescription(this Enum value)
{
    var field = value.GetType().GetField(value.ToString());
    var attr = field?.GetCustomAttribute<DescriptionAttribute>();
    return attr?.Description ?? value.ToString();
}

为什么不能用 ToString() 或 GetName() 获取描述

ToString() 默认输出字段名;Enum.GetName() 也是字段名。它们完全不检查任何特性,性能虽好但和描述无关。

容易踩的坑:有人误以为 value.ToString("G") 或 "F" 格式能触发描述读取——不会,这些只是格式化输出规则,和元数据无关。

C#
C#

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

下载
  • 字段名含空格或特殊符号时,ToString() 会原样输出,但 Description 可以写成自然语言
  • 同一个枚举值可能有多个别名场景(比如 "Active" 和 "启用中"),靠 Description 更灵活
  • 若字段名是缩写(如 Pending),而 UI 需要显示 "等待审批",就必须依赖 Description

处理 null、空字符串和未定义 Description 的安全读取

实际项目里,不是每个枚举值都加了 Description,有些加了但值为空字符串,还可能遇到反射失败(比如动态生成的枚举)。硬解包会抛异常或返回意外结果。

  • 务必判空 attr,再取 attr.Description,否则 NRE
  • 建议默认 fallback 到 value.ToString(),而不是抛异常或返回 null
  • 如果业务要求“必须有描述”,那就单独校验,不要混在通用读取逻辑里
  • 注意:DescriptionAttribute 构造函数接受空字符串,所以 attr.Description == "" 是合法且可能有意为之

性能影响和缓存建议

反射读取 DescriptionAttribute 每次都会走元数据查找,高频调用(如表格渲染千条枚举数据)会有明显开销。

  • 不要在循环里反复调用 GetField() + GetCustomAttribute()
  • 推荐静态只读字典缓存:键为 Enum 值,值为描述字符串,首次访问时初始化
  • 注意泛型约束:where TEnum : Enum 在 .NET 5+ 才支持,旧版本需用 where TEnum : struct, IConvertible 加运行时类型检查
  • 缓存 key 用 Convert.ToInt64(value) 而非 value.GetHashCode(),避免底层表示变化导致错乱

最常被忽略的是缓存粒度——按枚举类型缓存比按单个值缓存更合理,毕竟一个枚举所有值的描述基本固定,没必要每个值单独查一次反射。

热门AI工具

更多
Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

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

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

2669

2023.06.20

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

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

2128

2023.07.25

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

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

1100

2023.08.02

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

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

1038

2023.08.09

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

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

1276

2023.09.05

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

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

1938

2023.09.20

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

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

2980

2023.09.20

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

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

12915

2023.09.22

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

80

2026.09.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Conan 2 Essentials 免费课程
Conan 2 Essentials 免费课程

共0课时 | 0人学习

CMake 与 Conan 集成实践
CMake 与 Conan 集成实践

共0课时 | 0人学习

Conan 2 高级依赖模型介绍
Conan 2 高级依赖模型介绍

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn