Cosa significa l'attributo Enum [Flags] in C#?
Domanda
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 cosa esattamente [Flags]
-l'attributo lo fa.
Qualcuno ha una buona spiegazione o un esempio da pubblicare?
Soluzione
IL [Flags]
L'attributo dovrebbe essere utilizzato ogni volta che l'enumerabile rappresenta una raccolta di possibili valori, anziché un singolo valore.Tali raccolte vengono spesso utilizzate con operatori bit a bit, ad esempio:
var allowedColors = MyColor.Red | MyColor.Green | MyColor.Blue;
Si noti che il [Flags]
attributo no abilitarlo da solo: tutto ciò che fa è consentire una bella rappresentazione da parte di .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 questo [Flags]
non rende automaticamente i valori enumerativi potenze di due.Se ometti i valori numerici, l'enumerazione non funzionerà come ci si potrebbe aspettare nelle operazioni bit a bit, perché per impostazione predefinita i valori iniziano con 0 e aumentano.
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.Ciò lo renderà inutilizzabile come flag.
Ecco un esempio di dichiarazione corretta:
[Flags]
public enum MyColors
{
Yellow = 1,
Green = 2,
Red = 4,
Blue = 8
}
Per recuperare i valori distinti nella tua proprietà, puoi fare questo:
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
Funziona perché hai utilizzato le potenze di due nella tua enumerazione.Sotto le coperte, i valori di enumerazione appaiono così in binari e zeri:
Yellow: 00000001
Green: 00000010
Red: 00000100
Blue: 00001000
Allo stesso modo, dopo aver impostato la tua proprietà Colori consentiti a Rosso, Verde e Blu utilizzando l'OR binario bit a bit |
operatore, Colori consentiti Somiglia a questo:
myProperties.AllowedColors: 00001110
Pertanto, 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 0
nella tua enumerazione, citando da MSDN:
[Flags]
public enum MyColors
{
None = 0,
....
}
Utilizzare None come nome della costante enumerata flag il cui valore è zero. Non è possibile utilizzare la costante enumerata None in un'operazione AND bit per bit per verificare la presenza di un flag perché il risultato è sempre zero. Tuttavia, è possibile eseguire un confronto logico, non bit per bit, tra il valore numerico e la costante enumerata None per determinare se sono impostati bit nel valore numerico.
Puoi trovare maggiori informazioni sull'attributo flags e sul suo utilizzo su msdn E progettazione di flag su msdn
Altri suggerimenti
Puoi anche farlo
[Flags]
public enum MyEnum
{
None = 0,
First = 1 << 0,
Second = 1 << 1,
Third = 1 << 2,
Fourth = 1 << 3
}
Trovo che lo spostamento di bit sia più semplice rispetto alla digitazione di 4,8,16,32 e così via.Non ha alcun impatto sul tuo codice perché viene eseguito tutto 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) puoi spostare i valori precedenti invece di usare i numeri.Non necessariamente raccomandarlo, ma solo sottolinearlo 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
Si prega di consultare quanto segue per un esempio 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");
}
}
}
}
IO chiesto di recente riguardo a qualcosa di simile.
Se usi i flag puoi aggiungere un metodo di estensione alle enumerazioni per facilitare il controllo dei flag contenuti (vedi post per i dettagli)
Ciò ti consente 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 che questo sia più facile da leggere rispetto alla maggior parte dei modi per controllare i flag inclusi.
In estensione alla risposta accettata, in C#7 i flag enum possono essere scritti utilizzando 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.
@Nidonocu
Per aggiungere un altro flag a un insieme 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)));
Aggiungere Mode.Write
:
Mode = Mode | Mode.Write;
C'è qualcosa di eccessivamente prolisso per me riguardo al if ((x & y) == y)...
costruire, soprattutto se x
E y
sono entrambi insiemi composti di flag e vuoi solo sapere se c'è Qualunque sovrapposizione.
In questo caso, tutto ciò che devi veramente sapere è se c'è un valore diverso da zero[1] dopo aver applicato la maschera di bit.
[1] Vedi il commento di Jaime.Se fossimo autenticamente bitmasking, dovremmo solo verificare che il risultato fosse positivo.Ma da allora
enum
S può essere negativo, anche stranamente, se combinato con IL[Flags]
attributo, è difensivo codificare!= 0
piuttosto che> 0
.
Basandosi sulla 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
}
Quando lavoro con i flag spesso dichiaro elementi aggiuntivi Nessuno e Tutti.Questi sono utili per verificare se tutti i flag sono impostati o se non è impostato alcun flag.
[Flags]
enum SuitsFlags {
None = 0,
Spades = 1 << 0,
Clubs = 1 << 1,
Diamonds = 1 << 2,
Hearts = 1 << 3,
All = ~(~0 << 4)
}
Utilizzo:
Spades | Clubs | Diamonds | Hearts == All // true
Spades & Clubs == None // true