我不时会看到如下枚举:

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

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

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


当前回答

我最近问了一些类似的问题。

如果使用标志,则可以向enums添加扩展方法,以便更容易地检查包含的标志(详细信息请参阅文章)

这允许您执行以下操作:

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

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

其他回答

每当可枚举值表示可能值的集合而不是单个值时,都应使用[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
}

如果以这种方式声明,值将为黄色=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: 00000001
 Green:  00000010
 Red:    00000100
 Blue:   00001000

类似地,在使用二进制位OR |运算符将属性AllowedColors设置为红色、绿色和蓝色后,AllowedColors如下所示:

myProperties.AllowedColors: 00001110

因此,当您检索值时,实际上正在对值执行逐位AND运算(&O):

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作为值为零的标志枚举常量的名称。不能在按位AND操作中使用None枚举常量来测试标志,因为结果始终为零。但是,可以在数值和None枚举常量之间执行逻辑(而不是按位)比较,以确定是否设置了数值中的任何位。

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

我最近问了一些类似的问题。

如果使用标志,则可以向enums添加扩展方法,以便更容易地检查包含的标志(详细信息请参阅文章)

这允许您执行以下操作:

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

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

在使用标志时,我经常声明附加的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

}

要添加Mode.Write:

Mode = Mode | Mode.Write;

你也可以这样做

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

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