C# 枚举(enum)的最佳实践 – 如何优雅地处理枚举类型

C#枚举最佳实践包括:明确适用场景、用[Flags]处理位域、避免magic number、添加DescriptionAttribute、考虑智能枚举类、统一JSON序列化为字符串、显式定义0值成员。

c# 枚举(enum)的最佳实践 - 如何优雅地处理枚举类型

在 C# 开发中,枚举(enum)是一种非常实用的值类型,用于定义一组命名常量,提升代码可读性和维护性。但若使用不当,反而会造成歧义、难以扩展甚至运行时错误。以下是关于如何优雅地处理 C# 枚举类型的若干最佳实践。

1. 明确使用 enum 的场景

枚举适用于表示一组固定的、逻辑相关的常量。比如状态码、操作类型、配置选项等。

不要将 enum 用于可能频繁变动或数量不确定的值集合。例如用户角色如果经常增减,更适合用字符串或数据库字典表管理,而不是硬编码 enum。

说明:enum 是编译期常量,一旦发布修改需重新部署。

2. 使用 [Flags] 特性处理位域枚举

当需要表示多个选项组合时(如权限、样式),应使用 [Flags] 特性,并确保枚举值为 2 的幂次。

正确示例:

[Flags]public enum FileAccess{    None = 0,    Read = 1,    Write = 2,    Execute = 4,    All = Read | Write | Execute}

这样可以用按位或组合权限:FileAccess.Read | FileAccess.Write,并能通过 .ToString() 输出 “Read, Write” 这样的可读字符串。

3. 避免 magic number,始终从 enum 值派生

不要在代码中直接使用数字比较或赋值,比如 status == 2。应始终引用 enum 成员:status == OrderStatus.Shipped

如果必须与整数交互(如数据库存储),使用显式转换并做好验证:

if (Enum.IsDefined(typeof(OrderStatus), value)){    var status = (OrderStatus)value;}

避免 Enum.Parse 直接强转,防止无效值引发异常。

4. 为 enum 添加描述性文本(Description Attribute)

默认的 enum 成员名称受限于标识符规则,无法包含空格或特殊字符。可通过 DescriptionAttribute 扩展其显示文本。

public enum LogLevel{    [Description("调试信息")]    Debug,    [Description("警告")]    Warning,    [Description("严重错误")]    Critical}

配合扩展方法提取描述:

public static string GetDescription(this Enum value){    var field = value.GetType().GetField(value.ToString());    var attribute = (DescriptionAttribute)Attribute.GetCustomAttribute(field, typeof(DescriptionAttribute));    return attribute?.Description ?? value.ToString();}

调用:LogLevel.Critical.GetDescription() 返回“严重错误”。

5. 考虑使用强类型枚举类(Smart Enum)

对于复杂场景(如需要附加行为、验证、映射),推荐使用“智能枚举”模式——即以类模拟 enum 行为。

例如:

public class OrderStatus : IEquatable{    public static readonly OrderStatus Pending = new("待付款", 1);    public static readonly OrderStatus Shipped = new("已发货", 2);
public string Name { get; }public int Value { get; }private OrderStatus(string name, int value) => (Name, Value) = (name, value);public override string ToString() => Name;public bool Equals(OrderStatus other) => Value == other?.Value;

}

这种方式更灵活,支持序列化、国际化、方法扩展等,适合业务关键型状态。

6. 序列化与 JSON 处理建议

在 Web API 中,默认 Newtonsoft.Json 或 System.Text.Json 会将 enum 序列化为名称字符串(推荐),而非数字。

确保配置一致:

// 在 Startup.cs 或 Program.cs 中设置services.AddControllers()    .AddJsonOptions(options =>    {        options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter());    });

这样输出为 "status": "Shipped" 而非 "status": 2,提高接口可读性和兼容性。

7. 不要忽略默认值陷阱

C# 中 enum 的默认值是 0,即使没有定义对应成员。这可能导致逻辑错误。

解决办法:

显式定义一个 None = 0Unknown = 0 成员,表明初始状态。在使用前校验是否为有效值:Enum.IsDefined(typeof(MyEnum), value)

基本上就这些。合理使用 enum 可让代码更清晰,结合特性与模式还能应对复杂需求。关键是根据场景选择合适方式,避免过度简化或过度设计。

