C# 枚举在项目中使用心得

阅读目录

  • 基本介绍
  • 使用注意
  • 使用方法
  • 扩展用法

本文主要是我在项目中对C#枚举的使用心得，如有不足的地方欢迎您指出。

一、基本介绍

　  枚举是由一组特定常量构成的一组数据结构，是值类型的一种特殊形式，当需要一个由指定常量集合组成的数据类型时，使用枚举类型。枚举声明可以显式地声明 byte、sbyte、short、ushort、int、uint、long 或 ulong 类型作为对应的基础类型。没有显式地声明基础类型的枚举声明意味着所对应的基础类型是 int。

　　在代码中使用枚举，可以将以前笨拙的代码变得优雅简单，更加直观，方便记忆。

　　枚举在什么地方适用呢？一条普遍规则是，任何使用常量的地方，例如目前用 switch 代码切换常量的地方。如果只有单独一个值（例如，鞋的最大尺寸，或者笼子中能装猴子的最大数目），则还是把这个任务留给常量吧。但是，如果定义了一组值，而这些值中的任何一个都可以用于特定的数据类型，那么将枚举用在这个地方最适合不过。

例1：一个字段表示类型。你可以使用整数1、2、3代表原创、转载、翻译三种类型。这种表示法可以使用，但它不直观。此时应该使用枚举。

例2：表示星期的SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY,SATURDAY, 就是应该定义成一个枚举。

二、使用注意

　  1、 对于没有赋值的枚举类型，声明的第一个枚举成员它的默值为零。以后的枚举成员值是将前一个枚举成员（按照文本顺序）的值加1得到的。

　  2 、允许多个枚举成员有相同的值。没有显示赋值的枚举成员的值，总是前一个枚举成员的值+1。

三、使用方法

　  .NET中的枚举我们一般有两种常见用法，一是表示唯一的元素序列，例如一周里的各天，订单状态，文章类型等；还有就是用来表示多种复合的状态，例如表示权限，因为可同时有多个不同权限。

1、基本用法

　  这里用文章类型来举例，就不过多的说明了，直接用程序说话吧，代码中的 [Description("原创")]，会在后面进行说明。

C# Code


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

  
using System;
using System.ComponentModel;
using System.Reflection;
using System.Collections.Generic;
using System.Data.SqlClient;
using System.Data;

namespace MyLaboratory
{
    /// <summary>
    /// 订单状态的枚举类型
    /// </summary> 
    public enum ArticleType
    {
        /// <summary>
        /// 原创
        /// </summary> 
        [Description("原创")]
        Original = 1,

/// <summary>
        /// 翻译
        /// </summary> 
        [Description("翻译")]
        Translate = 2,

/// <summary>
        /// 转载 
        /// </summary> 
        [Description("转载")]
        Reproduced = 3
    }

/// <summary>
    /// 文章类，此处简化了，为了演示只设计了三个字段
    /// </summary>
    public class Article
    {
        private int _id;
        private string _title = "";
        private ArticleType _type;

/// <summary>
        /// 文章编号
        /// </summary>
        public int ID
        {
            get { return _id; }
            set { _id = value; }
        }

/// <summary>
        /// 文章标题
        /// </summary>
        public string Title
        {
            get { return _title; }
            set { _title = value; }
        }

/// <summary>
        /// 文章类型
        /// </summary>
        public ArticleType Type
        {
            get { return _type; }
            set { _type = value; }
        }

/// <summary>
        /// 添加一篇文章
        /// </summary>
        /// <returns></returns>
        public bool Add()
        {
            //影响的行数
            int EffectRow = 0;
            using (SqlConnection conn = new SqlConnection("数据库连接串"))
            {
                SqlCommand cmd = new SqlCommand("INSERT INTO Article(ID,Title,Type) VALUES(@ID,@Title,@Type)", conn);
                cmd.Parameters.Add(new SqlParameter("@ID", this._id));
                cmd.Parameters.Add(new SqlParameter("@Title", this._title));
                cmd.Parameters.Add(new SqlParameter("@Type", this._type)); //枚举属性直接使用即可
                conn.Open();
                EffectRow = cmd.ExecuteNonQuery();
            }
            return EffectRow == 1 ? true : false;            
        }

/// <summary>
        /// 获取文章的详情
        /// </summary>
        public void GetInfo()
        {
            //从数据库中读取订单信息
            DataSet ds = new DataSet();
            using (SqlConnection conn = new SqlConnection("数据库连接串"))
            {
                SqlDataAdapter da = new SqlDataAdapter("SELECT * FROM Article WHERE [email protected]", conn);
                da.SelectCommand.Parameters.Add(new SqlParameter("@ID", this._id));
                conn.Open();
                da.Fill(ds, "Article");
            }

if (ds != null && ds.Tables.Count > 0 && ds.Tables[0].Rows.Count > 0)
            {
                //将字符串转化成枚举类型
                this._type = (ArticleType)Enum.Parse(typeof(ArticleType), ds.Tables[0].Rows[0]["Type"].ToString());
                this._title = ds.Tables[0].Rows[0]["Title"].ToString();
            }
        }
    }
}

