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

Question

有时我会看到类似以下的枚举：

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

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

任何人都可以发布一个很好的解释或示例吗？

Answer 1

当可枚举表示可能值的集合而不是单个值时，应使用[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,  // 0
    Green,   // 1
    Red,     // 2
    Blue     // 3
}

如果以这种方式声明，值将是 Yellow = 0、Green = 1、Red = 2、Blue = 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: 00000001
 Green:  00000010
 Red:    00000100
 Blue:   00001000

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

myProperties.AllowedColors: 00001110

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

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

None = 0 值

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

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

使用 None 作为其值为 0 的标志枚举常量的名称。 您不能在按位与运算中使用 None 枚举常量来测试标志，因为结果始终为零。但是，您可以在数值和None 枚举常量，用于确定数值中是否设置了任何位。

您可以在msdn 和designing flags at msdn 找到有关标志属性及其用法的更多信息

Answer 2

你也可以这样做

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

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

Answer 3

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

而不是：

[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

Answer 4

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

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

我认为这种表示方式清楚地说明了标志是如何在幕后工作的。

Answer 5

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

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

Answer 6

我asked recently关于类似的事情。

如果您使用标志，您可以向枚举添加扩展方法，以便更轻松地检查包含的标志（详见帖子）

这允许你做：

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

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

Answer 7

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

[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  // true
Spades & Clubs == None  // true

 
2019-10 更新：

从 C# 7.0 开始，您可以使用二进制文字，这可能更易于阅读：

[Flags] 
enum SuitsFlags { 

    None =     0b0000,

    Spades =   0b0001, 
    Clubs =    0b0010, 
    Diamonds = 0b0100, 
    Hearts =   0b1000,

    All =      0b1111

}

Answer 8

@Nidonocu

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

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

Answer 9

添加Mode.Write：

Mode = Mode | Mode.Write;

Answer 10

对我来说，if ((x & y) == y)... 构造有些过于冗长，特别是如果 x 和 y 都是标志的复合集，而您只想知道是否存在 任何 重叠。

在这种情况下，您真正​​需要知道的是位掩码后是否有非零值[1]。

[1] 见 Jaime 的评论。如果我们真的是位掩码，我们会 只需要检查结果是否为阳性。但是自从enums 当与the [Flags] attribute 结合时，可以是负数，甚至，奇怪的是， 为!= 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);     // 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();
        }
    }
}

Answer 11

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

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

Answer 12

如果有人已经注意到这种情况，我们深表歉意。我们可以在反射中看到的标志的完美示例。是的Binding Flags 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 [] {});

Answer 13

• 当一个可枚举值表示一个集合时使用标志 枚举成员。

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

• 例子

               [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.Right
               Console.WriteLine (s); //Left