在c#中，[flags]枚举属性的含义是什么？

What does the [Flags] Enum Attribute mean in C#?

有时我会看到如下枚举：

1
2
3
4
5
6
7
8
9

[Flags]
public enum Options
{
None = 0,
Option1 = 1,
Option2 = 2,
Option3 = 4,
Option4 = 8
}

我不明白[Flags]属性到底做了什么。

有人能给出一个很好的解释或例子吗？

每当可枚举表示可能值的集合而不是单个值时，应使用[Flags]属性。此类集合通常与按位运算符一起使用，例如：

1	var allowedColors = MyColor.Red \| MyColor.Green \| MyColor.Blue;

请注意，[Flags]属性本身并不启用此功能，它所做的只是允许.ToString()方法的良好表示：

1
2
3
4
5
6
7
8
9

enum Suits { Spades = 1, Clubs = 2, Diamonds = 4, Hearts = 8 }
[Flags] enum SuitsFlags { Spades = 1, Clubs = 2, Diamonds = 4, Hearts = 8 }

...

var str1 = (Suits.Spades | Suits.Diamonds).ToString();
//"5"
var str2 = (SuitsFlags.Spades | SuitsFlags.Diamonds).ToString();
//"Spades, Diamonds"

还需要注意的是，[Flags]不会自动使枚举值的幂为2。如果省略数字值，枚举将不会像在按位操作中预期的那样工作，因为默认情况下，值以0和增量开头。

声明不正确：

1
2
3
4
5
6
7
8

[Flags]
public enum MyColors
{
Yellow, // 0
Green, // 1
Red, // 2
Blue // 3
}

如果以这种方式声明，值将为黄色=0、绿色=1、红色=2、蓝色=3。这将使其作为标志无效。

以下是正确声明的示例：

1
2
3
4
5
6
7
8

[Flags]
public enum MyColors
{
Yellow = 1,
Green = 2,
Red = 4,
Blue = 8
}

要检索属性中的不同值，可以执行以下操作：

1
2
3
4

if (myProperties.AllowedColors.HasFlag(MyColor.Yellow))
{
// Yellow is allowed...
}

或在.NET 4之前：

1
2
3
4
5
6
7
8
9

if((myProperties.AllowedColors & MyColor.Yellow) == MyColor.Yellow)
{
// Yellow is allowed...
}

if((myProperties.AllowedColors & MyColor.Green) == MyColor.Green)
{
// Green is allowed...
}

在盖子下面

这是因为在枚举中使用了2的幂。在封面下，枚举值的二进制1和0如下所示：

1
2
3
4

Yellow: 00000001
Green: 00000010
Red: 00000100
Blue: 00001000

同样，在使用二进制位或|运算符将属性allowedColors设置为红、绿和蓝之后，allowedColors如下所示：

1	myProperties.AllowedColors: 00001110

因此，当您检索值时，实际上对这些值执行位和&：

1
2
3
4

myProperties.AllowedColors: 00001110
MyColor.Green: 00000010
-----------------------
00000010 // Hey, this is the same as MyColor.Green!

无=0值

关于在您的枚举中使用0，引自msdn：

1
2
3
4
5
6

[Flags]
public enum MyColors
{
None = 0,
....
}

Use None as the name of the flag enumerated constant whose value is zero. You cannot use the None enumerated constant in a bitwise AND operation to test for a flag because the result is always zero. However, you can perform a logical, not a bitwise, comparison between the numeric value and the None enumerated constant to determine whether any bits in the numeric value are set.

您可以在msdn上找到关于flags属性及其用法的更多信息，并在msdn上设计标志。

相关讨论

