ChatGPT解决这个技术问题 Extra ChatGPT

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

我不时看到如下枚举:

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

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

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

值得注意的是,除了公认的答案之外,VB.NET 实际上 requires [标志] - 至少根据 .NET 人员的说法:social.msdn.microsoft.com/forums/en-US/csharplanguage/thread/…
请注意,这些天在 VB 中不需要。将行为另存为 C# - 只需更改 ToString() 输出。请注意,您也可以在枚举本身内执行逻辑或。很酷。猫 = 1,狗 = 2,CatAndDog = 猫 ||狗。
@Chalky您的意思是CatAndDog = Cat | Dog(逻辑或而不是条件),我假设?
@DdW,部分正确:|应该使用,但是 |称为二元或。 II 是逻辑 OR(允许短路):至少根据 Microsoft ;) msdn.microsoft.com/en-us/library/f355wky8.aspx
感谢您提出这个问题。我在这里学到了很多。

M
Matt Jenkins

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

因此,当您检索值时,您实际上是在对这些值执行按位 AND &

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 枚举常量之间执行逻辑比较,而不是按位比较,以确定数值中是否设置了任何位。

您可以在 msdndesigning flags at msdn 找到有关 flags 属性及其用法的更多信息


Flags 本身什么也不做。此外,C# 本身不需要标志。但是您的枚举的 ToString 实现使用了标志,Enum.IsDefinedEnum.Parse 等也是如此。尝试删除标志并查看 MyColor.Yellow | 的结果我的颜色.红色;没有它你得到“5”,有标志你得到“黄色,红色”。框架的一些其他部分也使用[标志](例如,XML 序列化)。
我更喜欢使用 A = 1 << 0, B = 1 << 1, C = 1 << 2 ... 形式的常量...更易于阅读、理解、直观检查和更改。
@borrrden,该死的耶!我发现了这个:msdn.microsoft.com/en-us/library/system.enum.aspx - 请参阅“备注”部分:“Enum 是 .NET Framework 中所有枚举的基类。”和“枚举没有显式地从 Enum 继承;继承关系由编译器隐式处理。”所以,当你写: public enum bla bla bla - 这是一个值类型。但是,HasFlag 方法希望你给他一个 System.Enum 的实例,它是一个类(引用类型:)
Enum.IsDefined 不考虑 FlagsAttribute。以下均不返回 true,即使具有属性:Yellow |绿色,“黄色,绿色”,3
如果要从枚举中排除标志,请使用 xor,即 C# 中的 ^。因此,如果您有 myProperties.AllowedColors = MyColor.Red | MyColor.Green | MyColor.Blue;。你可以这样做:myProperties.AllowedColors = myProperties.AllowedColors ^ MyColor.Blue //myProperties.AllowedColors == MyColor.Red | Mycolor.Green
O
Orion Edwards

你也可以这样做

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

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


这就是我的意思,我更喜欢在源代码中包含完整的 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 - 请参阅 more complete description below
我喜欢这样,但是一旦达到底层枚举类型的上限,编译器就不会针对 1 << 31 == -21474836481 << 32 == 11 << 33 == 2 等位移位发出警告。相反,如果您对 int 类型枚举说 ThirtySecond = 2147483648,编译器会抛出错误。
只需添加另一个 C# 7 的新选项,您可以使用 0b10b10 等(如果您希望所有内容都正确排列,则可以使用 0b00000001!)
C
Community

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

这些组合是一个很好的建议,但我认为链式位移很容易出现复制和粘贴错误,例如二 = 一 << 1、三 = 一 << 1 等......形式 1 << n 更安全,意图更清晰。
@RupertRawnsley 引用我的回答: > 不一定推荐它,但只是指出你可以
T
Thorkil Holm-Jacobsen

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

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

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


在 C# 7.2 中,使用 leading separator 更加清晰! 0b_0100
J
Jaider

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

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],此示例也有效。这是我想要了解的 [Flags] 部分。
C
Community

asked recently关于类似的事情。

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

这允许您执行以下操作:

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

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


IsSet 是我假设的扩展方法?
是的 - 阅读我链接到的另一个问题以了解详细信息:stackoverflow.com/questions/7244
.NET 4 向枚举添加了一个 HasFlag 方法,因此您可以执行 opt.HasFlag( PossibleOptions.OptionOne ) 而无需编写自己的扩展
请注意,HasFlagmuch slower 而不是按位运算。
@WaiHaLee 您可以使用 CodeJam.EnumHelper.IsFlagSet 扩展方法,该方法使用 Expression: github.com/rsdn/CodeJam/wiki/M_CodeJam_EnumHelper_IsFlagSet__1 编译为快速版本
J
Jpsy

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

}

是的,结合此页面中的所有答案,我现在经常使用这个答案,但带有前导分隔符 0b_1111
s
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)));

s
shA.t

添加 Mode.Write

Mode = Mode | Mode.Write;

r
ruffin

关于 if ((x & y) == y)... 构造,我觉得有些过于冗长,特别是如果 xy 都是标志的复合集并且您只想知道是否存在 any 重叠。

在这种情况下,您真正需要知道的是,在您进行位掩码后是否存在非零值 [1]。

[1] 见詹姆的评论。如果我们真的是位掩码,我们只需要检查结果是否为正。但是由于枚举可能是负数,甚至奇怪的是,当与 [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();
        }
    }
}

枚举可能基于有符号类型,因此您应该使用“!= 0”而不是“> 0”。
@JaimePardos——只要我们保持它们诚实的字节,就像我在这个例子中所做的那样,就没有否定的概念。只是 0 到 255。作为 MSDN warns,“如果您将负数定义为标志枚举常量,请务必小心,因为... [那] 可能会使您的代码混乱并鼓励编码错误。”用“负位标志”来思考是很奇怪的! ;^) 我稍后会编辑更多。但您是对的,如果我们确实在 enum 中使用负值,我们需要检查 != 0
M
Markus Safar

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

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

这是不正确的,即使枚举未标记为 Flags,您也可以使用位掩码。
b
bad_coder

如果有人已经注意到这种情况,我们深表歉意。我们可以在反射中看到的标志的完美示例。是的Binding Flags ENUM

[System.Flags]
[System.Runtime.InteropServices.ComVisible(true)]
[System.Serializable]
public enum BindingFlags

用法

// BindingFlags.InvokeMethod
// Call a static method.
Type t = typeof (TestClass);

Console.WriteLine();
Console.WriteLine("Invoking a static method.");
Console.WriteLine("-------------------------");
t.InvokeMember ("SayHello", BindingFlags.InvokeMethod | BindingFlags.Public | 
    BindingFlags.Static, null, null, new object [] {});

M
Mukesh Pareek

当可枚举值表示枚举成员的集合时,使用标志。

这里我们使用位运算符,|和 &

示例 [标志] 公共枚举 Sides { Left=0, Right=1, Top=2, Bottom=3 } Sides leftRight = Sides.Left | Sides.Right; Console.WriteLine(leftRight);//左、右字符串 stringValue = leftRight.ToString(); Console.WriteLine(stringValue);//Left, Right Sides s = Sides.Left; s |= Sides.Right; Console.WriteLine(s);//左,右 s ^= Sides.Right; // 切换 Sides.Right Console.WriteLine (s); //剩下


您的示例是错误的(并且不会产生它声称的输出),因为正确使用 Flags 要求您的枚举值具有唯一的位设置。并且应该至少有 one 集(除非你是像 None 这样的伪值)。你的枚举应该像 `public enum Sides { Left=1, Right=2, Top=4, Bottom=8 } `