Co oznacza [Flagi] Enum Attribute w C #?

Od czasu do czasu widzę wyliczenie takie jak:

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

Nie rozumiem, co dokładnie [Flags]robi ten atrybut.

Czy ktoś ma dobre wyjaśnienie lub przykład?

Tego [Flags]atrybutu należy używać, ilekroć element wyliczalny reprezentuje zbiór możliwych wartości, a nie pojedynczą wartość. Takie zbiory są często używane z operatorami bitowymi, na przykład:

var allowedColors = MyColor.Red | MyColor.Green | MyColor.Blue;

Zauważ, że [Flags]atrybut nie włącza tego sam w sobie - wszystko pozwala na ładną reprezentację za pomocą .ToString()metody:

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"

Należy również zauważyć, że [Flags] nie powoduje automatycznie, że wartości wyliczone są potęgami dwóch. Jeśli pominiesz wartości liczbowe, wyliczanie nie będzie działać, jak można oczekiwać w operacjach bitowych, ponieważ domyślnie wartości zaczynają się od 0 i zwiększają.

Niepoprawna deklaracja:

[Flags]
public enum MyColors
{
    Yellow,  // 0
    Green,   // 1
    Red,     // 2
    Blue     // 3
}

Wartości, jeśli zostaną zadeklarowane w ten sposób, będą Żółte = 0, Zielone = 1, Czerwone = 2, Niebieskie = 3. To sprawi, że będzie bezużyteczne jako flagi.

Oto przykład poprawnej deklaracji:

[Flags]
public enum MyColors
{
    Yellow = 1,
    Green = 2,
    Red = 4,
    Blue = 8
}

Aby pobrać różne wartości we właściwości, możesz to zrobić:

if (myProperties.AllowedColors.HasFlag(MyColor.Yellow))
{
    // Yellow is allowed...
}

lub przed .NET 4:

if((myProperties.AllowedColors & MyColor.Yellow) == MyColor.Yellow)
{
    // Yellow is allowed...
}

if((myProperties.AllowedColors & MyColor.Green) == MyColor.Green)
{
    // Green is allowed...
}    

Pod przykryciem

Działa to, ponieważ użyłeś potęgi dwóch w swoim wyliczeniu. Pod okładkami wartości wyliczenia wyglądają następująco w postaci binarnych zer i zer:

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

Podobnie, po ustawieniu właściwości Dozwolone kolory na Czerwony, Zielony i Niebieski za pomocą binarnego |operatora bitowego OR , Dozwolone kolory wyglądają następująco:

myProperties.AllowedColors: 00001110

Więc kiedy odzyskujesz wartość, faktycznie wykonujesz bitowe AND &dla wartości:

myProperties.AllowedColors: 00001110
             MyColor.Green: 00000010
             -----------------------
                            00000010 // Hey, this is the same as MyColor.Green!

Wartość Brak = 0

A jeśli chodzi o użycie 0w wyliczeniu, cytowanie z MSDN:

[Flags]
public enum MyColors
{
    None = 0,
    ....
}

Użyj None jako nazwy stałej wyliczonej z flagą, której wartość wynosi zero. Nie można użyć stałej wyliczonej None w bitowej operacji AND do przetestowania flagi, ponieważ wynik jest zawsze równy zero. Można jednak wykonać logiczne, a nie bitowe porównanie między wartością liczbową a stałą wyliczoną Brak, aby ustalić, czy ustawione są bity w wartości liczbowej.

Więcej informacji na temat atrybutu flagi i jego wykorzystania można znaleźć w msdn i projektowaniu flag w msdn

Możesz także to zrobić

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

Uważam, że przesuwanie bitów jest łatwiejsze niż pisanie 4,8,16,32 i tak dalej. Nie ma to wpływu na kod, ponieważ wszystko odbywa się w czasie kompilacji

