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

    xiaoxiao2022-06-29  85

    阅读目录

    基本介绍使用注意使用方法扩展用法     本文主要是我在项目中对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 ID=@ID", 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<intstring> GetTypeDict() {     Dictionary<intstring> dict = new Dictionary<intstring>();     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>
    转载请注明原文地址: https://ju.6miu.com/read-1124980.html

    最新回复(0)