协慌网

登录 贡献 社区

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

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

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

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

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

答案

只要 enumerable 表示可能值的集合而不是单个值,就应该使用[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 和零中看起来像这样:

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

同样,在使用二进制按位 OR |将属性AllowedColors设置为红色,绿色和蓝色之后运算符, 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找到有关 flags 属性及其用法的更多信息,并在msdn 上 设计标志

你也可以这样做

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

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

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