本章内容：
本章要讨论枚举类型和位标志。由于 Microsoft Windows 和许多编程语言多年来一直在使用这些结构，相信许多人已经知道了如何使用它们。不过，CLR 与 FCL 结合起来之后，枚举类型和位标志才正成为面向对象的类型。而它们提供的一些非常“酷”的功能，我相信大多数开发人员并不熟悉。让我惊讶的是，这些新功能极大地简化了应用程序开发，个中缘由且听我娓娓道来。
15.1 枚举类型
枚举类型(enumerated type)定义了一组“符号名称/值”配对。例如，以下 Color 类型定义了一组符号，每个符号都标识一种颜色：
internal enum Color {White, // 赋值 0Red, // 赋值 1Green, // 赋值 2Blue, // 赋值 3Orange // 赋值 4}
当然，也可写程序用 0 表示白色，用 1 表示红色，以此类推。不过，不应将这些数字硬编码到代码中，而应使用枚举类型，理由至少有二。
- 枚举类型使程序更容易编写、阅读和维护。有了枚举类型，符号名称可在代码中随便使用，程序员不用费心思量每个硬编码值的含义(例如，不用念叨 white 是 0 ， 或者 0 是 white)。而且，一旦与符号名称对应的值发生改变，代码也可以简单地重新编译，不需要对源代码进行任何修改。此外，文档工具和其他实用程序(比如调试程序)能向开发人员显示有意义的符号名称。
- 枚举类型是强类型的。例如，将
Color.Orange作为参数传给要求Fruit枚举类型的方法，编译器会报错。①①
Fruit枚举类型定义的应该是水果，而Color枚举类型定义的是颜色。虽然两个枚举类型中都有一个Orange，但分别代表橙子和橙色。 ——译注
在 Microsoft .NET Framework 中，枚举类型不只是编译器所关心的符号，它还是类型系统中的“一等公民”，能实现很强大的操作。而在其他环境(比如非托管 C++)中，枚举类型是没有这个特点的。
每个枚举类型都直接从 System.Enum 派生，后者从 System.ValueType 派生，而 System.ValueType 又从 System.Object 派生。所以，枚举类型是值类型(详情参见第 5 章“基元类型、引用类型和值类型”)，可用未装箱和已装箱的形式来表示。但有别于其他值类型，枚举类型不能定义任何方法、属性或事件。不过，可利用C#的“扩展方法”功能模拟向枚举类型添加方法，15.3节“向枚举类型添加方法”展示了一个例子。
编译枚举类型时，C# 编译器把每个符号转换成类型的一个常量字段。例如，编译器将前面的 Color 枚举类型看成是以下代码：
internal struct Color : System.Enum {// 以下是一些公共常量，它们定义了 Color 的符号和值public const Color White = (Color) 0;public const Color Red = (Color) 1;public const Color Green = (Color) 2;public const Color Blue = (Color) 3;public const Color Orange = (Color) 4;// 以下是一个公共实例字段，包含 Color 变量的值，// 不能写代码来直接引用该字段public Int32 value__;}
C# 编译器不会实际地编译上述代码，因为它禁止定义从特殊类型 System.Enum 派生的类型。不过，可通过上述伪类型定义了解内部的工作方式。简单地说，枚举类型只是一个结构，其中定义了一组常量字段和一个实例字段。常量字段会嵌入程序集的的元数据中，并可通过反射来访问。这意味着可以在运行时获得与枚举类型关联的所有符号及其值。还意味着可以将字符串符号转换成对应的数值。这些操作是通过System.Enum基类型来提供的，该类型提供了几个静态和实例方法，可利用它们操作枚举类型的实例，从而避免了必须使用反射的麻烦。下面将讨论其中一些操作。
重要提示 枚举类型定义的符号时常量值。所以当编译器发现代码引用了枚举类型的符号时，会在编译时用数值替换符号，代码不再引用定义了符号的枚举类型。这意味着运行时可能并不不要定义了枚举类型的程序集，编译时才需要。假如代码引用了枚举类型(而非仅仅引用类型定义的符号)，那么运行时就需要包含了枚举类型定义的程序集。可能会出现一些版本问题，因为枚举类型符号是常量，而非只读的值。7.1 节 “常量”已解释过这些问题。
例如，System.Enum 类型有一个名为GetUnderlyingType的静态方法，而System.Type类型有一个名为GetEnumUnderlyingType的实例方法：
public static Type GetUnderlyingType(Type enumType); // System.Enum 中定义public Type GetEnumUnderlyingType(); // System.Type 中定义
这些方法返回用于容纳一个枚举类型的值的基础类型。每个枚举类型都有一个基础类型，它可以是byte，sbyte，short，ushort，int(最常用，也是 C#默认选择的)，uint，long或ulong。虽然这些 C# 基元类型①都有对应的 FCL 类型，但 C#编译器为了简化本身的实现，要求只能指定基元类型名称。如果使用 FCL 类型名称(比如 Int32)，会显示以下错误信息：error CS1008：应输入类型 byte、sbyte、short、ushort、int、uint、long 或 ulong。
① 不要混淆“基础类型”和“基元类型”(参见 5.1 节“编程语言的基元类型”)。虽然枚举的基础类型就是这些基元类型(其实就是除
Char之外的所有整型)，但英语中用 underlying type 和 primitive type 进行了区分，中文翻译同样要区分。简而言之，基元类型是语言的内建类型，编译器能直接识别。——译注
以下代码演示了如何声明一个基础类型为 byte(System.Byte)的枚举类型：
internal enum Color : byte {White,Red,Green,Blue,Orange}
基于这个Color枚举类型，以下代码显示了GetUnderlyingType的返回结果：
// 以下代码会显示 “System.Byte”Console.WriteLine(Enum.GetUnderlyingType(typeof(Color)));
C# 编译器将枚举类型视为基元类型。所以可用许多熟悉的操作符(==，!=，<，>，<=，>=，+，-，^，&，|，~，++和--)来操纵枚举类型的实例。所有这些操作符实际作用于每个枚举类型实例内部的 value__ 实例字段。此外，C# 编译器允许将枚举类型的实例显式转型为不同的枚举类型。也可显式将枚举类型实例转型为数值类型。
给定一个枚举类型的实例，可调用从System.Enum 继承的 ToString 方法，把这个值映射为以下几种字符串表示：
Color c = Color.Blue;Console.WriteLine(c); // “Blue” (常规格式)Console.WriteLine(c.ToString()); // “Blue” (常规格式)Console.WriteLine(c.ToString("G")); // “Blue” (常规格式)Console.WriteLine(c.ToString("D")); // “3” (十进制格式)Console.WriteLine(c.ToString("X")); // “03” (十六进制格式)
注意 使用十六进制格式时，
ToString总是输出大写字母。此外，输出几位数取决于枚举的基础类型：byte/sbyte输出 2 位数，short/ushort输出 4 位数，int/uint输出 8 位数，而long/ulong输出 16 位数。如有必要会添加前导零。
除了ToString方法，System.Enum类型还提供了静态Format方法，可调用它格式化枚举类型的值：public static String Format(Type enumType, Object value, String format);
个人倾向于调用ToString方法，因为它需要的代码更少，而且更容易调用。但Format有一个ToString没有的优势：允许为value参数传递数值。这样就不一定要有枚举类型的实例。例如，以下代码将显示“Blue”：
// 以下代码显示“Blue”Console.WriteLine(Enum.Foramt(typeof(Color), 3, "G"));
注意 声明有多个符号的枚举类型时，所有符号都可以有相同的数值。使用常规格式将数值转换为符号时，
Enum的方法会返回其中一个符号，但不保证具体返回哪一个符号名称。另外，如果没有为要查找的数值定义符号，会返回包含该数值的字符串。
也可调用System.Enum的静态方法GetValues或者System.Type的实例方法GetEnumValues来返回一个数组，数组中的每个元素都对应枚举类型中的一个符号名称，每个元素都包含符号名称的数值：
public static Array GetValues(Type enumType); // System.Enum 中定义public Array GetEnunmValues(); // System.Type 中定义
该方法可以结合ToString方法使用以显示枚举类型中的所有符号名称及其对应数值，如下所示：
Color[] colors = (Color[])Enum.GetValues(typeof(Color));Console.WriteLine("Number of symbols defined: " + colors.Length);Console.WriteLine("Value\tSymbol\n-----\t------");foreach (Color c in colors) {// 以十进制和常规格式显示每个符号Console.WriteLine("{0,5:D}\t{0:G}", c);}
以上代码的输出如下：
Number of symbols defined: 5Value Symbol----- ------0 White1 Red2 Green3 Blue4 Orange
我个人不喜欢 GetValues 和 GetEnumValues 方法，因为两者均返回一个Array，必须转型成恰当的数组类型。所以我总是定义自己的方法：
public static TEnum[] GetEnumValues<TEnum>() where TEnum : struct {return (TEnum[])Enum.GetValues(typeof(TEnum));}
使用我的泛型 GetEnumValues 方法可获得更好的编译时类型安全性，而且上例的第一行代码可简化成以下形式：Color[] colors = GetEnumValues<Color>();
前面的讨论展示了可以对枚举类型执行的一些很“酷”的操作。在程序的 UI 元素(列表框、组合框等)中显示符号名称时，我认为经常使用的会是 ToString 方法(常规格式)，前提是字符串不需要本地化(因为枚举类型没有提供本地化支持)。除了 GetValues 方法， System.Enum 和 System.Type 类型提供了以下方法来返回枚举类型的符号：
// 返回数值的字符串表示public static String GetName(Type enumType, Object value); // System.Enum 中定义public String GetEnumName(Object value); // System.Type 中定义// 返回一个 String 数组， 枚举中每个符号都对应一个 Stringpublic static String[] GetNames(Type enumType); // System.Enum 中定义public String[] GetEnumNames(); // System.Type 中定义
前面讨论了用于查找枚举类型中的符号的多种方法。但还需要一个方法来查找与符号对应的值。例如，可利用这个操作转换用户在文本框中输入的一个符号。利用 Enum 提供的静态 Parse 和 TryParse 方法，可以很容易地将符号转换为枚举类型的实例：
public static Object Parse(Type enumType, String value);public static Object Prase(Type enumType, String value, Boolean ignoreCase);public static Boolean TryParse<TEnum>(String value, out TEnum result) where TEnum : struct;public static Boolean TryParse<TEnum>(String value, Boolean ignoreCase, out TEnum result) where TEnum : struct;
以下代码演示了如何使用这些方法：
// 因为 Orange 定义为 4，'c' 被初始化为 4Color c = (Color) Enum.Parse(typeof(Color), "Orange", true);// 因为没有定义 Brown， 所以抛出 ArgumentException 异常Color c = (Color) Enum.Parse(typeof(Color), "Brown", false);// 创建值为 1 的 Color 枚举类型实例Enum.TryParse<Color>("1", false, out c);// 创建值为 23 的 Color 枚举类型实例Enum.TryParse<Color>("23", false, out c);
以下是 Enum 的静态 IsDefined 方法和 Type 的 IsEnumDefined:
public static Boolean IsDefined(Type enumType, Object value); // System.Enum 中定义public Boolean IsEnumDefined(Object value); // System.Type 中定义
可利用 IsDefined 方法判断数值对于某枚举类型是否合法：
// 显示 “True”，因为 Color 将 Red 定义为 1Console.WriteLine(Enum.IsDefined(typeof(Color), 1));// 显示 “True”，因为 Color 将 White 定义为 0Console.WriteLine(Enum.IsDefined(typeof(Color), "White"));// 显示 “False”， 因为检查要区分大小写Console.WriteLine(Enum.IsDefined(typeof(Color), "white"));// 显示“False”，因为 Color 没有和值 10 对应的符号Console.WriteLine(Enum.IsDefined(typeof(Color), 10));
IsDefined 方法被经常用于参数校验，如下例所示：
public void SetColor(Color c) {if (!Enum.IsDefined(typeof(Color), c)) {throw(new ArgumentOutOfRangeException("c", c, "无效颜色值。"));}// 将颜色设置为 White, Red, Green, Blue 或 Orange...}
参数校验是和有用的一个功能，因为其他人可能像下面这样调用 SetColor:SetColor((Color)) 547);
没有和值 547 对应的符号，所以 SetColor 方法 ArgumentOutOfRangeException 异常，指出哪个参数无效，并解释为什么无效。
重要提示
IsDefined方法很方便，但必须慎用。首先，IsDefined总是执行区分大小写的查找，而且完全没有办法让它执行不区分大小写的查找。其次，IsDefined相当慢，因为它在内部使用了反射。如果写代码来手动检查每一个可能的值，应用程序的性能极有可能变得更好。最后，只有当枚举类型本身在调用IsDefined的同一个程序集中定义，SetColor方法在另一个程序集中定义。SetColor方法调用IsDefined，假如颜色是White，Red,Green,Blue或者Orange，那么SetColor能正常执行。然而，假如Color枚举将来发生了变化，在其中包含了Purple，那么SetColor现在就会接受Purple，这是以前没有预料到的。因此，方法现在可能返回无法预料的结果。
最后，System.Enum 类型提供了一组静态 ToObject 方法。这些方法将 Byte，SByte，Int16，UInt16，Int32，UInt32，Int64 或 UInt64 类型的实例转换为枚举类型的实例。
枚举类型总是要与另外某个类型结合使用，一般作为类型的方法参数或返回类型、属性和字段使用。初学者经常提出的一个问题是：枚举类型是嵌套定义在需要它的类型中，还是和该类型同级？检查 FCL，会发现枚举类型通常与需要它的类同级。原因很简单，就是减少代码的录入量，使开发人员的工作变得更轻松。所以，除非担心名称冲突，否则你定义的枚举类型应该和需要它的类型同级。
15.2 位标志
程序员经常要和位标志(bit flag)集合打交道。调用 System.IO.File 类型的 GetAttributes 方法，会返回 FileAttributes 类型的一个实例。 FileAttributes 类型是基本类型为 Int32 的枚举类型，其中每一位都反映了文件的一个特性(attribute)。FileAttributes 类型在 FCL 中的定义如下：
[Flags, Serializable]public enum FileAttributes {ReadOnly = 0x00001,Hidden = 0x00002,System = 0x00004,Directory = 0x00010,Archive = 0x00020,Device = 0x00040,Normal = 0x00080,Temporary = 0x00100,SparseFile = 0x00200,ReparsePoint = 0x00400,Compressed = 0x00800,Offline = 0x01000,NotContentIndexed = 0x02000,Encrypted = 0x04000,IntegrityStream = 0x08000,NoScrubData = 0x20000}
判断文件是否隐藏可执行以下代码：
String file = Assembly.GetEntryAssembly().Location;
FileAttributes attributes = File.GetAttributes(file);
Console.WriteLine("Is {0} hidden? {1}", file, (attributes & FileAttributes.Hidden) != 0);
注意
Enum类定义了一个HasFlag方法：public Boolean HasFlag(Enum flag);可利用该方法重写上述Console.WriteLine调用：Console.WriteLine("Is {0} hidden? {1}", file, attributes.HasFlag(FileAttributes.Hidden));但我建议避免使用HasFlag方法，理由是：由于它获取Enum类型的参数，所以传给它的任何值都必须装箱，产生一次内存分配。
以下代码演示了如何为文件设置只读和隐藏特性：File.SetAttributes(file, FileAttributes.ReadOnly | FileAttributes.Hidden);
正如 FileAttributes 类型展示的那样，经常都要用枚举类型来表示一组可以组合的位标志。不过，虽然枚举类型和位标志相似，但它们的语义不尽相同。例如，枚举类型表示单个数值，而位标志表示位集合，其中一些位出于 on 状态，一些处于 off 状态①。
① 进制 1 代表 “on”，二进制 0 代表“off”。 ——译注
定义用于标识位标志的枚举类型时，当然应该显式为每个符号分配一个数值。通常，每个符号都有单独的一个位处于 on 状态。此外，经常都要定义一个值为 0 的 None 符号。还可定义一些符合来代表常见的位组合(参见下面的 ReadWrite 符号)。另外，强烈建议向枚举类型应用定制特性类型 System.FlagsAttribute ，如下所示：
[Flags] // C# 编译器允许 “Flags” 或 “FlagsAttribute”
internal enum Actions {
None = 0,
Read = 0x0001,
Write = 0x0002,
ReadWrite = Actions.Read | Actions.Write,
Delete = 0x004,
Query = 0x0008,
Sync = 0x0010
}
由于 Actions 是枚举类型，所以在操纵位标志枚举类型时，可以使用上一节描述的所有方法。不过，假如其中一些方法的行为稍有区别，效果会更加理想。例如，假设有以下代码：
Actions actions = Actions.Read | Actions.Delete; // 0x0005
Console.WriteLine(actions.ToString()); // “Read, Delete”
调用 ToString 时，它会试图将数值转换为对应的符号。现在的数值是0x0005，没有对应的符号。不过，ToString 方法检测到 Actions 类型上存在 [Flags] 特性，所以 ToString 方法现在不会将该数值视为单独的值。相反，会把它视为一组位标志。由于 0x0005 由 0x0001 和 0x0004 组合而成，所以 ToString 会生成字符串 “Read,Delete”。从 Actions 类型中删除 [Flags] 特性， ToString 方法将返回“5”。
上一节已讨论了 ToString 方法，指出它允许以 3 种方式格式化输出：”G“(常规)、”D“(十进制)和”X“(十六进制)。使用常规格式化枚举类型的实例时，首先会检查类型，看它是否应用了[Flags] 这个特性。没有应用就查找与该数值匹配的符号并返回符号。如果应用了[Flags]特性，ToString方法的工作过程如下所示。
- 获取枚举类型定义的数值集合，降序排列这些数值。
- 每个数值都和枚举实例中的值进行”按位与“计算，假如结果等于数值，与该数值关联的字符串就附加到输出字符串上，对应的位会被认为已经考虑过了，会被关闭(设为 0)。这一步不断重复，直到检查完所有数值，或直到枚举实例的所有位都被关闭。
- 检查完所有数值后，如果枚举实例仍然不为 0，表明枚举实例中一些处于 on 状态的位不对应任何已定义的符号。在这种情况下，
ToString将枚举实例中的原始数值作为字符串返回。 - 如果枚举实例原始值不为 0，返回符号之间以逗号分隔的字符串。
- 如果枚举实例原始值为 0， 而且枚举类型定义的一个符号对应的是 0 值，就返回这个符号。
- 如果到达这这一步，就返回”0“。
如果愿意，可定义没有 [Flags] 特性的 Actions 类型，并用 ”F“ 格式获得正确的字符串：
// [Flags] // 现在已经被注释掉6
internal enum Actions
{
None = 0,
Read = 0x0001,
Write = 0x0002,
ReadWrite = Actions.Read | Actions.Write,
Delete = 0x004,
Query = 0x0008,
Sync = 0x0010
}
Actions actions = Actions.Read | Actions.Delete; // 0x0005
Console.WriteLine(actions.ToString(”F“)); // “Read, Delete”
如果数值有一个位不能映射到一个符号，返回的字符串只包含一个代表原始数值的十进制数；字符串中不会有符号。
注意，枚举类型中定义的符号不一定是 2 的整数次方。例如，Actions类型可定义一个名为 All 的符号，它对应的值是0x001F①。如果Actions类型的一个实例的值是 0x001F，格式化该实例就会生成一个含有”All“的字符串。其他符号字符串不会出现。
① 计算可知，二进制 00000001(Read) | 00000010(Write) | 00000100(Delete) | 00001000(Query) | 00010000(Sync) = 00011111(All) = 十六进制 0x001F。 —— 译注
前面讨论的是如何将数值转换成标志字符串(string of flag)。还可将以逗号分隔的符号字符串转换成数值，这是通过调用Enum的静态方法Parse 和TryParse来实现的。以下代码演示了如何使用这些方法;
// 由于 Query 被定义为 8， 所以 'a' 被初始化为 8
Actions a = (Actions)Enum.Parse(typeof(Actions), "Query", true);
Console.WriteLine(a.ToString()); // Query
// 由于 Query 和 Read 已定义，所以 ‘a’ 被初始化为 9
Enum.TryParse<Actions>("Query, Read", false, out a);
Console.WriteLine(a.ToString()); // "Read, Query"
// 创建一个 Actions 枚举类型实例，其值 28
a = (Actions)Enum.Parse(typeof(Actions), "28", false);
Console.WriteLine(a.ToString()); // "Delete, Query, Sync"
Parse 和 TryParse 方法在调用时，会在内部执行以下动作。
- 删除字符串头尾的所有空白字符。
- 如果字符串第一个字符是数字、加号(
+)或减号(-)，该字符串会被认为是一个数字，方法返回一个枚举类型实例，其数值等于字符串转换后的数值。 - 传递的字符串被分解为一组以逗号分隔的 token，每个 token 的空白字符都被删除。
- 在枚举类型的已定义符号中查找每个 token 字符串。如果没有找到相应的符号，
Parse会抛出System.ArgumentException异常‘而TryParse会返回false。如果找到符号，就将它对应的数值与当前的一个动态结果进行”按位或“计算，再查找下一个符号。 - 查找并找到了所有标记之后，返回这个动态结果。
永远不要对位标志枚举类型使用 IsDefined 方法。以下两方面原因造成该方法无法使用。
- 向
IsDefined方法传递字符串，它不会将这个字符串拆分为单独的 token 来进行查找，而是试图查找整个字符串，把它看成是包含逗号的一个更大的符号。由于不能在枚举类型中定义含有逗号的符号，所以这个符号永远找不到。 - 向
IsDefined方法传递一个数值，它会检查枚举类型是否定义了其数值和传入数值匹配的一个符号。由于位标志不能这样简单地匹配①，所以IsDefined通常会返回false。① 因为 bit flag 一般都要组合起来使用。 ——译注
15.3 向枚举类型添加方法
本章早些时候曾指出，不能将方法定义为枚举类型的一部分。多年以来，我对此一直感到很”郁闷“，因为很多时候都需要为我的枚举类型提供一些方法。幸好，现在可以利用 C# 的扩展方法功能(参见第 8 章”方法“)模拟向枚举类型添加方法。
要为 FileAttributes 枚举类型添加方法，先定义一个包含了扩展方法的静态类，如下所示：
internal static class FileAttributesExtensionMethods {
public static Boolean IsSet(this FileAttributes flags, FileAttributes flagToTest) {
if (flagToTest == 0)
throw new ArgumentOutOfRangeException("flagToTest", "Value must not be 0");
return (flags & flagToTest) == flagToTest;
}
public static Boolean IsClear(this FileAttributes flags, FileAttributes flagToTest) {
if (flagToTest == 0)
throw new ArgumentOutOfRangeException("flagToTest", "Value must not be 0");
return !IsSet(flags, flagToTest);
}
public static Boolean AnyFlagsSet(this FileAttributes flags, FileAttributes testFlags) {
return ((flags & testFlags) != 0);
}
public static FileAttributes Set(this FileAttributes flags, FileAttributes setFlags) {
return flags | setFlags;
}
public static FileAttributes Clear(this FileAttributes flags, FileAttributes clearFlags) {
return flags & ~clearFlags;
}
public static void ForEach(this FileAttributes flags, Action<FileAttributes> processFlag) {
if (processFlag == null) throw new ArgumentNullException("processFlag");
for (UInt32 bit = 1; bit != 0; bit <<= 1) {
UInt32 temp = ((UInt32)flags) & bit;
if (temp != 0) processFlag((FileAttributes)temp);
}
}
}
以下代码演示了如何调用其中的一些方法。从表面上看，似乎真的是在枚举类型上调用这些方法：
FileAttributes fa = FileAttributes.System;
fa = fa.Set(FileAttributes.ReadOnly);
fa = fa.Clear(FileAttributes.System);
fa.ForEach(f => Console.WriteLine(f));
若有收获，就点个赞吧
0 人点赞