2、高级用法

　  为了说明表示多种组合状态，拿用户的权限来举例。此时需要在枚举上加[Flags]特性来标记位域。

C# Code


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

  
/// <summary>
/// 权限枚举
/// </summary>
[Flags]
public enum Permission
{
    [Description("未知")]
    Unknown = 0,//也可以写成0x00或0

[Description("创建")]
    Create = 1 << 0,//0x01或1

[Description("读取")]
    Read = 1 << 1,//0x02或2

[Description("修改")]
    Update = 1 << 2,//0x04或4

[Description("删除")]
    Delete = 1 << 3//0x08或8
}

　  注意加了[Flags]特性后有三种写法，一种是使用<<符号，第二种是0x01，还有一种是直接写0,1,2,4,8...，一般来说是2的n次方来表示。

C# Code


1
2
3
4
5
6
7
8
9
10
11
12
13
14

  
 //1，给用户创建，读取，修改和删除的权限
var permission = Permission.Create | Permission.Read | Permission.Update | Permission.Delete;

//2，去掉用户的修改和删除权限
//permission = permission ^ Permission.Update;这种写法有bug，如果重复执行又加回去了
permission = permission & ~Permission.Update;
permission = permission & ~Permission.Delete;

//3，给用户加上修改的权限    
permission = permission | Permission.Update;

//4，判断用户是否有创建的权限    
var isCreate = (permission & Permission.Create) != 0;  //或者var isCreate =(permission & Permission.Create)== Permission.Create

　  这时permission枚举的值将变成 0+1+4=5，它的ToString()将变成"Permission.Create , Permission.Read,Permission.Update" 
　  这里我们可以解释为什么第五个值Delete是8.而不能为5。也就是说它的值不应该是前几项值的复合值。一个比较简单的方法就是用2的n次方来依次为每一项赋值，例如 1,2,4,8,16,32,64.....

　  在数据库中可以这样来判断：

AND (@permission IS NULL OR (permission & @permission) =@permission)

四、扩展用法

　

　  下面来扩展一下枚举的用法，讲解一下使用枚举带来的另外两个额外红利。

1、获取枚举的扩展属性

　  前面例子中的文章类(Article)，其中属性(Type)如果不使用枚举，而是分别对应Int数值1、2、3，那么在文章列表（WEB页面）中显示类型一般如下处理。

ASP.NET MVC Code


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

  
@{
    if (ViewBag.List != null)
    {
        List<MyLaboratory.Article> list = (List<MyLaboratory.Article>)ViewBag.list;
        foreach (Article article in list)
        {
            string TypeName = "";
            if (article.Type == 1)
            {
                TypeName = "原创";
            }
            else if (article.Type == 2)
            {
                TypeName = "翻译";
            }
            else if (article.Type == 3)
            {
                TypeName = "转载";
            }
            <tr>

<td>@article.ID</td>
                <td>@article.Title</td>
                <td>@TypeName</td>
            </tr>
        }
    }
}

按上面的代码，如果类型进行增加或删除，那上面这段代码也需要修改，如果有多个页面包含类似的代码，那进行一次修改，代码的维护量还是挺大的，还有漏改的风险。如果使用枚举，则可以通过Description来给枚举增加扩展说明，在显示枚举的地方直接显示扩展说明，代码如下：

