Co oznacza [Flagi] Enum Attribute w C #?

1445

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?

Brian Leahy
źródło
Warto również zauważyć, oprócz zaakceptowanej odpowiedzi, że VB.NET faktycznie wymaga [Flags] - przynajmniej według facetów .NET: social.msdn.microsoft.com/forums/en-US/csharplanguage/thread/…
Rushyo
8
Uwaga, obecnie nie jest wymagane w VB. Zapisz zachowanie jako C # - po prostu zmienia wyjście ToString (). Zauważ, że możesz także wykonać logiczną operację OR w samym Enum. Bardzo fajny. Cat = 1, Dog = 2, CatAndDog = Cat || Pies.
Chalky,
14
@Chalky Masz na myśli CatAndDog = Cat | Dog(logiczne OR zamiast warunkowe), zakładam?
DdW
5
@DdW, częściowo poprawne: | należy użyć, ale | nazywa się binarnym OR. II jest logicznym OR (który pozwala na zwarcie): przynajmniej według Microsoft;) msdn.microsoft.com/en-us/library/f355wky8.aspx
Pieter21

Odpowiedzi:

2152

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

andnil
źródło
156
Same flagi nic nie robią. Ponadto C # nie wymaga flag jako takich. Ale ToStringrealizacja Twojego wyliczenia używa flagi, a więc nie Enum.IsDefined, Enum.Parseitd Spróbuj usunąć flagi i spojrzeć na skutek MyColor.Yellow | MyColor.Red; bez niego dostajesz „5”, z flagami „żółty, czerwony”. Niektóre inne części frameworka również używają [Flags] (np. XML Serialization).
Ruben,
7
// Ustawiono kolor żółty ... Uważam, że to trochę mylące. Nic nie zostało ustawione, oznacza to, że Żółty jest członkiem Dozwolonych Kolorów, być może lepiej byłoby // Żółty jest dozwolony?
Scott Weaver
48
Wolę używać stałych w postaci A = 1 << 0, B = 1 << 1, C = 1 << 2 ... Znacznie łatwiej jest czytać, rozumieć, wizualnie sprawdzać i zmieniać.
Nick Westgate,
2
@borrrden, hell yeah! Znalazłem to: msdn.microsoft.com/en-us/library/system.enum.aspx - patrz część „Uwagi”: „Enum jest klasą bazową dla wszystkich wyliczeń w .NET Framework.” oraz „Wyliczenie nie dziedziczy wprost z Enum; relacja dziedziczenia jest obsługiwana pośrednio przez kompilator”. Kiedy piszesz: public enum bla bla bla - jest to typ wartości. Ale metoda HasFlag chce, abyś dał mu instancję System.Enum, która jest klasą (typ referencyjny :)
Aleksei Chepovoi
2
Jeśli chcesz wykluczyć flagę z wyliczenia, użyj xor, który jest ^ w C #. Więc jeśli masz myProperties.AllowedColors = MyColor.Red | MyColor.Green | MyColor.Blue;. Możesz zrobić:myProperties.AllowedColors = myProperties.AllowedColors ^ MyColor.Blue //myProperties.AllowedColors == MyColor.Red | Mycolor.Green
Josh Noe
778

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

