[Flags]枚举属性在C#中是什么意思？

我不时看到一个枚举，如下所示：

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

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

任何人都有一个好的解释或例子，他们可以张贴？

589839 次浏览
小开

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

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

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

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 MyEnum{None   = 0,First  = 1 << 0,Second = 1 << 1,Third  = 1 << 2,Fourth = 1 << 3}

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

小开
最佳答案

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

var 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]不要会自动使枚举值为2的幂。如果省略数值，枚举将无法像按位操作中预期的那样工作，因为默认值以0和增量开头。

错误声明：

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

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

下面是一个正确声明的例子：

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

要检索属性中的不同值，可以这样做：

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

或者在. NET 4之前：

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

藏在被子里

这之所以有效，是因为你在枚举中使用了2的幂。在封面下，你的枚举值在二进制1和0中看起来像这样：

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

类似地，在使用二进制按位OR|运算符将属性允许的颜色设置为Red、Green和Blue后，允许的颜色看起来像这样：

myProperties.AllowedColors: 00001110

因此，当您检索值时，您实际上是在对值执行按位AND&：

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

无=0值

关于在枚举中使用0，引用MSDN：

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

您不能在按位AND运算中使用无枚举常量来测试标志，因为结果始终为零。但是，您可以在数值和无枚举常量之间执行逻辑比较，而不是按位比较，以确定是否设置了数值中的任何位。

您可以在msdn和在msdn设计标志中找到有关标志属性及其用法的更多信息

小开

添加Mode.Write：

Mode = Mode | Mode.Write;
小开

@陈志立

若要向现有值集添加另一个标志，请使用OR赋值操作符。

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

我最近问关于类似的事情。

如果您使用标志，您可以向枚举添加扩展方法，以使检查包含的标志更容易（有关详细信息，请参阅帖子）

这可以让你做：

[Flags]public enum PossibleOptions : byte{None = 0,OptionOne = 1,OptionTwo = 2,OptionThree = 4,OptionFour = 8,
//combinations can be in the enum tooOptionOneAndTwo = OptionOne | OptionTwo,OptionOneTwoAndThree = OptionOne | OptionTwo | OptionThree,...}

然后你可以做：

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

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

小开

关于if ((x & y) == y)...构造，我有一些过于冗长的东西，特别是如果x和y都是复合标志集，你只想知道是否有任何重叠。

在这种情况下，你真正需要知道的是如果有一个非零值[1]后，你有bitm的。

[1]参见Jaime的评论。如果我们是真实的比特掩蔽，我们会只需要检查结果是否为阳性。但自enum以来可以是负的，甚至，奇怪的是，当结合[Flags]属性为!= 0而不是> 0编码是防御性的。

基于@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);     // TrueConsole.WriteLine((myColor & MyColor.Red) != 0);      // FalseConsole.WriteLine((myColor & acceptableColors) != 0); // True// ... though only Yellow is shared.
Console.WriteLine((myColor & MyColor.Green) != 0);    // Wait a minute... ;^D
Console.Read();}}}
小开

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

而不是：

[Flags]public enum Options : byte{None    = 0,One     = 1 << 0,   // 1Two     = 1 << 1,   // 2Three   = 1 << 2,   // 4Four    = 1 << 3,   // 8
// combinationsOneAndTwo = 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 thereTwo     = One << 1,     // 2Three   = Two << 1,     // 4Four    = Three << 1,   // 8
// same combinationsOneAndTwo = 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 = 0One = 1Two = 2OneAndTwo = 3Three = 4OneTwoAndThree = 7Four = 8
小开

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

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

我认为这种表示清楚地说明了标志是如何工作的在被子下。

小开

当使用标志时，我经常声明额外的无和所有项。这些有助于检查是否设置了所有标志或没有设置标志。 

[Flags]enum SuitsFlags {
None =     0,
Spades =   1 << 0,Clubs =    1 << 1,Diamonds = 1 << 2,Hearts =   1 << 3,
All =      ~(~0 << 4)
}

用法：

Spades | Clubs | Diamonds | Hearts == All  // trueSpades & Clubs == None  // true


2019-10更新：

从C#7.0开始，您可以使用二进制文字，阅读起来可能更直观：

[Flags]enum SuitsFlags {
None =     0b0000,
Spades =   0b0001,Clubs =    0b0010,Diamonds = 0b0100,Hearts =   0b1000,
All =      0b1111
}
小开

如果有人已经注意到这种情况，请道歉。这是我们可以在反射中看到的标志的完美例子。是的结合标志ENUM。

[System.Flags][System.Runtime.InteropServices.ComVisible(true)][System.Serializable]public enum BindingFlags

用法

// BindingFlags.InvokeMethod// Call a static method.Type t = typeof (TestClass);
Console.WriteLine();Console.WriteLine("Invoking a static method.");Console.WriteLine("-------------------------");t.InvokeMember ("SayHello", BindingFlags.InvokeMethod | BindingFlags.Public |BindingFlags.Static, null, null, new object [] {});
小开

  • 当可枚举值表示枚举成员。

  • 这里我们使用按位运算符，|和&

  • 示例

                 [Flags]public enum Sides { Left=0, Right=1, Top=2, Bottom=3 }
Sides leftRight = Sides.Left | Sides.Right;Console.WriteLine (leftRight);//Left, Right
string stringValue = leftRight.ToString();Console.WriteLine (stringValue);//Left, Right
Sides s = Sides.Left;s |= Sides.Right;Console.WriteLine (s);//Left, Right
s ^= Sides.Right; // Toggles Sides.RightConsole.WriteLine (s); //Left

提交答案