Łącząc odpowiedzi https://stackoverflow.com/a/8462/1037948 (deklaracja poprzez przesunięcie bitów) i https://stackoverflow.com/a/9117/1037948 (używając kombinacji w deklaracji) można raczej przesuwać bitem poprzednie wartości niż przy użyciu liczb. Niekoniecznie polecam, ale tylko wskazuję, że możesz.

Zamiast:

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

Możesz zadeklarować

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

Potwierdzanie za pomocą LinqPad:

foreach(var e in Enum.GetValues(typeof(Options))) {
    string.Format("{0} = {1}", e.ToString(), (byte)e).Dump();
}

Prowadzi do:

None = 0
One = 1
Two = 2
OneAndTwo = 3
Three = 4
OneTwoAndThree = 7
Four = 8

Poniżej znajduje się przykład pokazujący deklarację i potencjalne użycie:

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

W uzupełnieniu do zaakceptowanej odpowiedzi, w C # 7 flagi enum można zapisać za pomocą literałów binarnych:

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

Myślę, że ta reprezentacja wyjaśnia, jak flagi działają pod przykryciem .

I poprosił niedawno o czymś podobnym.

Jeśli używasz flag, możesz dodać metodę wyliczania do wyliczeń, aby ułatwić sprawdzanie zawartych flag (szczegóły w poście)

Pozwala to na:

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

Następnie możesz zrobić:

PossibleOptions opt = PossibleOptions.OptionOneTwoAndThree 

if( opt.IsSet( PossibleOptions.OptionOne ) ) {
    //optionOne is one of those set
}

Uważam to za łatwiejsze do odczytania niż większość sposobów sprawdzania dołączonych flag.

@Nidonocu

Aby dodać kolejną flagę do istniejącego zestawu wartości, użyj operatora przypisania LUB.

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

Podczas pracy z flagami często deklaruję dodatkowe elementy Brak i Wszystkie. Pomagają sprawdzić, czy ustawione są wszystkie flagi, czy też nie jest ustawiona żadna flaga.

[Flags] 
enum SuitsFlags { 

    None =     0,

    Spades =   1 << 0, 
    Clubs =    1 << 1, 
    Diamonds = 1 << 2, 
    Hearts =   1 << 3,

    All =      ~(~0 << 4)

}

Stosowanie:

Spades | Clubs | Diamonds | Hearts == All  // true
Spades & Clubs == None  // true

 
Aktualizacja 2019-10:

Od wersji C # 7.0 możesz używać literałów binarnych, których czytanie jest prawdopodobnie bardziej intuicyjne:

[Flags] 
enum SuitsFlags { 

    None =     0b0000,

    Spades =   0b0001, 
    Clubs =    0b0010, 
    Diamonds = 0b0100, 
    Hearts =   0b1000,

    All =      0b1111

}

Aby dodać Mode.Write:

Mode = Mode | Mode.Write;

Jest coś zbyt rozwlekły mi o if ((x & y) == y)...konstrukcji, zwłaszcza jeśli xI yto zarówno złożone zestawy flag i chcesz tylko wiedzieć, czy istnieje jakikolwiek pokrywają.

W takim przypadku wszystko, co naprawdę musisz wiedzieć, to to, czy po maskowaniu bitów jest niezerowa wartość [1] .

[1] Patrz komentarz Jaime'a. Gdybyśmy autentycznie maskowali bit , musielibyśmy tylko sprawdzić, czy wynik był pozytywny. Ale ponieważ enumów może być ujemny, nawet, o dziwo, w połączeniu z tym [Flags] atrybutem , to defensywny do kodowania != 0zamiast > 0.

Kompilowanie konfiguracji @ 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();
        }
    }
}

Flagi pozwalają na użycie maskowania bitów w twoim wyliczeniu. Pozwala to łączyć wartości wyliczeń, zachowując te, które są określone.

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

Przepraszamy, jeśli ktoś już zauważył ten scenariusz. Idealny przykład flag, które widzimy w odbiciu. Tak Wiążące flagi 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

Stosowanie

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