O que significa o atributo Enum [Flags] em C#?

Question

De vez em quando vejo um enum como o seguinte:

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

Eu não entendo o que exatamente [Flags]-atributo faz.

Alguém tem uma boa explicação ou exemplo que possa postar?

Answer 1

O [Flags] O atributo deve ser usado sempre que o enumerável representar uma coleção de valores possíveis, em vez de um único valor.Essas coleções são frequentemente usadas com operadores bit a bit, por exemplo:

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

Observe que o [Flags] atributo não habilitar isso por si só - tudo o que faz é permitir uma boa representação pelo .ToString() método:

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"

Também é importante notar que [Flags] não torna automaticamente os valores enum potências de dois.Se você omitir os valores numéricos, o enum não funcionará como seria de esperar em operações bit a bit, porque por padrão os valores começam com 0 e incrementam.

Declaração incorreta:

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

Os valores, se declarados desta forma, serão Amarelo = 0, Verde = 1, Vermelho = 2, Azul = 3.Isso o tornará inútil como sinalizadores.

Aqui está um exemplo de uma declaração correta:

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

Para recuperar os valores distintos em sua propriedade, pode-se fazer o seguinte:

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

ou anterior ao .NET 4:

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

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

Debaixo das cobertas

Isso funciona porque você usou potências de dois em sua enumeração.Nos bastidores, seus valores de enumeração ficam assim em uns e zeros binários:

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

Da mesma forma, depois de definir sua propriedade Cores permitidas para vermelho, verde e azul usando o binário OR bit a bit | operador, Cores permitidas se parece com isso:

myProperties.AllowedColors: 00001110

Então, quando você recupera o valor, você está realmente executando AND bit a bit & sobre os valores:

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

O valor Nenhum = 0

E em relação ao uso de 0 na sua enumeração, citando o MSDN:

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

Use None como o nome da constante enumerada do sinalizador cujo valor é zero. Você não pode usar a constante enumerada None em uma operação AND bit a bit para testar um sinalizador porque o resultado é sempre zero. No entanto, você pode executar uma comparação lógica, e não bit a bit, entre o valor numérico e a constante enumerada None para determinar se algum bit no valor numérico está definido.

Você pode encontrar mais informações sobre o atributo flags e seu uso em msdn e projetando bandeiras no msdn

Answer 2

Você também pode fazer isso

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

Acho a mudança de bits mais fácil do que digitar 4,8,16,32 e assim por diante.Não tem impacto no seu código porque tudo é feito em tempo de compilação

Answer 3

Combinando respostas https://stackoverflow.com/a/8462/1037948 (declaração via mudança de bits) e https://stackoverflow.com/a/9117/1037948 (usando combinações na declaração) você pode alterar os valores anteriores em vez de usar números.Não necessariamente recomendando, mas apenas apontando que você pode.

Em vez de:

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

Você pode declarar

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

---

Confirmando com LinqPad:

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

Resulta em:

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

Answer 4

Consulte o seguinte exemplo que mostra a declaração e o uso potencial:

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

Answer 5

EU perguntou recentemente sobre algo semelhante.

Se você usar sinalizadores, poderá adicionar um método de extensão às enums para facilitar a verificação dos sinalizadores contidos (consulte a postagem para obter detalhes)

Isso permite que você faça:

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

Então você pode fazer:

PossibleOptions opt = PossibleOptions.OptionOneTwoAndThree 

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

Acho isso mais fácil de ler do que a maioria das maneiras de verificar os sinalizadores incluídos.

Answer 6

Além da resposta aceita, em C#7 os sinalizadores enum podem ser escritos usando literais binários:

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

Acho que essa representação deixa claro como funcionam as bandeiras debaixo das cobertas.

Answer 7

@Nidonocu

Para adicionar outro sinalizador a um conjunto existente de valores, use o operador de atribuição OR.

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

Answer 8

Adicionar Mode.Write:

Mode = Mode | Mode.Write;

Answer 9

Há algo excessivamente detalhado para mim sobre o if ((x & y) == y)... construir, especialmente se x E y são conjuntos compostos de sinalizadores e você só quer saber se há qualquer sobreposição.

Neste caso, tudo o que você realmente precisa saber é se houver um valor diferente de zero[1] depois de aplicar a máscara de bits.

[1] Veja o comentário de Jaime.Se fôssemos autenticamente máscara de bits, só precisamos verificar se o resultado foi positivo.Mas desde enums pode ser negativo, mesmo, estranhamente, quando combinado com o [Flags]atributo, é defensivo codificar != 0 em vez de > 0.

Construindo a partir da configuração de @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();
        }
    }
}

Answer 10

Os sinalizadores permitem que você use bitmasking dentro de sua enumeração.Isso permite combinar valores de enumeração, mantendo quais são especificados.

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

Answer 11

Ao trabalhar com sinalizadores, geralmente declaro itens adicionais Nenhum e Todos.Eles são úteis para verificar se todos os sinalizadores estão definidos ou se nenhum sinalizador está definido.

[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