Che cosa significa l'attributo Enum [Flags] in C #?

Di tanto in tanto vedo un enum come il seguente:

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

Non capisco esattamente cosa fa l' [Flags]attributo.

Qualcuno ha una buona spiegazione o esempio che potrebbe pubblicare?

L' [Flags]attributo dovrebbe essere usato ogni volta che l'enumerabile rappresenta una raccolta di valori possibili, anziché un singolo valore. Tali raccolte vengono spesso utilizzate con operatori bit a bit, ad esempio:

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

Nota che l' [Flags]attributo non lo abilita da solo - tutto ciò che fa è consentire una buona rappresentazione con il .ToString()metodo:

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"

È anche importante notare che [Flags] non rende automaticamente i valori di enum potenze di due. Se si omettono i valori numerici, l'enum non funzionerà come ci si aspetterebbe in operazioni bit a bit, perché per impostazione predefinita i valori iniziano con 0 e incrementano.

Dichiarazione errata:

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

I valori, se dichiarati in questo modo, saranno Giallo = 0, Verde = 1, Rosso = 2, Blu = 3. Questo lo renderà inutile come flag.

Ecco un esempio di una dichiarazione corretta:

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

Per recuperare i valori distinti nella tua proprietà, puoi farlo:

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

o prima di .NET 4:

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

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

Sotto le coperte

Questo funziona perché hai usato poteri di due nella tua enumerazione. Sotto le copertine, i valori di enumerazione si presentano così in binari e zeri:

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

Allo stesso modo, dopo aver impostato la proprietà AllowColors su Red, Green e Blue utilizzando l' |operatore binario OR bit a bit , AllowColors è simile al seguente:

myProperties.AllowedColors: 00001110

Quindi, quando recuperi il valore, stai effettivamente eseguendo AND bit a bit &sui valori:

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

Il valore Nessuno = 0

E per quanto riguarda l'uso di 0nella tua enumerazione, citando da MSDN:

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

Utilizzare None come nome della costante elencata flag il cui valore è zero. Non è possibile utilizzare la costante enumerata None in un'operazione AND bit a bit per verificare un flag perché il risultato è sempre zero. Tuttavia, è possibile eseguire un confronto logico, non a livello di bit, tra il valore numerico e la costante enumerata Nessuno per determinare se sono impostati eventuali bit nel valore numerico.

Puoi trovare maggiori informazioni sull'attributo flags e sul suo utilizzo su msdn e progettare flag su msdn

Puoi anche farlo

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

Trovo il bit-shifting più facile che scrivere 4,8,16,32 e così via. Non ha alcun impatto sul codice perché è tutto eseguito in fase di compilazione

Combinando le risposte https://stackoverflow.com/a/8462/1037948 (dichiarazione tramite bit-shifting) e https://stackoverflow.com/a/9117/1037948 (usando le combinazioni nella dichiarazione) è possibile spostare in bit i valori precedenti piuttosto che usare i numeri. Non necessariamente raccomandandolo, ma solo sottolineando che puoi.

Piuttosto che:

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

Puoi dichiarare

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

Conferma con LinqPad:

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

Risultati in:

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

Per un esempio, vedere quanto segue che mostra la dichiarazione e il potenziale utilizzo:

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

In aggiunta alla risposta accettata, in C # 7 i flag enum possono essere scritti usando valori letterali binari:

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

Penso che questa rappresentazione chiarisca come funzionano le bandiere sotto le coperte .

Ho chiesto di recente qualcosa di simile.

Se usi i flag puoi aggiungere un metodo di estensione agli enum per rendere più facile il controllo dei flag contenuti (vedi post per i dettagli)

Questo ti permette di fare:

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

Quindi puoi fare:

PossibleOptions opt = PossibleOptions.OptionOneTwoAndThree 

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

Trovo questo più facile da leggere rispetto alla maggior parte dei modi di controllare i flag inclusi.

@Nidonocu

Per aggiungere un altro flag a un set di valori esistente, utilizzare l'operatore di assegnazione OR.

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

Quando lavoro con le bandiere, dichiaro spesso nessuno e tutti gli articoli. Questi sono utili per verificare se tutti i flag sono impostati o se non è stato impostato alcun flag.

[Flags] 
enum SuitsFlags { 

    None =     0,

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

    All =      ~(~0 << 4)

}

Uso:

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

 
Aggiornamento 2019-10:

Da C # 7.0 puoi usare letterali binari, che sono probabilmente più intuitivi da leggere:

[Flags] 
enum SuitsFlags { 

    None =     0b0000,

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

    All =      0b1111

}

Per aggiungere Mode.Write:

Mode = Mode | Mode.Write;

C'è qualcosa di eccessivamente prolisso per me nel if ((x & y) == y)...costrutto, specialmente se xAND ysono entrambi insiemi composti di flag e vuoi solo sapere se c'è qualche sovrapposizione.

In questo caso, tutto ciò che devi veramente sapere è se c'è un valore diverso da [1] dopo aver mascherato il bit .

[1] Vedi il commento di Jaime. Se fossimo autenticamente bitmasking , avremmo solo bisogno di verificare che il risultato fosse positivo. Ma poiché enums può essere negativo, anche, stranamente, se combinato con l' [Flags] attributo , è difensivo codificare != 0piuttosto che > 0.

Creazione della configurazione di @ 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();
        }
    }
}

I flag ti consentono di utilizzare il bitmasking all'interno della tua enumerazione. Ciò consente di combinare i valori di enumerazione, mantenendo quelli specificati.

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

Ci scusiamo se qualcuno ha già notato questo scenario. Un esempio perfetto di bandiere che possiamo vedere in riflessione. Sì Binding Flags 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

uso

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