Время от времени я вижу перечисление следующим образом:
[Flags]
public enum Options
{
None = 0,
Option1 = 1,
Option2 = 2,
Option3 = 4,
Option4 = 8
}
Я не понимаю, что именно делает [Flags] -трибут.
У кого-нибудь есть хорошее объяснение или пример, который они могут опубликовать?
Атрибут flags должен использоваться всякий раз, когда перечисляемый представляет собой набор флагов, а не одно значение. Такие коллекции обычно управляются с помощью побитовых операторов, например:
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] не автоматически делает значения перечисления равными двум. Если вы опустите числовые значения, перечисление не будет работать так, как можно было бы ожидать в побитовых операциях, потому что по умолчанию значения начинаются с 0 и приращения.
Неверное объявление:
[Flags]
public enum MyColors
{
Yellow,
Green,
Red,
Blue
}
Значения, если они объявлены таким образом, будут Yellow = 0, Green = 1, Red = 2, Blue = 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
Аналогично, после того, как вы установили свойство AllowedColors в красный, зеленый и синий (какие значения имеют OR'ed по каналу |), AllowedColors выглядит как
myProperties.AllowedColors: 00001110
Итак, когда вы извлекаете значение, которое вы фактически побитовое, и значения
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, указанную в побитовой операции И, чтобы проверить флаг, потому что результат всегда равен нулю. Однако вы можете выполнить логическое, а не поразрядное сравнение между числовым значением и Нет перечислены константы, чтобы определить, установлены ли какие-либо биты в числовом значении.
Дополнительную информацию об атрибуте 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 и так далее. Это не влияет на ваш код, потому что все это сделано во время компиляции
Объединение ответов fooobar.com/questions/11013/... (декларация с помощью бит-сдвига) и fooobar.com/questions/11013/... (с использованием комбинаций в объявлении), вы можете битово-сдвинуть предыдущие значения, а не использовать числа. Не обязательно рекомендовать это, но просто указывая, что вы можете.
Вместо
[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");
}
}
}
}
I спросил недавно о чем-то подобном.
Если вы используете флаги, вы можете добавить метод расширения для перечисления, чтобы облегчить проверку содержащихся флагов (см. сообщение для подробностей)
Это позволяет:
[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.
Mode = Mode.Read;
//Add Mode.Write
Mode |= Mode.Write;
Assert.True(((Mode & Mode.Write) == Mode.Write)
&& ((Mode & Mode.Read) == Mode.Read)));
В расширении до принятого ответа в С# 7 флаги перечисления могут быть записаны с использованием двоичных литералов:
[Flags]
public enum MyColors
{
None = 0b0000,
Yellow = 0b0001,
Green = 0b0010,
Red = 0b0100,
Blue = 0b1000
}
Я думаю, что это представление дает понять, как работают флаги под обложками.
Чтобы добавить Mode.Write:
Mode = Mode | Mode.Write;
Что-то слишком многословно для меня о конструкции if ((x & y) == y)..., особенно если x AND y являются составными наборами флагов, и вы только хотите знать, существует ли любое перекрытие.
В этом случае все, что вам действительно нужно знать, , если есть ненулевое значение [1] после того, как вы нарисовали битмаскированную.
[1] См. комментарий Хайме. Если бы мы были достоверно битовой маской, мы бы нужно только проверить, что результат положительный. Но так как
enums может быть отрицательным, даже, как ни странно, в сочетании с[Flags]атрибут, он защищен кодом!= 0, а не> 0.
Создание @andnil setup...
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();
}
}
}
Флаги позволяют использовать битмаскирование внутри вашего перечисления. Это позволяет комбинировать значения перечисления, сохраняя при этом те, которые указаны.
[Flags]
public enum DashboardItemPresentationProperties : long
{
None = 0,
HideCollapse = 1,
HideDelete = 2,
HideEdit = 4,
HideOpenInNewWindow = 8,
HideResetSource = 16,
HideMenu = 32
}
При работе с флагами я часто объявляю дополнительные пункты "Нет" и "Все". Они полезны для проверки того, установлены ли все флаги или нет.
[Flags]
enum SuitsFlags {
None = 0,
Spades = 1 << 0,
Clubs = 1 << 1,
Diamonds = 1 << 2,
Hearts = 1 << 3,
All = ~(~0 << 4)
}
Использование:
Spades | Clubs | Diamonds | Hearts == All // true
Spades & Clubs == None // true
Поскольку никто не упомянул об этом, вы также можете использовать возведение в степень следующим образом:
[Flags]
public enum MyEnum
{
None = 0,
First = 2 ^ 0,
Second = 2 ^ 1,
Third = 2 ^ 2,
Fourth = 2 ^ 3
}