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

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

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

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

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

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

Вы можете найти больше информации об атрибуте flags и его использовании в msdn и о разработке флагов в 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

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

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

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

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

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

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

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

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

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

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

@Nidonocu

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

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

При работе с флагами я часто объявляю дополнительные пункты «Нет» и «Все». Они полезны для проверки, установлены ли все флаги или нет.

[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

}

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

Mode = Mode | Mode.Write;

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

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

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

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

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

Извиняюсь, если кто-то уже заметил этот сценарий. Прекрасный пример флагов мы можем увидеть в отражении. Да Обязательные Флаги ENUM. https://docs.microsoft.com/en-us/dotnet/api/system.reflection.bindingflags?view=netframework-4.8

[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 [] {});