Что означает атрибут [Flags] Enum в C#?
время от времени я вижу перечисление следующим образом:
[Flags]
public enum Options
{
None = 0,
Option1 = 1,
Option2 = 2,
Option3 = 4,
Option4 = 8
}
Я не понимаю, что именно [Flags]
-атрибут делает.
у кого-нибудь есть хорошее объяснение или пример, они могли бы разместить?
10 ответов
атрибут flags должен использоваться всякий раз, когда enumerable представляет коллекцию флагов, а не одно значение. Такие коллекции обычно обрабатываются с помощью побитовых операторов, например:
myProperties.AllowedColors = MyColor.Red | MyColor.Green | MyColor.Blue;
отметим, что [Flags]
само по себе это не меняет на всех - все, что он делает, это включить хорошее представление .ToString()
способ:
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"
также важно отметить, что [Flags]
не автоматически сделать enum значения полномочия двух. Если вы опустите числовые значения, перечисление не будет работать так, как можно было бы ожидать в побитовых операциях, потому что по умолчанию значения начинаются с 0 и increment.
некорректное заявление:
[Flags]
public enum MyColors
{
Yellow,
Green,
Red,
Blue
}
значения, если объявлено таким образом, будет желтый = 0, зеленый = 1, красный = 2, синий = 3. Это сделает его бесполезным для использования в качестве флагов.
вот пример правильного объявление:
[Flags]
public enum MyColors
{
Yellow = 1,
Green = 2,
Red = 4,
Blue = 8
}
чтобы получить различные значения в вашем свойстве, можно сделать следующее:
if((myProperties.AllowedColors & MyColor.Yellow) == MyColor.Yellow)
{
// Yellow has been set...
}
if((myProperties.AllowedColors & MyColor.Green) == MyColor.Green)
{
// Green has been set...
}
или,.Net 4 и позже:
if (myProperties.AllowedColors.HasFlag(MyColor.Yellow))
{
// Yellow has been set...
}
под одеялом
это работает, потому что вы ранее использовали полномочия в перечисление. Под обложками ваши значения перечисления выглядят так (представлены в виде байтов, которые имеют 8 бит, которые могут быть 1 или 0)
Yellow: 00000001
Green: 00000010
Red: 00000100
Blue: 00001000
аналогично, после установки ваша собственность!--40-->AllowedColors к красному, зеленому и синему (который значения где OR'Ed трубой|),AllowedColors выглядит так
myProperties.AllowedColors: 00001110
поэтому, когда вы получаете значение, вы на самом деле побитовые и ' ING значения
myProperties.AllowedColors: 00001110
MyColor.Green: 00000010
-----------------------
00000010 // Hey, this is the same as MyColor.Green!
значение None = 0
и относительно использования 0 в перечислении, цитируя из msdn:
[Flags]
public enum MyColors
{
None = 0,
....
}
использовать None в качестве имени перечисляемого флага константа, значение которой равно нулю. вы не можете использовать константу None перечисленную в побитовой операции AND для проверки флага, потому что результат всегда равен нулю. однако вы можете выполнить логическое, а не побитовое сравнение между числовым значением и константой None, чтобы определить, установлены ли какие-либо биты в числовом значении.
вы можете найти более подробную информацию об атрибуте flags и его использовании в в MSDN и проектирование флаги на веб-узле MSDN
вы также можете сделать это
[Flags]
public enum MyEnum
{
None = 0,
First = 1 << 0,
Second = 1 << 1,
Third = 1 << 2,
Fourth = 1 << 3
}
Я нахожу бит-сдвиг проще, чем вводить 4,8,16,32 и так далее. Это не влияет на ваш код, потому что все это делается во время компиляции
объединение ответов https://stackoverflow.com/a/8462/1037948 (объявление через бит-перенос) и https://stackoverflow.com/a/9117/1037948 (используя комбинации в объявлении) вы можете бит-сдвинуть предыдущие значения, а не использовать числа. Не обязательно рекомендовать его, но просто указать, что вы можете.
вместо:
[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,
}
вы можете объявить
[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,
}
подтверждение Помощью linqpad:
foreach(var e in Enum.GetValues(typeof(Options))) {
string.Format("{0} = {1}", e.ToString(), (byte)e).Dump();
}
результаты:
None = 0
One = 1
Two = 2
OneAndTwo = 3
Three = 4
OneTwoAndThree = 7
Four = 8
пожалуйста, смотрите следующий пример, который показывает объявление и потенциальное использование:
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");
}
}
}
}
Я недавно попросил о чем-то подобном.
Если вы используете флаги, вы можете добавить метод расширения в перечисления, чтобы упростить проверку содержащихся флагов (см. сообщение для деталей)
Это позволяет делать:
[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,
...
}
затем вы можете сделать:
PossibleOptions opt = PossibleOptions.OptionOneTwoAndThree
if( opt.IsSet( PossibleOptions.OptionOne ) ) {
//optionOne is one of those set
}
Я считаю, что это легче читать, чем большинство способов проверки включенных флагов.
@Nidonocu
чтобы добавить другой флаг к существующему набору значений, используйте оператор OR assignment.
Mode = Mode.Read;
//Add Mode.Write
Mode |= Mode.Write;
Assert.True(((Mode & Mode.Write) == Mode.Write)
&& ((Mode & Mode.Read) == Mode.Read)));
в расширении принятого ответа, в C#7 флаги перечисления могут быть записаны с использованием двоичных литералов:
[Flags]
public enum MyColors
{
None = 0b0000,
Yellow = 0b0001,
Green = 0b0010,
Red = 0b0100,
Blue = 0b1000
}
Я думаю, что это представление дает понять, как работают флаги под одеялом.
есть что-то слишком многословное для меня о if ((x & y) == y)...
строительство, особенно если x
и y
оба составных набора флагов, и вы только хотите знать, есть ли любой перекрытие.
в этом случае, все, что вам действительно нужно знать, - это если есть ненулевое значение[1] после того, как вы bitmasked.
[1] см. комментарий Хайме. Если бы мы были подлинно bitmasking, мы бы только нужно проверить что результат положительный. Но с
enum
s может быть отрицательным, даже, как ни странно, в сочетании с на[Flags]
атрибут, это оборонительный код для!= 0
, а не> 0
.
построение из установки @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();
}
}
}
флаги позволяют использовать bitmasking внутри вашего перечисления. Это позволяет комбинировать значения перечисления, сохраняя при этом, какие из них указаны.
[Flags]
public enum DashboardItemPresentationProperties : long
{
None = 0,
HideCollapse = 1,
HideDelete = 2,
HideEdit = 4,
HideOpenInNewWindow = 8,
HideResetSource = 16,
HideMenu = 32
}