Що означає атрибут [Прапори] Enum у 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
}

Значення, якщо це оголошено таким чином, буде Жовте = 0, Зелене = 1, Червоне = 2, Синє = 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 червоний, зелений і синій кольори за допомогою |оператора двійкового бітового АБО , 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 прапори enum можуть бути записані за допомогою двійкових літералів:

[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)));

Під час роботи з прапорами я часто декларую додаткові елементи 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

}

Щоб додати 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 [] {});