提问



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


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


我不明白[Flags] - 属性的确切含义。


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

最佳参考


只要enumerable表示标志集合而不是单个值,就应该使用flags属性。这些集合通常使用按位运算符进行操作,例如:


myProperties.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,
    Green,
    Red,
    Blue
}


如果以这种方式声明,则值将为Yellow=0,Green=1,Red=2,Blue=3.这将使其无法用作标志。


这是一个正确声明的例子:


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


要检索属性中的不同值,可以执行以下操作:


if((myProperties.AllowedColors & MyColor.Yellow) == MyColor.Yellow)
{
    // Yellow has been set...
}

if((myProperties.AllowedColors & MyColor.Green) == MyColor.Green)
{
    // Green has been set...
}    


或者,在.NET 4及更高版本中:


if (myProperties.AllowedColors.HasFlag(MyColor.Yellow))
{
    // Yellow has been set...
}


幕后


这是有效的,因为您以前在枚举中使用了2的幂。在封面下,您的枚举值看起来像这样(以字节形式显示,有8位,可以是1s或0)


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


同样,在您将属性 AllowedColors 设置为红色,绿色和蓝色(其值为管道的OR值)之后, 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作为其值为零的标志枚举常量的名称。 您不能在按位AND运算中使用None枚举常量来测试标志,因为结果始终为零。但是,您可以执行数值和数值之间的逻辑比较,而不是按位比较。无枚举常量以确定是否设置了数值中的任何位。



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

其它参考1


你也可以这样做


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


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

其它参考2


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

其它参考3


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


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

其它参考4


我最近问过类似的事情。


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


这允许你这样做:


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


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

其它参考5


@Nidonocu


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


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

其它参考6


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


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


我认为这种表示清楚地表明了标志如何在下隐藏。

其它参考7


添加Mode.Write:


Mode = Mode | Mode.Write;

其它参考8


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


在这种情况下,你真正需要知道的是如果在你用bitmasked 之后有一个非零值
[Flags]
public enum Options 
{
    None    = 0,
    Option1 = 1,
    Option2 = 2,
    Option3 = 4,
    Option4 = 8
}




  
[Flags]
public enum Options 
{
    None    = 0,
    Option1 = 1,
    Option2 = 2,
    Option3 = 4,
    Option4 = 8
}
见Jaime的评论。如果我们真实地 bitmasking ,我们d
  只需检查结果是否为正。但自enum以来
  当与[Flags]结合时,甚至可能是消极的,甚至是奇怪的
  属性,
  它!= 0而不是> 0代码的防守。[42]



建立@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();
        }
    }
}

其它参考9


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


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