C#中的枚举属性是什么意思?

我不时会看到如下的枚举:

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

我不明白[Flags] -attribute究竟做了什么。

任何人有一个很好的解释或例子,他们可以发布?

只要enumerable表示一个标志集合,而不是一个单一的值,就应该使用flags属性。 这种集合通常使用按位运算符进行操作,例如:

 myProperties.AllowedColors = MyColor.Red | MyColor.Green | MyColor.Blue; 

请注意, [Flags]本身并没有改变这一切 – 它只是通过.ToString()方法启用一个很好的表示:

 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] 不会自动使枚举值的两个幂。 如果省略数字值,则枚举将无法像按位运算中预期的那样工作,因为默认情况下,值以0开始,并以增量开始。

声明不正确:

 [Flags] public enum MyColors { Yellow, Green, Red, Blue } 

这些值如果以这种方式声明,将会是黄色= 0,绿色= 1,红色= 2,蓝色= 3。这将使它无法用作标志。

这是一个正确的声明的例子:

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

要检索属性中的不同值,可以这样做:

 if((myProperties.AllowedColors & MyColor.Yellow) == MyColor.Yellow) { // Yellow has been set... } if((myProperties.AllowedColors & MyColor.Green) == MyColor.Green) { // Green has been set... } 

或者在.NET 4及更高版本中:

 if (myProperties.AllowedColors.HasFlag(MyColor.Yellow)) { // Yellow has been set... } 

在封面下

这是有效的,因为您以前在枚举中使用了两个幂。 在封面下,你的枚举值看起来像这样(以字节表示,它有8位,可以是1或0)

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

同样,在将你的属性AllowedColors设置为红色,绿色和蓝色之后(这个值通过pipe道的OR值), AllowedColors看起来像这样

 myProperties.AllowedColors: 00001110 

所以,当你检索的价值,你实际上按位与值

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

无= 0值

而在你枚举中使用0,从msdn引用:

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

使用None作为值为零的枚举常量的名称。 您不能在按位AND操作中使用None枚举常量来testing标志,因为结果始终为零。 但是,您可以在数值和None枚举常量之间执行逻辑而非按位比较,以确定是否设置了数值中的任何位。

您可以在msdn上find更多关于flags属性及其用法的信息,并在msdn上 devise标志

你也可以做到这一点

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

我发现比input4,8,16,32等位移更容易。 它对你的代码没有影响,因为它都是在编译时完成的

结合回答https://stackoverflow.com/a/8462/1037948 (声明通过位移)和https://stackoverflow.com/a/9117/1037948 (在声明中使用组合),您可以位移先前的值比使用数字。 不一定build议,但只是指出你可以。

而不是:

 [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, } 

你可以声明

 [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确认:

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

结果是:

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

请参阅下面的示例来显示声明和潜在用法:

 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"); } } } } 

我最近问到类似的事情。

如果你使用标志,你可以添加一个扩展方法枚举来检查包含的标志更容易(详见后)

这可以让你做到:

 [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, ... } 

那你可以这样做:

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

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

@Nidonocu

要将另一个标志添加到现有的一组值,请使用OR赋值运算符。

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

对于if ((x & y) == y)...结构,有些东西是非常冗长的,特别是如果xy都是复合集合,而且只想知道是否有重叠。

在这种情况下,你真正需要知道的是, 如果在位掩码后有一个非零值[1]

[1]见Jaime的评论。 如果我们是真正的掩码 ,我们只需要检查结果是正面的。 但是由于enum s可能是负数,甚至奇怪的是,当与[Flags]属性结合使用时,对于!= 0而不是> 0编码是防御性的。

build立@ andnil的设置…

 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(); } } } 

添加Mode.Write

 Mode = Mode | Mode.Write; 

标志允许您在枚举中使用位掩码。 这允许您将枚举值组合,同时保留指定的值。

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

扩展到接受的答案,在C#7中枚举标志可以使用二进制文字写入:

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

我认为这种表述清楚地表明了旗帜下的旗帜是如何运作