1)、在定义枚举值时，加入Description扩展属性，通过添加GetEnumDescription方法来获取枚举的扩展属性，我把GetEnumDescription放到了一个公共类（Utility）中，这样方便调用。

C# Code


1
2
3
4
5
6
7
8
9
10
11
12
13
14

  
public class Utility
{
    /// <summary>
    /// 获取一个枚举值的中文描述
    /// </summary>
    /// <param name="obj">枚举值</param>
    /// <returns></returns>
    public static string GetEnumDescription(Enum obj)
    {
        FieldInfo fi = obj.GetType().GetField(obj.ToString());
        DescriptionAttribute[] arrDesc = (DescriptionAttribute[])fi.GetCustomAttributes(typeof(DescriptionAttribute), false);
        return arrDesc[0].Description;
    }
}

2)、调用的代码如下(ASP.NET MVC)

ASP.NET MVC Code


1
2
3
4
5
6
7
8
9
10
11
12
13
14

  
@{
    if (ViewBag.List != null)
    {
        List<MyLaboratory.Article> list = (List<MyLaboratory.Article>)ViewBag.list;
        foreach (MyLaboratory.Article article in list)
        {
            <tr>

<td>@article.ID</td>
                <td>@article.Title</td>
                <td>@MyLaboratory.Utility.GetEnumDescription(article.Type)</td>
            </tr>
        }
    }
}

2、遍历枚举值，生成Dictionary<int, string>。

接着上面的例子，如果文章需要一个添加页面，里面有一个下拉列表框显示文章的类型，在不使用枚举的情况下，一般的写法如下：

HTML Code


1
2
3
4
5

  
<select id="Type" name="Type">
    <option value="1">原创</option>
    <option value="2">翻译</option>
    <option value="3">转载 </option>
</select>

这样和之前遇到的问题相同，解决的方法还是通过枚举。

1)、在实例类中增加一个方法获取枚举类型的所有键值，生成字典

C# Code


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

  
/// <summary>
/// 获取文章类型的枚举的键/值字典
/// </summary>
/// <returns></returns>
public static Dictionary<int, string> GetTypeDict()
{
    Dictionary<int, string> dict = new Dictionary<int, string>();
    Type t = typeof(ArticleType);
    Array arrays = Enum.GetValues(t);
    for (int i = 0; i < arrays.LongLength; i++)
    {
        ArticleType tmp = (ArticleType)arrays.GetValue(i);
        string Description = Utility.GetEnumDescription(tmp);
        dict.Add((int)tmp, Description);
    }
    return dict;
}

2)、调用的代码如下：

ASP.NET MVC Code


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

  
<select id="Type" name="Type">
@{
    Dictionary<int, string> dict = MyLaboratory.Utility.GetStatusDict();
    if (dict.Count > 0)
    {
        foreach (KeyValuePair<int, string> kvp in dict)
        {
            if (kvp.Key != 0)
            {
                <option value="@kvp.Key">@kvp.Value</option>
            }
        }
    }
}               
</select>
时间： 2024-08-07 00:13:45

C# 枚举在项目中使用心得的相关文章

json json-rpc 如何在项目中的使用心得

部分转自:http://www.cnblogs.com/legoras/articles/1328620.html Joyrock简介: Joyrock是一个基于LGPL协议的开源项目,实现了JSON和JSON-RPC,支持微软ASP.NET框架.它方便我们读取从浏览器流向服务器的JSON对象,也方便在响应流中写入JSON对象.    Jayrock 远程方法要求写在一个ashx中,页面请求这个ashx的时候,在ProcessRequest 中根据Request对象中的参数信息,确定请求的服务器

项目中的小心得（以后慢慢积累起来）

       1:变量,对象只声明了,而没有初始化 是不能用,不能来装东西的!!! 谨记谨记!!!!       2:两个头文件不能相互的包含,会造成循环引用,解决办法:在其中的一个头文件中的类用@class引用: 项目中的小心得(以后慢慢积累起来)

关于项目中解决bug的心得

