C#的Enum——枚举

枚举

　　枚举类型声明为一组相关的符号常数定义了一个类型名称。枚举用于“多项选择”场合，就是程序运行时从编译时已经设定的固定数目的“选择”中做出决定。

　　枚举类型（也称为枚举）为定义一组可以赋给变量的命名整数常量提供了一种有效的方法。例如，假设您必须定义一个变量，该变量的值表示一周中的一天。该变量只能存储七个有意义的值。若要定义这些值，可以使用枚举类型。枚举类型是使用 enum 关键字声明的。 

enum Days { Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday };

　　默认情况下，枚举中每个元素的基础类型是 int。可以使用冒号指定另一种整数值类型。
　　如果不为枚举数列表中的元素指定值，则它们的值将以 1 为增量自动递增。在前面的示例中，Days.Sunday 的值为 0，Days.Monday 的值为 1，依此类推。创建新的 Days 对象时，如果不显式为其赋值，则它将具有默认值 Days.Sunday (0)。创建枚举时，应选择最合理的默认值并赋给它一个零值。这便使得只要在创建枚举时未为其显式赋值，则所创建的全部枚举都将具有该默认值。枚举中大小写敏感，但是建议不要这样。

枚举的优点：
　　<1>枚举可以使代码更易于维护，有助于确保给变量指定合法的、期望的值。

　　<2>枚举使代码更清晰，允许用描述性的名称表示整数值，而不是用含义模糊的数来表示。

　　<3>枚举使代码更易于键入。在给枚举类型的实例赋值时，VS.NET IDE会通过IntelliSense弹出一个包含可接受值的列表框，减少了按键次数，并能够让我们回忆起可能的值

枚举实例

　　声明： 

public enum TimeOfDay
{
    Moning = 0,
    Afternoon = 1,
    Evening = 2,
};

 

　　使用： 

 

    public string getTimeOfDay(TimeOfDay time)
    {
        string result = string.Empty;
        switch (time)
        {
            case TimeOfDay.Moning:
                result = "上午";
                break;
            case TimeOfDay.Afternoon:
                result = "下午";
                break;
            case TimeOfDay.Evening:
                result = "晚上";
                break;
            default:
                result = "未知";
                break;
        }
        return result;
    }

 

枚举方法 

 

　　<1>获取枚举字符串

 

TimeOfDay time = TimeOfDay.Afternoon;

Console.WriteLine(time.ToString());//输出：Afternoon

 

 

　　<2>Enum.Parse()方法。这个方法带3个参数，第一个参数是要使用的枚举类型。其语法是关键字typeof后跟放在括号中的枚举类名。typeof运算符将在第5章详细论述。第二个参数是要转换的字符串，第三个参数是一个bool，指定在进行转换时是否忽略大小写。最后，注意Enum.Parse()方法实际上返回一个对象引用—— 我们需要把这个字符串显式转换为需要的枚举类型(这是一个取消装箱操作的例子)。对于上面的代码，将返回1，作为一个对象，对应于TimeOfDay.Afternoon的枚举值。在显式转换为int时，会再次生成1。

 

TimeOfDay time2 = (TimeOfDay) Enum.Parse(typeof(TimeOfDay), "afternoon", true);

Console.WriteLine((int)time2);//输出1

 

 

　　<3>得到枚举的某一值对应的名称

lbOne.Text = Enum.GetName(typeof(TimeOfDay), 0);

  　 <4>得到枚举的所有的值 

foreach (int i in Enum.GetValues(typeof(TimeOfDay)))
            lbValues.Text += i.ToString();

  　　<5>枚举所有的名称 

foreach(string temp in Enum.GetNames(typeof(TimeOfDay)))
            lbNames.Text+=temp;

  

枚举和常量

 

　　优先考虑枚举。

　　在C#中，枚举的真正强大之处是它们在后台会实例化为派生于基类System.Enum的结构。这表示可以对它们调用方法，执行有用的任务。注意因为.NET Framework的执行方式，在语法上把枚举当做结构是不会有性能损失的。实际上，一旦代码编译好，枚举就成为基本类型，与int和float类似。