以上就是C# 枚举(enum)的最佳实践 - 如何优雅地处理枚举类型的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1442769.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2025年12月17日 19:22:35
下一篇 2025年12月17日 19:22:48

相关推荐

  • 构建模拟:从头开始的实时交易模拟器

    简介 嘿,开发社区!我很高兴分享我的业余项目 Simul8or – 一个实时日间交易模拟器,旨在为用户提供一个无风险的环境来练习交易策略。该项目 100% 构建在 ASP.NET WebForms、C#、JavaScript、CSS 和 SQL Server 技术堆栈上,没有外部库或框架。从头开始构…

    2025年12月24日
    300
  • 什么是功能类优先的 CSS 框架?

    理解功能类优先 tailwind css 是一款功能类优先的 css 框架,用户可以通过组合功能类轻松构建设计。为了理解功能类优先,我们首先要区分语义类和功能类这两种 css 类名命名方式。 语义类 以前比较常见的 css 命名方式是根据页面中模块的功能来命名。例如: 立即学习“前端免费学习笔记(深…

    2025年12月24日
    000
  • SCSS – 增强您的 CSS 工作流程

    在本文中,我们将探索 scss (sassy css),这是一个 css 预处理器,它通过允许变量、嵌套规则、mixins、函数等来扩展 css 的功能。 scss 使 css 的编写和维护变得更加容易,尤其是对于大型项目。 1.什么是scss? scss 是 sass(syntropically …

    2025年12月24日
    000
  • 使用 React 构建 Fylo 云存储网站

    介绍 在这篇博文中,我们将逐步介绍如何使用 react 创建一个功能丰富的云存储网站。该网站受 fylo 启发,提供了主页、功能、工作原理、感言和页脚等部分。在此过程中,我们将讨论用于构建这个完全响应式网站的结构、组件和样式。 项目概况 该项目由多个部分组成,旨在展示云存储服务。每个部分都是用 re…

    2025年12月24日 好文分享
    000
  • 使用 React 构建食谱查找器网站

    介绍 在本博客中,我们将使用 react 构建一个食谱查找网站。该应用程序允许用户搜索他们最喜欢的食谱,查看趋势或新食谱,并保存他们最喜欢的食谱。我们将利用 edamam api 获取实时食谱数据并将其动态显示在网站上。 项目概况 食谱查找器允许用户: 按名称搜索食谱。查看趋势和新添加的食谱。查看各…

    2025年12月24日 好文分享
    200
  • 不可变数据结构:ECMA 4 中的记录和元组

    不可变数据结构:ecmascript 2024 中的新功能 ecmascript 2024 引入了几个令人兴奋的更新,但对我来说最突出的一个功能是引入了不可变数据结构。这些新结构——记录和元组——改变了 javascript 中数据管理的游戏规则。它们提供了一种令人满意的方式来保持我们的数据健全、安…

    2025年12月24日
    100
  • css3选择器优化技巧

    CSS3 选择器优化技巧可提升网页性能:减少选择器层级,提高浏览器解析效率。避免通配符选择器,减少性能损耗。优先使用 ID 选择器,快速定位目标元素。用类选择器代替标签选择器,精确匹配。使用属性选择器,增强匹配精度。巧用伪类和伪元素,提升性能。组合多个选择器,简化代码。利用 CSS 预处理器,增强代…

    2025年12月24日
    300
  • 花 $o 学习这些编程语言或免费

    → Python → JavaScript → Java → C# → 红宝石 → 斯威夫特 → 科特林 → C++ → PHP → 出发 → R → 打字稿 []https://x.com/e_opore/status/1811567830594388315?t=_j4nncuiy2wfbm7ic…

    2025年12月24日
    000
  • css代码规范有哪些

    CSS 代码规范对于保持一致性、可读性和可维护性至关重要,常见的规范包括:命名约定:使用小写字母和短划线,命名特定且描述性。缩进和对齐:按特定规则缩进、对齐选择器、声明和值。属性和值顺序:遵循特定顺序排列属性和值。注释:解释复杂代码,并使用正确的语法。分号:每个声明后添加分号。大括号:左大括号前换行…

    2025年12月24日
    200
  • 深入理解CSS框架与JS之间的关系

    深入理解CSS框架与JS之间的关系 在现代web开发中,CSS框架和JavaScript (JS) 是两个常用的工具。CSS框架通过提供一系列样式和布局选项,可以帮助我们快速构建美观的网页。而JS则提供了一套功能强大的脚本语言,可以为网页添加交互和动态效果。本文将深入探讨CSS框架和JS之间的关系,…

    2025年12月24日
    000
  • HTML+CSS+JS实现雪花飘扬(代码分享)

    使用html+css+js如何实现下雪特效?下面本篇文章给大家分享一个html+css+js实现雪花飘扬的示例,希望对大家有所帮助。 很多南方的小伙伴可能没怎么见过或者从来没见过下雪,今天我给大家带来一个小Demo,模拟了下雪场景,首先让我们看一下运行效果 可以点击看看在线运行:http://hai…

    2025年12月24日 好文分享
    500
  • 10款好看且实用的文字动画特效,让你的页面更吸引人!

    图片和文字是网页不可缺少的组成部分,图片运用得当可以让网页变得生动,但普通的文字不行。那么就可以给文字添加一些样式,实现一下好看的文字效果,让页面变得更交互,更吸引人。下面创想鸟就来给大家分享10款文字动画特效,好看且实用,快来收藏吧! 1、网页玻璃文字动画特效 模板简介:使用css3制作网页渐变底…

    2025年12月24日 好文分享
    000
  • css和c的区别是什么

    区别是:1、C语言是一门面向过程、抽象化的通用程序设计语言、计算机编程语言,广泛应用于底层开发;2、CSS是一种用来表现HTML或XML等文件样式的计算机语言,可以做到网页和内容进行分离的一种样式语言。 本教程操作环境:windows7系统、CSS3&&HTML5版、Dell G3电…

    2025年12月24日
    000
  • tp5如何引入css文件

    tp5引入css文件的方法:1、将css文件放在public目录下的static文件里即可;2、在页面引入中写上“”语句即可。 本教程操作环境:windows7系统、CSS3&&HTML5版、Dell G3电脑。 其实很简单,只需要将css,js,image文件放在这个目录下即可 页…

    2025年12月24日
    000
  • 聊聊CSS 与 JS 是如何阻塞 DOM 解析和渲染的

    本篇文章给大家介绍一下css和js阻塞 dom 解析和渲染的原理。有一定的参考价值,有需要的朋友可以参考一下,希望对大家有所帮助。 hello~各位亲爱的看官老爷们大家好。估计大家都听过,尽量将CSS放头部,JS放底部,这样可以提高页面的性能。然而,为什么呢?大家有考虑过么?很长一段时间,我都是知其…

    2025年12月24日
    200
  • js如何修改css样式

    js修改css样式的方法:1、使用【obj.className】来修改样式表的类名;2、使用【obj.style.cssTest】来修改嵌入式的css;3、使用【obj.className】来修改样式表的类名;4、使用更改外联的css。 本教程操作环境:windows7系统、css3版,DELL G…

    2025年12月24日
    000
  • 如何使用纯CSS、JS实现图片轮播效果

    本篇文章给大家详细介绍一下使用纯css、js实现图片轮播效果的方法。有一定的参考价值,有需要的朋友可以参考一下,希望对大家有所帮助。 .carousel {width: 648px;height: 400px;margin: 0 auto;text-align: center;position: a…

    2025年12月24日
    000
  • css怎么设置文件编码

    在css中,可以使用“@charset”规则来设置编码,语法格式“@charset “字符编码类型”;”。“@charset”规则可以指定样式表中使用的字符编码,它必须是样式表中的第一个元素,并且不能以任何字符开头。 本教程操作环境:windows7系统、CSS3&&…

    2025年12月24日
    000
  • js如何修改css

    js修改css的方法:1、使用【obj.style.cssTest】来修改嵌入式的css;2、使用【bj.className】来修改样式表的类名;3、使用更改外联的css文件,从而改变元素的css。 本教程操作环境:windows7系统、css3版,DELL G3电脑。 js修改css的方法: 方法…

    2025年12月24日
    000
  • js如何改变css样式

    js改变css样式的方法:1、使用cssText方法;2、使用【setProperty()】方法;3、使用css属性对应的style属性。 本教程操作环境:windows7系统、css3版,DELL G3电脑。 js改变css样式的方法: 第一种:用cssText div.style.cssText…

    2025年12月24日
    000

发表回复

登录后才能评论
关注微信