在一个比较大的项目中,二次接手项目的人员往往感觉很头疼,感觉比较茫然,下面是我解决问题的一点小小的经验 一个成熟的项目往往有着很强的逻辑,前端也尽然如此.js面向对象 遍历对象枚举属性,参数的传递 递归调用,解决方法: 1 定位问题,(看看问题出在哪个组件当中 js/ vue/ jsx等) 2 判断组件上下逻辑关系,相互依赖,被依赖,还是common config组件(尽量不要动common组件里面的东西) 3 bug所在位置,function() 是一个很好的解决问题的入口,首先在functi

项目开发中的心得体会

1.在没有获取完整的信息之前,推迟决策,直到必须做出决策的时候.2.任何事情都要建立在有效信息的基础上,当需求变更时,要当机立断.3.要敢于提出自己的质疑.4.要时常留意可以改善的问题,善于发现现有阶段存在的缺陷.5.持续学习,从更高的角度认识问题,全面把握“改善质量”的宗旨.6.软件系统是为人设计,不是为了技术而设计.最终目标是实现客户的需求,帮助客户完成相应的工作.7.软件设计是一个不断优化的过程,具体的优化途径则千万条.8.要充分理解客户的需求,只有这样,才能设计出客户切实需要的软件系统.

关于添加现有项目中的数据集的心得体会

前段时间遇到这样一个任务,需要将两个项目合并成一个项目,在项目A中添加项目B的窗体和DataSet,然后通过A打开B的窗体. 前面进展的很顺利,在添加数据集的时候,刚添加的时候会提示“类型化数据集不会进行编译,请在数据集设计器中打开数据,然后检查每个TableAdapter都已经设置为有效连接!”,具体打开B中窗体的代码就不说了,此时,若直接编译会显示很多错误,是关于无法找到连接串的... 那么该怎么解决呢? 首先打开B项目中的Properties--Settings.setting文件,会看到

如何在程序开发项目中选择合适的 JavaScript 框架，节省时间和成本的9款极佳的JavaScript框架介绍

从技术上来看,iOS,Android 和 Windows Phone 上的移动应用是使用不同的程序语言开发的,iOS 应用使用 Objective-C,Android 应用使用 Java,而 Windows Phone 应用使用 .NET. .随着 JavaScript,CSS 和 HTML 知识技能的提升,相信你也可以构建一个超赞的移动应用.在这篇博客里,我们将会介绍一些极好的 JavaScript 移动应用程序开发框架. 说到网络开发,就不得不说 JavaScript,这是一款很有前途的程序

iOS dateformatter设置GMT格式时间--iOS开发系列---项目中成长的知识四

今天在项目中开始接手客户端的签名这个模块,签名这个会在项目结束过后再单独写一下自己的心得! 今天讲讲在签名的过程中我们需要向服务器传送一个Date值,格式要求是格林威治时间,也就是GMT时间! 格式要求是 22 Oct 2015 10:20:35 GMT 而我通过[NSDate Date]获取到的格式是2015-10-22 10:20:35 所以就上网搜寻答案 说的是通过[NSDate Date]这个获取到的时间就是GMT地区的,所以我就觉得是转格式的地方出问题了 但是经过一番尝试后,无论是转格

项目中使用protobuf 3.0

protocol buffer从3.0 原生的compiler支持c++,Java,Python,Go,Ruby,JavaNano,JavaScript,Objective-C,C#,PHP这篇文章作为上一篇文章的补充,简单记录下一些变化. protobuf的开源地址为:https://github.com/google/protobuf protocol compiler下载地址为:https://github.com/google/protobuf/releases 官方定义message类

项目总结二：关于项目中一些功能的优化

前言: 最近一直在维护老的项目,遇到的问题也千奇百怪,需要修补的,需要优化的,需要特殊处理的,感觉总是那么的无语.也许这时候也应该感叹一句:路漫漫其修远兮,吾将上下而求索吧. 这篇文章就只是讲讲老项目中遇到的种种不敢苟同的代码写法,以及遇到一些问题时的处理方法. 1.关于按钮事件的重复点击问题 我们开发中大概都经历过这样的事情,我的一个button被重复的快速点击,(我们开发者应该更清楚的知道这意味着什么).那我们再深入的想一下(给这样的事件安排一个特定的环境):例如当网络较差的情况下,再例如当