另外，我不知道flags属性的真正作用是什么？我似乎能够定义和使用我的标志枚举，而不需要该属性。它仅仅是用来指示枚举可以用作标志吗？
标记本身不起作用。此外，C本身不需要标志。但是枚举的ToString实现使用标志，Enum.IsDefined和Enum.Parse等也使用标志。尝试删除标志并查看mycolor.yellow mycolor.red的结果；如果没有它，您将得到"5"，标志将得到"yellow，red"。框架的其他一些部分也使用[标志](例如，XML序列化)。
//黄色设置了…，我发现有点误导。没有设置任何内容，这意味着黄色是您的允许颜色的一部分，也许最好是//黄色是允许的？
Flags属性比ToString方法更具效果。在设计器中使用枚举时，Visual Studio至少在某种程度上使用它。请看我的问题：stackoverflow.com/q/15663166/1111886
我更喜欢使用A=1<<0，B=1<<1，C=1<<2等形式的常数。更容易阅读、理解、目视检查和更改。
.hasFlag(枚举标志)方法采用枚举类型的参数，因此应将值类型装箱，这对性能不利。
@alekseichepovoi枚举源于ValueType类，这意味着它被视为struct，与int、float等的处理方式相同。
@Borrrden，当我们传递枚举类(定义HasFlag方法的类)时，它是通过引用传递的，正如我得到的那样。我在JeffreyRichter的clr via c_3rd edition，Enums and Bit Flags一章中读过这个。
@我也有那本书，所以我会查一下。尽管如此，它似乎与我所知道的所有关于C的事情背道而驰。我能找到的每一篇文章都说枚举是堆上没有分配的值对象。
@波顿，该死的！我发现了这个：msdn.microsoft.com/en-us/library/system.enum.aspx-参见"备注"部分："枚举是.NET框架中所有枚举的基类。"以及"枚举没有显式继承自枚举；继承关系由编译器隐式处理。"因此，当您编写：public enum bla bla bla bla-这是一个值tYPE。但是，hasFlag方法希望您给他一个System.Enum的实例，该实例是一个类(引用类型：)。
Enum.IsDefined不考虑FlagsAttribute。以下任何一项都不返回true，即使具有以下属性：黄色绿色，"黄色，绿色"，3
是否有一种简单的方法来强制对任何可能相互排斥的标志执行约束？
if((myProperties.AllowedColors & MyColor.Yellow) == MyColor.Yellow)不是更好吗？
如果蓝色=2，绿色=3，则您的示例从感知到的标志会更有意义，因为毕竟绿色是黄色和蓝色的组合。
@洛霍里斯：我不会说两种模式都比另一种更好。假设您有一个表示文件权限的[Flags]枚举，其中一些值为read=1、write=2、read write=3。您拥有文件的权限，并且希望检查用户是否可以读写该文件。那你就查一下... & ReadWrite) == ReadWrite。但是，如果您想检查用户是否可以读写，您可以执行... & ReadWrite) > 0。
如果要从枚举中排除标志，请使用xor，它在c中是^。所以如果你有myProperties.AllowedColors = MyColor.Red | MyColor.Green | MyColor.Blue;。你可以这样做：myProperties.AllowedColors = myProperties.AllowedColors ^ MyColor.Blue //myProperties.AllowedColors == MyColor.Red | Mycolor.Green。
很好的解释，你能用一个代码示例进一步澄清你最后一条关于"无"的声明吗？
使用十六进制和十进制有什么好处吗？

你也可以这样做

1
2
3
4
5
6
7
8
9

[Flags]
public enum MyEnum
{
None = 0,
First = 1 << 0,
Second = 1 << 1,
Third = 1 << 2,
Fourth = 1 << 3
}

我发现比特移位比键入4、8、16、32等更容易。它对您的代码没有影响，因为它都是在编译时完成的。

相关讨论