　　但是在实际应用中，你也许会发现，我们经常用英语定义枚举类型，因为开发工具本来就是英文开发的，美国人用起来，就直接能够明白枚举类型的含义。其实，我们在开发的时候就多了一步操作，需要对枚举类型进行翻译。没办法，谁让编程语言是英语写的，如果是汉语写的，那我们也就不用翻译了，用起枚举变得很方便了。举个简单的例子，TimeOfDay.Morning一看到Morning，美国人就知道是上午，但是对于中国的使用者来说，可能有很多人就看不懂，这就需要我们进行翻译、解释，就向上面的getTimeOfDay()的方法，其实就是做了翻译工作。所以，在使用枚举的时候，感觉到并不是很方便，有的时候我们还是比较乐意创建常量，然后在类中，声明一个集合来容纳常量和其意义。

　　使用常量定义：这种方法固然可行，但是不能保证传入的参数day就是实际限定的。

 

using System;
using System.Collections.Generic;

public class TimesOfDay
{
    public const int Morning = 0;
    public const int Afternoon = 1;
    public const int Evening = 2;
    public static Dictionary<int, string> list;
    /// <summary>
    /// 获得星期几
    /// </summary>
    /// <param name="day"></param>
    /// <returns></returns>
    public static string getTimeNameOfDay(int time)
    {
        if (list == null || list.Count <= 0)
        {
            list = new Dictionary<int, string>();
            list.Add(Morning, "上午");
            list.Add(Afternoon, "下午");
            list.Add(Evening, "晚上");
        }

        return list[time];
    }
}

 

 

希望能够找到一种比较好的方法，将枚举转为我们想要的集合。搜寻了半天终于找到了一些线索。通过反射，得到针对某一枚举类型的描述。

枚举的定义中加入描述 

using System;
using System.ComponentModel;

public enum TimeOfDay
{
    [Description("上午")]
    Moning,
    [Description("下午")]
    Afternoon,
    [Description("晚上")]
    Evening,
};

 

 　　获得值和表述的键值对

        /// <summary>
        /// 从枚举类型和它的特性读出并返回一个键值对
        /// </summary>
        /// <param name="enumType">Type,该参数的格式为typeof(需要读的枚举类型)</param>
        /// <returns>键值对</returns>
        public static NameValueCollection GetNVCFromEnumValue(Type enumType)
        {
            NameValueCollection nvc = new NameValueCollection();
            Type typeDescription = typeof(DescriptionAttribute);
            System.Reflection.FieldInfo[] fields = enumType.GetFields();
            string strText = string.Empty;
            string strValue = string.Empty;
            foreach (FieldInfo field in fields)
            {
                if (field.FieldType.IsEnum)
                {
                    strValue = ((int)enumType.InvokeMember(field.Name, BindingFlags.GetField, null, null, null)).ToString();
                    object[] arr = field.GetCustomAttributes(typeDescription, true);
                    if (arr.Length > 0)
                    {
                        DescriptionAttribute aa = (DescriptionAttribute)arr[0];
                        strText = aa.Description;
                    }
                    else
                    {
                        strText = field.Name;
                    }
                    nvc.Add(strText, strValue);
                }
            }
            return nvc;
        }

 

 

.NET中Flags枚举的使用

　.NET中的枚举我们一般有两种用法，一是表示唯一的元素序列，例如一周里的各天；还有就是用来表示多种复合的状态。这个时候一般需要为枚举加上[Flags]特性标记为位域，例如：

 

[Flags] 
enum Styles{ 
ShowBorder = 1,         //是否显示边框
ShowCaption = 2,        //是否显示标题
ShowToolbox = 4         //是否显示工具箱
} 

 

 

　　这样我们就可以用"或"运算符组合多个状态，例如：

 

 

myControl.Style = Styles.ShowBorder | Styles.ShowCaption;  

 

 

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

　　现在举个常见的Flags应用例子。例如一个简单的权限系统，有"Admin"和"User"两种角色，我们可以在表中放一个 varchar()字段，以文本形式存放权限字"Admin,User"。但是用Flags型枚举的话，我们就可以直接将 Roles.Admin | Roles.User 的值放在一个int字段里。

