相关文章推荐
强健的猕猴桃  ·  NumberStyles 枚举 ...·  9 小时前    · 
行走的苹果  ·  C# ...·  9 小时前    · 
调皮的饼干  ·  postgresql - ...·  1 年前    · 
不拘小节的瀑布  ·  python ...·  1 年前    · 

枚举类型概述

枚举类型使用 enum 关键字声明。是值类型,但不能定义任何方法、属性、事件。(PS. 可以使用“扩展方法”模拟向枚举类型添加方法)

每个枚举类型都从 System.Enum 派生,后者从 System.ValueType 派生,而 System.ValueType System.Object 派生。

枚举类型定义的符号是常量值,在编译时,会用对应的数值替换引用了枚举类型的符号。这意味着运行时可能不需要定义了枚举类型的程序集。

在构建系统的时候,创建一组符号名来对应已知的数值会很方便,例如,以下 Days 类型定义了一组符号,每个符号都标识一周中的一天。 该变量只能存储七个有意义的值:

internal enum Days
    Sunday,     // 星期天
    Monday,     // 星期一
    Tuesday,    // 星期二
    Wednesday,  // 星期三
    Thursday,   // 星期四
    Friday,     // 星期五
    Saturday    // 星期六

默认情况下,第一个元素的值会设置为 0 ,其余的按照 n+1 递推。根据需要,我们也可以改变第一个元素的初始值,如:

internal enum Days
    Sunday = 101,   // 星期天
    Monday,         // 星期一  = 102
    Tuesday,        // 星期二  = 103
    Wednesday,      // 星期三  = 104
    Thursday,       // 星期四  = 105
    Friday,         // 星期五  = 106
    Saturday        // 星期六  = 107

枚举值也不一定是连续的,如:

internal enum Days
    Sunday = 107,     // 星期天
    Monday = 101,     // 星期一
    Tuesday = 109,    // 星期二
    Wednesday = 108,  // 星期三
    Thursday = 106,   // 星期四
    Friday = 102,     // 星期五
    Saturday = 105    // 星期六
用来保存枚举值的存储类型默认是 int,我们也可以改成其它基元类型(byte, sbyte, short, ushort, uint, long, ulong)。如将 Days 枚举类型的实际存储值设置为 byte ,可以这么写:
internal enum Days : byte
    Sunday,     // 星期天
    Monday,     // 星期一
    Tuesday,    // 星期二
    Wednesday,  // 星期三
    Thursday,   // 星期四
    Friday,     // 星期五
    Saturday    // 星期六

这么做的好处是可以节省内存,但要注意每一个值必需在其范围内。C#编译器为了简化本身的实现,要求只能指定基元类型名称,如果指定 Int32,会显示以下错误信息:

应输入类型 byte、sbyte、short、ushort、int、uint、long 或 ulong

枚举类型的好处

其实,在实际使用中我们也可以使用 0 表示 星期天1 表示 星期一,以此类推,如下:

public const int Sunday = 0;
public const int Monday = 1;
public const int Tuesday = 2;
public const int Wednesday = 3;
public const int Thursday = 4;
public const int Friday = 5;
public const int Saturday = 6;