对于这些快捷方式，我唯一不喜欢的是如果您碰巧将数据库中的这些枚举保存为in t。然后，在分析数据时，您必须多次计算出计算器，以确定哪些值对应于哪个枚举。
@Jeremyweir你能解释一下这和使用1, 2 , 4, 8, 16, ...有什么不同吗？另外，Windows7的计算器还有一些可以点击的位。
这就是我的意思，我更喜欢在源代码中使用完整的int。如果数据库中一个名为my enum的表上有一列存储一个枚举的值，而一个记录有131072，那么我需要拿出计算器来计算出与值为1<<17的枚举对应的列。而不是仅仅看到源代码中的值131072。
"这都是在编译时完成的"这种类型的注释对某些人来说可能很有趣，但我发现它令人沮丧，因为它意味着，也就是说，运行时的20位移位将对性能产生任何可测量的影响。CPU非常擅长位移位，枚举不会有任意数量的成员，而且这对于32或64个以上的元素都不起作用。作为性能问题，这一点并不重要。
@JWG我同意，过分担心这个函数的运行时性能是很愚蠢的，但是尽管如此，我认为知道它不会在任何使用枚举的地方插入位移是件好事。更像是一个"整洁"的东西，而不是任何与性能相关的东西。
@jeremyweir-在一个标志枚举值中要设置几个位。所以你的数据分析方法是不合适的。运行一个以二进制表示整数值的过程。131072[D]=0000 0000 0000 0000 0001 0000 0000 0000 0000 0000[B][32]。。对于第17位集，指定1<<17的枚举值很容易确定。0110 0011 0011 0101 0101 0011 0101 1011[b][32]号。枚举值指定1<<31、1<<30、1<<26、1<<25。等是可以确定的，即使没有计算器的帮助。我怀疑你完全可以确定而不需要得到二进制的rep。
同时指出，您可以从"以前"枚举值而不是直接从数字(即Third = Second << 1而不是Third = 1 << 2)进行位转换--请参阅下面更完整的描述
我喜欢这样，但是一旦达到底层枚举类型的上限，编译器就不会警告位移动，比如1 << 31 == -2147483648、1 << 32 == 1、1 << 33 == 2等等。相反，如果您对int类型枚举说ThirtySecond = 2147483648，编译器就会抛出一个错误。
只需添加另一个新的C 7选项，您就可以使用0b1、0b10等(或0b00000001，如果您喜欢所有东西都排列整齐！)
如果您更喜欢一致性，可以使用Fourth = 1 << 3,。这样，添加Fifth = 1 << 4,时只需编辑一行。
真的。。。我希望没有人会买"你甚至可以从以前的价值观中有所改变！"争论。它只添加依赖项。依赖是不受欢迎的。

结合答案https://stackoverflow.com/a/8462/1037948(通过位移位声明)和https://stackoverflow.com/a/9117/1037948(在声明中使用组合)，您可以位移以前的值，而不是使用数字。不一定要推荐，只要指出你可以。

而不是：

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

[Flags]
public enum Options : byte
{
None = 0,
One = 1 << 0, // 1
Two = 1 << 1, // 2
Three = 1 << 2, // 4
Four = 1 << 3, // 8

// combinations
OneAndTwo = One | Two,
OneTwoAndThree = One | Two | Three,
}

你可以申报

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

[Flags]
public enum Options : byte
{
None = 0,
One = 1 << 0, // 1
// now that value 1 is available, start shifting from there
Two = One << 1, // 2
Three = Two << 1, // 4
Four = Three << 1, // 8

// same combinations
OneAndTwo = One | Two,
OneTwoAndThree = One | Two | Three,
}

与LinqPad确认：

1
2
3

foreach(var e in Enum.GetValues(typeof(Options))) {
string.Format("{0} = {1}", e.ToString(), (byte)e).Dump();
}

结果：

1
2
3
4
5
6
7

None = 0
One = 1
Two = 2
OneAndTwo = 3
Three = 4
OneTwoAndThree = 7
Four = 8

相关讨论

请参阅以下示例，以了解声明和潜在用法：

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

namespace Flags
{
class Program
{
[Flags]
public enum MyFlags : short
{
Foo = 0x1,
Bar = 0x2,
Baz = 0x4
}

static void Main(string[] args)
{
MyFlags fooBar = MyFlags.Foo | MyFlags.Bar;

if ((fooBar & MyFlags.Foo) == MyFlags.Foo)
{
Console.WriteLine("Item has Foo flag set");
}
}
}
}