　　以下是关于枚举的一些常见操作：
　　将枚举的值变回枚举对象：
　　Styles style = (Styles) Enum.Parse(typeof(Styles), 4 );    // -> style = Styles.Toolbox;
　　检查枚举是否包含某个元素：
　　bool hasFlag = ((style & Styles.ShowBorder) != 0);

　　其实我们还会碰到一种情况，就是需要从组合状态中去掉一个元素。用"^"运算符可以做到：

 

 

Styles style = Styles.ShowBorder | Styles.ShowCaption; 
style = style ^ Styles.ShowBorder; 

 

 

　　这个时候style的值就会变成 Styles.ShowCaption

　　但这里有一个很严重的问题(偶现在才发现)
　　我们这个时候再执行一次
　　style = style ^ Styles.ShowBorder;
　　按照我们的设想，这个时候 style 的值是 Styles.ShowCaption，不包含 Styles.ShowBorder，所以我们就算去掉这个元素，style应该还是不会变。但实际的 style 的值却又变成了 Styles.ShowBorder | Styles.ShowCaption !! 再执行一遍，又会去掉这个元素，周而复始。
　　当然我们可以在去掉某个元素前做一番检查，如果枚举包含这个元素，再去掉它：

 

 

if ((style & Styles.ShowBorder) != 0){ 
    style = style ^ Styles.ShowBorder; 
} 

 

 

　　不知道有没有其它方法可以方便地从Flags枚举状态中去掉一个元素。。

　　Thanks to mobilebilly:
　　style = style & (~Styles.ShowBorder) 可以方便去掉一个元素。

 

好好利用枚举

      这段时间手里有个有关订单的项目，订单一般有个状态的，以前很多要时候都会想到订单的状态就那几个种，就把它写死吧，不用一个数据库表了，太浪费资源了，但写死了用一个数字来代表一种订单状态，这样在编码时还要记得什么数字代码什么状态，如果不小心把它写错了，会导致数据出错。
      后来想到.NET有个枚举，这么好的东西为何不用上来呢，这不但可以方便以后的代码维护，也方便编码。

public enum OrderState
{
    /**//// <summary>
    /// 无效状态
    /// </summary>
    Invalid = 0,
    /**//// <summary>
    /// 客户询价
    /// </summary>
    CustomerQuery = 1,
    /**//// <summary>
    /// 客户落单
    /// </summary>
    CustomerOrdered = 2,
    /**//// <summary>
    /// 客户付款
    /// </summary>
    ReceiverCustomerPayment = 4,
    /**//// <summary>
    /// 向供货商订货
    /// </summary>
    SupplierOrdered = 8,
    /**//// <summary>
    /// 供货商确认货期
    /// </summary>
    SupplierOrderTerm = 16,
    /**//// <summary>
    /// 收到货品
    /// </summary>
    RecieverGoods = 32,
    /**//// <summary>
    /// 客户取消订单
    /// </summary>
    CustomerCanceled = 64,
    /**//// <summary>
    /// 供货商取消订单
    /// </summary>
    SupplierCancelded = 128
}

但要从UI层看这些状态怎么处理呢？
利用switch case

public static string GetOrderStateString(OrderState state)
    {
        switch (state)
        {
            case OrderState.Invalid:
                return "无效值";
            case OrderState.CustomerOrdered:
                return "客户下单";
            case OrderState.CustomerCanceled:
                return "客户取消订单";
            case OrderState.CustomerQuery:
                return "客户询价";
            case OrderState.ReceiverCustomerPayment:
                return "客户已付款";
            case OrderState.RecieverGoods:
                return "订单到货";
            case OrderState.SupplierCancelded:
                return "供货商取消";
            case OrderState.SupplierOrdered:
                return "已向供货商订货";
            case OrderState.SupplierOrderTerm:
                return "供货商确认货期";
        }
        return "";
    }

 

如果以后还有更多的订单状态就修改这个枚举和一个方法就行了，这么方便的东西为何就不用到我的程序中呢，我们在编码中，要想尽方法使代码简单、易用、易维护。
枚举中有两个很实用的方法
1、GetHashCode()   //返回该实例的值的哈希代码
2、ToString()           //将此实例的值转换为其等效的字符串表示

这两个方法在编码的时候会用到，GetHashCode()这个方法使用机会会更多。
有前枚举的使用，我得出以上一点心得，与大家共享一下。