Orion Edwards
źródło
18
Mam na myśli to, że wolę mieć pełną int w kodzie źródłowym. Jeśli mam kolumnę na stole w bazie danych o nazwie MyEnum, która przechowuje wartość jednego z wyliczeń, a rekord ma 131.072, musiałbym wyciągnąć kalkulator, aby dowiedzieć się, że odpowiada on wyliczeniu o wartości 1 << 17. W przeciwieństwie do samej wartości 131.072 zapisanej w źródle.
JeremyWeir
6
@jwg Zgadzam się, głupio jest zbytnio martwić się wydajnością tego środowiska uruchomieniowego, ale mimo wszystko myślę, że miło jest wiedzieć, że to nie będzie wstawianie przesunięć bitowych w dowolnym miejscu, w którym używasz wyliczenia. Bardziej „fajna” rzecz niż coś związanego z wydajnością
Orion Edwards
18
@JeremyWeir - Kilka bitów zostanie ustawionych w wartości wyliczenia flagi. Więc twoja metoda analizy danych jest niewłaściwa. Uruchom procedurę reprezentującą wartość całkowitą w formacie binarnym. 131072 [D] = 0000 0000 0000 0001 0000 0000 0000 0000 [B] [32] .. Przy ustawionym 17-bitowym bicie można przypisać wartość wyliczenia 1 << 17. 0110 0011 0011 0101 0101 0011 0101 1011 [b] [32] .. wartości wyliczeniowe przypisują 1 << 31, 1 << 30, 1 << 26, 1 << 25 .. itd. Itd. Można określić nawet bez pomoc kalkulatora w ogóle .. co wątpię byłbyś w stanie określić w ogóle bez uzyskania binarnego powtórzenia.
Brett Caswell
13
Wskazując również, że możesz przesuwać bity od „poprzednich” wartości wyliczeniowych zamiast bezpośrednio od liczb, tj. Third = Second << 1Zamiast Third = 1 << 2- zobacz pełniejszy opis poniżej
drzaus
26
I tak, ale kiedy już się do górnych granic podstawowej typu enum, kompilator nie ostrzegają przed przesunięciami bitowymi, takich jak 1 << 31 == -2147483648, 1 << 32 == 1, 1 << 33 == 2i tak dalej. Natomiast jeśli mówimy ThirtySecond = 2147483648o wyliczeniu typu int, kompilator zgłasza błąd.
aaaantoine
115

Łą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
drzaus
źródło
23
Kombinacje są dobrą rekomendacją, ale myślę, że łańcuchowe przesunięcie bitów byłoby podatne na błędy kopiowania i wklejania, takie jak Two = One << 1, Three = One << 1, itp. ... Inkrementujące liczby całkowite formularz 1 << n są bezpieczniejsze, a cel jest jaśniejszy.
Rupert Rawnsley
2
@RupertRawnsley, aby zacytować moją odpowiedź:> Niekoniecznie polecam, ale tylko wskazuję, że możesz
drzaus
49

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");
            }
        }
    }
}
Dz.U.
źródło
Ten przykład działa, nawet jeśli pominiesz [Flagi]. To część [Flagi], o której staram się dowiedzieć.
gbarry
39

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 .

Thorkil Holm-Jacobsen
źródło
2
A w C # 7.2 jest jeszcze wyraźniejszy dzięki wiodącemu separatorowi ! 0b_0100
Vincenzo Petronio
37

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.

Keith
źródło
IsSet to metoda rozszerzenia, którą zakładam?
Robert MacLean
Tak - przeczytaj inne pytanie, do którego odsyłam, aby uzyskać szczegółowe informacje: stackoverflow.com/questions/7244
Keith
71
.NET 4 dodaje HasFlagmetodę wyliczania, dzięki czemu możesz zrobić to opt.HasFlag( PossibleOptions.OptionOne )bez konieczności pisania własnych rozszerzeń
Orion Edwards
1
Zauważ, że HasFlagjest to znacznie wolniejsze niż wykonywanie operacji bitowych.
Wai Ha Lee,
1
@WaiHaLee Możesz użyć metody rozszerzenia CodeJam.EnumHelper.IsFlagSet, która jest skompilowana do szybkiej wersji przy użyciu wyrażenia: github.com/rsdn/CodeJam/wiki/M_CodeJam_EnumHelper_IsFlagSet__1
NN_
22

@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)));
steve_c
źródło
18

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

}
Jpsy
źródło
17

Aby dodać Mode.Write:

Mode = Mode | Mode.Write;
David Wengier
źródło
57
lub Mode | = Mode.Write
abatishchev
14

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();
        }
    }
}
bułka z masłem
źródło
Wyliczanie może opierać się na podpisanym typie, dlatego należy użyć „! = 0” zamiast „> 0”.
kruk
@JaimePardos - Tak długo, jak zachowujemy uczciwe bajty, tak jak w tym przykładzie, nie ma pojęcia negatywnego. Tylko od 0 do 255. Jak ostrzega MSDN: „Zachowaj ostrożność, jeśli zdefiniujesz liczbę ujemną jako stałą wyliczoną z flagi, ponieważ ... [to] może sprawić, że Twój kod będzie mylący i zachęci do błędów w kodowaniu”. Dziwnie jest myśleć w kategoriach „negatywnych flag bitowych”! ; ^) Za chwilę dokonam edycji. Ale masz rację, jeśli użyjemy ujemnych wartości w naszym enum, musimy sprawdzić != 0.
ruffin
10

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
}
Jay Mooney
źródło
0

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 [] {});
kbvishnu
źródło