不过,使用枚举类型而不使用数值类型有以下好处:

  • 枚举类型使代码变得更容易编写、阅读和维护,在 Visual Studio 中,IntelliSense 能向开发者显示有意义的符号名称,开发者不用费心去记住每个数值代表的含义;
  • 枚举类型是强类型,明确指定哪些值是变量的有效值。
  • C#枚举类型操作归纳(二)

    C#编译器将枚举类型视为基元类型,所以可用操作符(==, !=, <, >, <=, >=, +, -, ^, &, |, ~, ++和--)来操作枚举类型的实例。例如:
    class Program
        internal enum Days : byte
            Sunday,     // 星期天
            Monday,     // 星期一
            Tuesday,    // 星期二
            Wednesday,  // 星期三
            Thursday,   // 星期四
            Friday,     // 星期五
            Saturday    // 星期六
        static void Main(string[] args)
            byte k = Days.Friday - Days.Monday;
            Console.WriteLine(k);
            Console.WriteLine((Days)k);
            Console.ReadKey();
    

    输出结果为:

    Thursday

    枚举常用操作大多使用了类 System.Enum 里的方法。 该类定义了很多用来查询和转换某个枚举的方法。

    1、静态方法 Enum.GetUnderlyingType(Type enumType)

    它返回指定枚举的基础类型(用于保存枚举类型值的数据类型)。对于上述的 Days 枚举类型,返回的就是 System.Byte

    2、从 System.Enum 继承的 ToString() 方法

    它把枚举值映射为以下几种字符串表示:

    Days sunday = Days.Sunday;
    Console.WriteLine(sunday);                  // "Sunday" (常规格式)
    Console.WriteLine(sunday.ToString());       // "Sunday" (常规格式)
    Console.WriteLine(sunday.ToString("G"));    // "Sunday" (常规格式)
    Console.WriteLine(sunday.ToString("D"));    // "0" (十进制格式)
    Console.WriteLine(sunday.ToString("X"));    // "00" (十六进制格式)

    使用十六进制格式时,输出几位数取决于枚举的基础类型,如有必要会添加前导零:

    基础类型位数 byte/sbyte short/ushort int/uint long/ulong

    3、如果希望获取某个枚举变量值,只需要根据底层存储类型对枚举变量进行强制类型转换即可,如:

    Console.WriteLine("{0} = {1}", sunday.ToString(), (byte)sunday);

    Sunday = 0

    4、静态方法Enum.Format(Type enumType, object value, string format)

    通过指定期望的格式化标志来提供更好的格式化选项,如:

    Console.WriteLine(Enum.Format(typeof(Days), (byte)5, "G"));
    Console.WriteLine(Enum.Format(typeof(Days), Days.Friday, "G"));
    Console.WriteLine(Days.Friday.ToString("G"));

    输出结果都是:Friday

    Format() 方法有一个 ToString() 方法没有的优势:允许为 value 参数传递数值。不过 ToString() 方法所需要编写的代码更少,更容易调用。

    5、静态方法 Enum.GetValues()

    它返回 System.Array 的一个实例,数组中的每一项都对应指定枚举的一个成员,如:

    Days[] dayses = (Days[])Enum.GetValues(typeof(Days));
    foreach (Days d in dayses)
        Console.WriteLine("{0:D}: {0:G}", d);
    
    foreach (var d in new Days().GetType().GetEnumValues())
        Console.WriteLine("{0:D}: {0:G}", d);
    

    输出结果同上。

    7、System.EnumSystem.Type 类型还提供以下方法来返回枚举类型的符号

    System.Enum :

    // 返回数值的字符串表示(在指定枚举中检索具有指定值的常数的名称)
    public static string GetName(Type enumType, object value);
    // 返回一个String数组,枚举中的每一个符号都对应一个String(检索指定枚举中常数名称的数组)
    public static string[] GetNames(Type enumType);

    System.Type :

    // 返回数值的字符串表示(当前枚举类型中具有指定值的常数的名称)
    public virtual string GetEnumName(object value);
    // 返回一个String数组,枚举中的每一个符号都对应一个String(当前枚举类型中各个成员的名称)
    public virtual string[] GetEnumNames();

    8、静态方法 Enum.Parse()Enum.TryParse()

    public static object Parse(Type enumType, string value);
    public static object Parse(Type enumType, string value, bool ignoreCase);
    public static bool TryParse<TEnum>(string value, out TEnum result) where TEnum : struct;
    public static bool TryParse<TEnum>(string value, bool ignoreCase, out TEnum result) where TEnum : struct;

    使用示例:

    // days_1被初始化为 Days.Sunday
    Days days_1 = (Days)Enum.Parse(typeof(Days), "sunday", true);
    // 抛出异常:System.ArgumentException: 未找到请求的值“sunday”
    Days days_2 = (Days)Enum.Parse(typeof(Days), "sunday", false);
    Days day_3;
    Days day_4;
    // days_3被赋为: Days.Saturday
    Enum.TryParse<Days>("Saturday", false, out days_3);
    // days_4被赋为: Days.Saturday
    Enum.TryParse<Days>("6", false, out days_3);

    9、静态方法 Enum.IsDefined()

    用于判断数值对于某枚举类型是否合法,如:

    // True
    Console.WriteLine(Enum.IsDefined(typeof(Days), 1));
    // True
    Console.WriteLine(Enum.IsDefined(typeof(Days), "Saturday"));
    // False,检查区分大小写
    Console.WriteLine(Enum.IsDefined(typeof(Days), "saturday"));
    // False
    Console.WriteLine(Enum.IsDefined(typeof(Days), 9));

    1、该方法总是执行区分大小写的查找,而且完全没有办法让它执行不区分大小写的查找;

    2、执行速度慢,因为它在内部使用了反射,如果写代码来手动检查每一个可能的值,应用程序的性能极有可能变得更好。

    [Display(Name
    = "星期天", Description = "周日")] Sunday, [Display(Name = "星期一", Description = "周一"))] Monday, [Display(Name = "星期二", Description = "周二"))] Tuesday, [Display(Name = "星期三", Description = "周三"))] Wednesday, [Display(Name = "星期四", Description = "周四"))] Thursday, [Display(Name = "星期五", Description = "周五"))] Friday, [Display(Name = "星期六", Description = "周六"))] Saturday
    /// <summary>
    /// 获取特性 (DisplayAttribute) 的名称;如果未使用该特性,则返回枚举的名称。
    /// </summary>
    /// <param name="enumValue"></param>
    /// <returns></returns>
    public static string GetDisplayName(this Enum enumValue)
        FieldInfo fieldInfo = enumValue.GetType().GetField(enumValue.ToString());
        DisplayAttribute[] attrs =
            fieldInfo.GetCustomAttributes(typeof(DisplayAttribute), false) as DisplayAttribute[];
        return attrs.Length > 0 ? attrs[0].Name : enumValue.ToString();
    /// <summary>
    /// 获取特性 (DisplayAttribute) 的说明;如果未使用该特性,则返回枚举的名称。
    /// </summary>
    /// <param name="enumValue"></param>
    /// <returns></returns>
    public static string GetDisplayDescription(this Enum enumValue)
        FieldInfo fieldInfo = enumValue.GetType().GetField(enumValue.ToString());
        DisplayAttribute[] attrs =
            fieldInfo.GetCustomAttributes(typeof(DisplayAttribute), false) as DisplayAttribute[];
        return attrs.Length > 0 ? attrs[0].Description : enumValue.ToString();
    

    调用如下:

     Console.WriteLine(Days.Saturday.GetDisplayName()); // 输出:星期六 Console.WriteLine(Days.Saturday.GetDisplayDescription()); // 输出:周六

    二、Description特性

    枚举定义:

    internal enum Days : byte
        [Description("星期天")]
        Sunday,
        [Description("星期一")]
        Monday,
        [Description("星期二")]
        Tuesday,
        [Description("星期三")]
        Wednesday,
        [Description("星期四")]
        Thursday,
        [Description("星期五")]
        Friday,
        [Description("星期六")]
        Saturday
    
    /// <summary>
    /// 获取特性 (DescriptionAttribute) 的说明;如果未使用该特性,则返回枚举的名称。
    /// </summary>
    /// <param name="enumValue"></param>
    /// <returns></returns>
    public static string GetDescription(this Enum enumValue)
        FieldInfo fieldInfo = enumValue.GetType().GetField(enumValue.ToString());
        DescriptionAttribute[] attrs =
            fieldInfo.GetCustomAttributes(typeof(DescriptionAttribute), false) as DescriptionAttribute[];
        return attrs.Length > 0 ? attrs[0].Description : enumValue.ToString();
    

    调用如下:

    Console.WriteLine(Days.Saturday.GetDescription()); // 输出:星期六
    

    三、自定义特性

    声明一个class并继承Attribute:

    public class StringValueAttribute : Attribute
        public StringValueAttribute(string value)
            this.StringValue = value;
        public string StringValue
            [CompilerGenerated]
            get;
            [CompilerGenerated]
            set;
    

    枚举扩展类:

    public static class EnumExtensions
        /// <summary>
        /// 获取特性 (DisplayAttribute) 的名称;如果未使用该特性,则返回枚举的名称。
        /// </summary>
        /// <param name="enumValue"></param>
        /// <returns></returns>
        public static string GetStringValue(this Enum enumValue)
            FieldInfo fieldInfo = enumValue.GetType().GetField(enumValue.ToString());
            StringValueAttribute[] attrs =
                fieldInfo.GetCustomAttributes(typeof(StringValueAttribute), false) as StringValueAttribute[];
            return attrs.Length > 0 ? attrs[0].StringValue : enumValue.ToString();
    
    internal enum Days : byte
        [StringValue("星期天")]
        Sunday,
        [StringValue("星期一")]
        Monday,
        [StringValue("星期二")]
        Tuesday,
        [StringValue("星期三")]
        Wednesday,
        [StringValue("星期四")]
        Thursday,
        [StringValue("星期五")]
        Friday,
        [StringValue("星期六")]
        Saturday
    Console.WriteLine(Days.Saturday.GetStringValue()); // 输出:星期六

    四、C#获取枚举值特性封装

    枚举扩展方法类封装:

    using System;
    using System.ComponentModel;
    using System.ComponentModel.DataAnnotations;
    using System.Reflection;
    namespace Lin.EnumExt
        public static class EnumExtensions
            /// <summary>
            /// 获取特性 (DisplayAttribute) 的名称;如果未使用该特性,则返回枚举的名称。
            /// </summary>
            /// <param name="enumValue"></param>
            /// <returns></returns>
            public static string GetDisplayName(this Enum enumValue)
                FieldInfo fieldInfo = enumValue.GetType().GetField(enumValue.ToString());
                DisplayAttribute[] attrs =
                    fieldInfo.GetCustomAttributes(typeof(DisplayAttribute), false) as DisplayAttribute[];
                return attrs.Length > 0 ? attrs[0].Name : enumValue.ToString();
            /// <summary>
            /// 获取特性 (DisplayAttribute) 的说明;如果未使用该特性,则返回枚举的名称。
            /// </summary>
            /// <param name="enumValue"></param>
            /// <returns></returns>
            public static string GetDisplayDescription(this Enum enumValue)
                FieldInfo fieldInfo = enumValue.GetType().GetField(enumValue.ToString());
                DisplayAttribute[] attrs =
                    fieldInfo.GetCustomAttributes(typeof(DisplayAttribute), false) as DisplayAttribute[];
                return attrs.Length > 0 ? attrs[0].Description : enumValue.ToString();
            /// <summary>
            /// 获取特性 (DescriptionAttribute) 的说明;如果未使用该特性,则返回枚举的名称。
            /// </summary>
            /// <param name="enumValue"></param>
            /// <returns></returns>
            public static string GetDescription(this Enum enumValue)
                FieldInfo fieldInfo = enumValue.GetType().GetField(enumValue.ToString());
                DescriptionAttribute[] attrs =
                    fieldInfo.GetCustomAttributes(typeof(DescriptionAttribute), false) as DescriptionAttribute[];
                return attrs.Length > 0 ? attrs[0].Description : enumValue.ToString();
            /// <summary>
            /// 直接获取特性(更轻量、更容易使用,不用封装“获取每一个自定义特性”的扩展方法)
            /// </summary>
            /// <typeparam name="T"></typeparam>
            /// <param name="enumValue"></param>
            /// <returns></returns>
            public static T GetAttributeOfType<T>(this Enum enumValue) where T : Attribute
                Type type = enumValue.GetType();
                MemberInfo[] memInfo = type.GetMember(enumValue.ToString());
                object[] attributes = memInfo[0].GetCustomAttributes(typeof(T), false);
                return (attributes.Length > 0) ? (T)attributes[0] : null;