Что означает атрибут перечисления [Flags] в C#?

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

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

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

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

Ответов (13)

Решение

[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 значение 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 и так далее. Это не влияет на ваш код, потому что все это делается во время компиляции.

Чтобы добавить Mode.Write :

Mode = Mode | Mode.Write;

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

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

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

При работе с флагами я часто объявляю дополнительные элементы 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

}

Приносим извинения, если кто-то уже заметил этот сценарий. Прекрасный пример флагов, которые мы можем увидеть в отражении. Да Связывание флагов 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 [] {});
  • Флаги используются, когда перечислимое значение представляет коллекцию членов перечисления.

  • здесь мы используем поразрядные операторы, | а также &

  • Пример

                 [Flags]
                 public enum Sides { Left=0, Right=1, Top=2, Bottom=3 }
    
                 Sides leftRight = Sides.Left | Sides.Right;
                 Console.WriteLine (leftRight);//Left, Right
    
                 string stringValue = leftRight.ToString();
                 Console.WriteLine (stringValue);//Left, Right
    
                 Sides s = Sides.Left;
                 s |= Sides.Right;
                 Console.WriteLine (s);//Left, Right
    
                 s ^= Sides.Right; // Toggles Sides.Right
                 Console.WriteLine (s); //Left
    

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

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

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

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

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

Для меня в if ((x & y) == y)... конструкции есть что-то излишне многословное , особенно если x AND 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();
        }
    }
}

@Nidonocu

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

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

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

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

См. Следующий пример, демонстрирующий декларацию и возможное использование:

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

Комбинируя ответы https://answacode.com/a/8462/1037948 (объявление с помощью битового сдвига) и https://answacode.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