我最近问过类似的问题。

如果使用标志，可以将扩展方法添加到枚举中，以使检查包含的标志更容易(有关详细信息，请参阅post)

这允许您执行以下操作：

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

[Flags]
public enum PossibleOptions : byte
{
None = 0,
OptionOne = 1,
OptionTwo = 2,
OptionThree = 4,
OptionFour = 8,

//combinations can be in the enum too
OptionOneAndTwo = OptionOne | OptionTwo,
OptionOneTwoAndThree = OptionOne | OptionTwo | OptionThree,
...
}

然后你可以做：

1
2
3
4
5

PossibleOptions opt = PossibleOptions.OptionOneTwoAndThree

if( opt.IsSet( PossibleOptions.OptionOne ) ) {
//optionOne is one of those set
}

我发现这比检查包含标志的大多数方法更容易阅读。

相关讨论

作为接受答案的扩展，在C 7中，可以使用二进制文字编写枚举标志：

1
2
3
4
5
6
7
8
9

[Flags]
public enum MyColors
{
None = 0b0000,
Yellow = 0b0001,
Green = 0b0010,
Red = 0b0100,
Blue = 0b1000
}

我认为这个表示法清楚地说明了旗子是如何在封面下工作的。

@ Nidonocu

要向现有值集添加另一个标志，请使用或赋值运算符。

1
2
3
4
5

Mode = Mode.Read;
//Add Mode.Write
Mode |= Mode.Write;
Assert.True(((Mode & Mode.Write) == Mode.Write)
&& ((Mode & Mode.Read) == Mode.Read)));

增加Mode.Write：

1	Mode = Mode \| Mode.Write;

相关讨论

对于if ((x & y) == y)...构造，我有一些过于冗长的内容，特别是当x和y都是复合的标志集，您只想知道是否有重叠。

在这种情况下，您真正需要知道的是，在您被位屏蔽之后，是否有一个非零值[1]。

[1] See Jaime's comment. If we were authentically bitmasking, we'd
only need to check that the result was positive. But since enums
can be negative, even, strangely, when combined with the [Flags]
attribute,
it's defensive to code for != 0 rather than > 0.

以@andnil的设置为基础…

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

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace BitFlagPlay
{
class Program
{
[Flags]
public enum MyColor
{
Yellow = 0x01,
Green = 0x02,
Red = 0x04,
Blue = 0x08
}

static void Main(string[] args)
{
var myColor = MyColor.Yellow | MyColor.Blue;
var acceptableColors = MyColor.Yellow | MyColor.Red;

Console.WriteLine((myColor & MyColor.Blue) != 0); // True
Console.WriteLine((myColor & MyColor.Red) != 0); // False
Console.WriteLine((myColor & acceptableColors) != 0); // True
// ... though only Yellow is shared.

Console.WriteLine((myColor & MyColor.Green) != 0); // Wait a minute... ;^D

Console.Read();
}
}
}

相关讨论

标记允许您在枚举内使用位屏蔽。这允许您组合枚举值，同时保留指定的枚举值。

1
2
3
4
5
6
7
8
9
10
11

[Flags]
public enum DashboardItemPresentationProperties : long
{
None = 0,
HideCollapse = 1,
HideDelete = 2,
HideEdit = 4,
HideOpenInNewWindow = 8,
HideResetSource = 16,
HideMenu = 32
}

使用标记时，我经常声明附加的"无"和"所有"项。这些有助于检查是否设置了所有标志或未设置任何标志。

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

[Flags]
enum SuitsFlags {

None = 0,

Spades = 1 << 0,
Clubs = 1 << 1,
Diamonds = 1 << 2,
Hearts = 1 << 3,

All = ~(~0 << 4)

}

用途：

1 2	Spades \| Clubs \| Diamonds \| Hearts == All // true Spades & Clubs == None // true