[Flags]枚举属性在C#中意味着什么？

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

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

我不明白[Flags]-attribute 到底是做什么的.

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

1> andnil..：

---

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

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和零中看起来像这样:

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

同样,在使用二进制按位OR 运算符将属性AllowedColors设置为Red,Green和Blue之后|,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作为其值为零的标志枚举常量的名称.您不能在按位AND运算中使用None枚举常量来测试标志,因为结果始终为零.但是,您可以在数值和None枚举常量之间执行逻辑而非按位比较,以确定是否设置了数值中的任何位.

你可以找到更多信息有关标志属性及其在使用MSDN和MSDN上的标志设计

---

旗帜本身什么都不做.此外,C#本身不需要Flags.但是你的枚举的`ToString`实现使用了Flags,`Enum.IsDefined`,`Enum.Parse`等也是如此.尝试删除Flags并查看MyColor的结果.MyColor.Red; 没有它你得到"5",标志你得到"黄色,红色".框架的其他一些部分也使用[Flags](例如,XML Serialization).

---

我更喜欢使用形式A = 1 << 0,B = 1 << 1,C = 1 << 2 ...的常量...更容易阅读,理解,视觉检查和改变.

---

//黄色已经设定......,我觉得有点误导.没有设置,这意味着Yellow是你的AllowedColors的成员,也许更好的是//允许黄色？

---

@borrrden，是的，是的！我发现了这一点：http://msdn.microsoft.com/zh-cn/library/system.enum.aspx-请参见“备注”部分：“枚举是.NET Framework中所有枚举的基类。” 和“枚举没有显式继承自Enum；继承关系由编译器隐式处理。” 因此，当您编写：public enum bla bla bla-这是一个值类型。但是，HasFlag方法要您给他一个System.Enum实例，它是一个类（引用类型：）

2> Orion Edward..：

---

你也可以这样做

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

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

---

我喜欢这个,但是一旦达到底层枚举类型的上限,编译器就不会警告位移,例如`1 << 31 == -2147483648`,`1 << 32 == 1`, `1 << 33 == 2`,依此类推.相反,如果对int类型枚举说"ThirtySecond = 2147483648",则编译器会抛出错误.

---

这就是我的意思,我更喜欢在源代码中使用完整的int.如果我在数据库中的一个名为MyEnum的表上有一个列,它存储了一个枚举的值,而一个记录有131,072,我需要拿出我的计算器来计算出对应于值为1的枚举的<< 17.而不是只看到源中写的值131,072.

---

@JeremyWeir - 将在标志枚举值中设置几个位.所以你的数据分析方法是不恰当的.运行一个过程以二进制表示整数值.131,072 [D] = 0000 0000 0000 0001 0000 0000 0000 0000 [B] [32] ..设置第17位后,可轻松确定分配为1 << 17的枚举值.0110 0011 0011 0101 0101 0011 0101 1011 [b] [32] ..枚举值赋值1 << 31,1 << 30,1 << 26,1 << 25 ..等等,甚至没有确定所有的计算器的帮助..我怀疑你能够在没有得到二进制代表的情况下完全确定.

---

同时指出你可以从"之前的"枚举值而不是直接从数字中移位,即`Third = Second << 1`而不是`Third = 1 << 2` - 参见[更完整的描述如下](http ://stackoverflow.com/a/16591032/1037948)

---

@jwg我同意,过分担心它的运行时性能是愚蠢的,但同样,我觉得很高兴知道这不会在你使用枚举的任何地方插入位移.更多的是"那个整洁"的东西而不是与表现有关的任何东西

---

"这一切都是在编译时完成的"这种类型的评论可能对某些人感兴趣,但我发现它令人沮丧,因为它暗示说,在运行时20位移位将对性能产生任何可衡量的影响.CPU在位移方面非常擅长,枚举不会有任意数量的成员,无论如何这对于超过32或64个元素都不起作用.作为性能问题并不重要.

---

只是为了添加另一个C#7的新选项,你可以使用`0b1`,`0b10`等(或者如果你喜欢所有排列正确的话,可以使用`0b00000001`!)

3> drzaus..：

---

结合答案/sf/ask/17360801/(通过位移声明)和/sf/ask/17360801/(使用声明中的组合)您可以对以前的值进行位移而不是使用数字.不一定推荐它,但只是指出你可以.

而不是:

[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

---

这些组合是一个很好的推荐,但我认为链式位移会容易出现复制和粘贴错误,例如Two = One << 1,Three = One << 1等等...增量整数表格1 << n更安全,意图更清晰.

---

@RupertRawnsley引用我的答案：>不一定推荐它，但只要指出您可以

4> OJ...：

---

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

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

5> Keith..：

---

我最近问过类似的事情.

如果使用标记,则可以向枚举添加扩展方法,以便更轻松地检查包含的标记(有关详细信息,请参阅post)

这允许你这样做:

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

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

---

.NET 4为枚举添加了一个`HasFlag`方法,因此您可以执行`opt.HasFlag(PossibleOptions.OptionOne)`而无需编写自己的扩展

6> Thorkil Holm..：

---

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

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

我想,这表示清楚的标志是如何工作在幕后.

7> steve_c..：

---

@Nidonocu

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

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

8> David Wengie..：

---

要添加Mode.Write:

Mode = Mode | Mode.Write;

---

或模式| = Mode.Write

9> ruffin..：

---

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

在这种情况下,您真正​​需要知道的是在您进行了位掩码之后是否存在非零值[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();
        }
    }
}

10> Jpsy..：

---

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

[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

}

11> Jay Mooney..：

---

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

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