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


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

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

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

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


1126
2017-08-12 04:09


起源


除了公认的答案之外,还值得注意的是VB.NET实际上 要求 [Flags] - 至少根据.NET人员的说法: social.msdn.microsoft.com/forums/en-US/csharplanguage/thread/... - Rushyo
注意,这些天VB中不需要。将行为保存为C# - 只需更改ToString()输出。注意,您也可以在Enum本身中进行逻辑OR。很酷。 Cat = 1,Dog = 2,CatAndDog = Cat ||狗。 - Chalky
@Chalky你的意思是 CatAndDog = Cat | Dog (逻辑OR而不是条件),我假设? - DdW
@DdW,部分正确:|应该使用,但是|被称为二进制OR。 II是逻辑OR(允许短路):至少根据Microsoft;) msdn.microsoft.com/en-us/library/f355wky8.aspx - Pieter21


答案:


只要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位,可以是1或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!

None = 0值

关于在枚举中使用0,引用msdn:

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

使用None作为其值为零的标志枚举常量的名称。 您不能在按位AND运算中使用None枚举常量来测试标志,因为结果始终为零。 但是,您可以在数值和None枚举常量之间执行逻辑而非按位比较,以确定是否设置了数值中的任何位。

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


1758
2017-08-12 05:10



旗帜本身什么都不做。此外,C#本身不需要Flags。但是 ToString 你的枚举的实现使用Flags,等等 Enum.IsDefined, Enum.Parse尝试删除标志并查看MyColor.Yellow的结果MyColor.Red;没有它你得到“5”,标志你得到“黄色,红色”。框架的其他一些部分也使用[Flags](例如,XML Serialization)。 - Ruben
//黄色已经设定......,我觉得有点误导。没有设置,这意味着Yellow是你的AllowedColors的成员,也许更好的是//允许黄色? - sweaver2112
我更喜欢使用形式A = 1 << 0,B = 1 << 1,C = 1 << 2 ...的常量...更容易阅读,理解,视觉检查和改变。 - Nick Westgate
@borrrden,地狱啊!我找到了这个: msdn.microsoft.com/en-us/library/system.enum.aspx    - 请参阅“备注”部分:“Enum是.NET Framework中所有枚举的基类。”和“枚举没有显式继承Enum;继承关系由编译器隐式处理。”所以,当你写:public enum bla bla bla - 这是一个值类型。但是,HasFlag方法希望你给他一个System.Enum的实例,这是一个类(引用类型:) - Aleksei Chepovoi
Enum.IsDefined不考虑FlagsAttribute。即使使用属性:Yellow |,以下都不会返回true绿色,“黄色,绿色”,3 - TheXenocide


你也可以这样做

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

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


670
2017-08-12 04:37



如果你喜欢一致性,你可以使用 First = 1 << 0。 - Roman Starkov
这就是我的意思,我更喜欢在源代码中使用完整的int。如果我在数据库中的一个名为MyEnum的表上有一个列,它存储了一个枚举的值,而一个记录有131,072,我需要拿出我的计算器来计算出对应于值为1的枚举<< 17。而不是只看到源中写的值131,072。 - JeremyWeir
@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 1 << 30,1 << 26,1 1 << 25 ..等等甚至没有确定所有的计算器的帮助...我怀疑你可以在没有得到二进制代表的情况下完全确定。 - Brett Caswell
同时指出你可以从“先前”的枚举值进行位移,而不是直接从数字进行位移,即 Third = Second << 1 而不是 Third = 1 << 2  - 看 更完整的描述如下 - drzaus
我喜欢这个,但是一旦达到底层枚举类型的上限,编译器就不会警告比特移位,例如 1 << 31 == -2147483648, 1 << 32 == 1, 1 << 33 == 2, 等等。相比之下,如果你说 ThirtySecond = 2147483648 对于int类型枚举,编译器会抛出错误。 - aaaantoine


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

87
2018-05-16 15:03



这些组合是一个很好的推荐,但我认为链式位移会容易出现复制和粘贴错误,例如Two = One << 1,Three = One << 1等... ...的增量整数表格1 << n更安全,意图更清晰。 - Rupert Rawnsley
@RupertRawnsley引用我的回答:>不一定推荐它,但只是指出你可以 - drzaus
组合+1,非常适合用于表示按位字段。 - Forest Kunecke


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

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

44
2017-08-12 04:32





一世 最近问道 关于类似的事情。

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

这允许你这样做:

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

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


30
2017-08-12 18:40



IsSet是我假设的扩展方法吗? - Robert MacLean
是的 - 请阅读我链接到的其他问题以获取详细信息: stackoverflow.com/questions/7244 - Keith
.NET 4增加了一个 HasFlag 枚举的方法,所以你可以做到 opt.HasFlag( PossibleOptions.OptionOne ) 无需编写自己的扩展 - Orion Edwards


@Nidonocu

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

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

19
2017-08-12 15:37





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

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

我认为这种表示清楚地说明了标志是如何工作的 在封面下


16
2017-07-20 11:09





加上 Mode.Write

Mode = Mode | Mode.Write;

15
2017-08-12 05:59



或模式| = Mode.Write - abatishchev


关于这个问题,我有些过分冗长 if ((x & y) == y)... 构建,特别是如果 x 和 y 都是复合的标志集,你只想知道是否有 任何 交叠。

在这种情况下,你真正需要知道的是 如果在进行了位掩码之后存在非零值[1]

[1]见Jaime的评论。如果我们是真实的 bitmasking, 星期三   只需检查结果是否为正。但是由于 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();
        }
    }
}

13
2018-05-01 23:57



枚举可以基于签名类型,因此您应该使用“!= 0”而不是“> 0”。 - raven
@JaimePardos - 只要我们保持它们诚实的字节,就像我在这个例子中那样,没有负面的概念。只有0到255. MSDN警告说,“如果将负数定义为枚举常量,则要小心,因为...... [这]可能会使您的代码混淆并鼓励编码错误。”用“负位标志”来思考是很奇怪的! ; ^)我会稍微编辑一下。但是你是对的,如果我们在我们的网站中使用负值 enum,我们需要检查 != 0。 - ruffin


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

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

10
2017-08-12 04:24