Что означает атрибут Enum [Flags] в C #?

Question

Время от времени я вижу следующее перечисление:

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

Я не понимаю, что именно делает атрибут [Flags].

У кого-нибудь есть хорошее объяснение или пример, который они могли бы опубликовать?

Answer 1

Атрибут [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] не автоматически делает значения перечисления степенями двух. Если вы опустите числовые значения, перечисление не будет работать так, как можно ожидать в побитовых операциях, потому что по умолчанию значения начинаются с 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...
}    

Под одеялом

Это работает, потому что вы использовали степени двух в своем перечислении. Под обложками ваши значения перечисления выглядят так в двоичных единицах и нулях:

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

Аналогично, после того, как вы установили для своего свойства AllowedColors значение Red, Green и Blue с использованием двоичного оператора ИЛИ |, 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 в качестве имени перечисляемой константы флага, значение которой равно нулю. Вы не можете использовать перечисляемую константу None в побитовой операции AND для проверки флага, поскольку результат всегда равен нулю. Однако вы можете выполнить логическое, а не побитовое сравнение числового значения и None. константа перечисления, чтобы определить, установлены ли какие-либо биты в числовом значении.

Вы можете найти больше информации об атрибуте flags и его использовании в msdn и , проектируя флаги в msdn

Answer 2

Вы также можете сделать это

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

Я считаю, что сдвиг битов проще, чем набирать 4,8,16,32 и так далее. Это не влияет на ваш код, потому что все это делается во время компиляции

Answer 3

Комбинируя ответы 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

Answer 4

Пожалуйста, смотрите следующий пример для примера объявления и потенциального использования:

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

Answer 5

Я недавно спросил о чем-то похожем.

Если вы используете флаги, вы можете добавить метод расширения к перечислениям, чтобы упростить проверку содержащихся флагов (подробнее см. Статью)

Это позволяет вам:

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

Мне проще читать, чем большинство способов проверки включенных флагов.

Answer 6

В дополнение к принятому ответу, в C # 7 флаги перечисления могут быть записаны с использованием двоичных литералов:

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

Я думаю, это представление проясняет, как работают флаги под обложками .

Answer 7

@ Nidonocu

Чтобы добавить другой флаг к существующему набору значений, используйте оператор присваивания ИЛИ.

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

Answer 8

Добавить Mode.Write:

Mode = Mode | Mode.Write;

Answer 9

Что-то слишком многословное для меня в конструкции if ((x & y) == y)..., особенно если x И y являются составными наборами флагов, и вы хотите знать, есть ли какое-либо перекрытие.

В этом случае все, что вам действительно нужно знать, это , если есть ненулевое значение [1] после того, как вы замаскировали .

[1] См. Комментарий Хайме. Если бы мы были достоверно битмаски , мы Нужно только проверить, чтобы результат был положительным. Но так как 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();
        }
    }
}

Answer 10

Флаги позволяют вам использовать битовую маскировку в вашем перечислении. Это позволяет комбинировать значения перечисления, сохраняя при этом, какие из них указаны.

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