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

我不时看到如下枚举:

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

我不明白[Flags]属性的确切作用。

任何人都可以发表很好的解释或榜样吗?

答案

每当枚举表示可能值的集合而不是单个值时,应使用[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设置为 Red,Green 和 Blue 之后|运算符, 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 作为值为零的标志枚举常量的名称。 您不能在按位与运算中使用 None 枚举常量来测试标志,因为结果始终为零。但是,您可以在数值和 None 枚举常量之间进行逻辑比较而不是按位比较,以确定是否设置了数值中的任何位。

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

您也可以这样做

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

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

结合答案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

请参见以下示例,以显示声明和潜在用法:

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
}

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

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

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

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

@Nidonocu

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

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

要添加Mode.Write

Mode = Mode | Mode.Write;

对于if ((x & y) == y)...构造,我有些过于冗长,尤其是如果x AND y都是复合标志集,并且您只想知道是否存在任何重叠。

在这种情况下,您真正需要知道的是对 bitmasked 后是否存在非零值 [1]

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

使用标志时,我经常声明其他 “无” 和 “所有” 项。这些有助于检查是否设置了所有标志或没有设置标志。

[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

}