Что означает атрибут перечисления [Flags] в C#?
Вопрос
Время от времени я вижу перечисление, подобное следующему:
[Flags]
public enum Options
{
None = 0,
Option1 = 1,
Option2 = 2,
Option3 = 4,
Option4 = 8
}
Я не понимаю, что именно [Flags]
-атрибут делает.
У кого-нибудь есть хорошее объяснение или пример, который они могли бы опубликовать?
Решение
А [Flags]
Атрибут следует использовать всякий раз, когда перечисляемый объект представляет собой набор возможных значений, а не одно значение.Такие коллекции часто используются с побитовыми операторами, например:
var 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, // 0
Green, // 1
Red, // 2
Blue // 3
}
Значения, если они объявлены таким образом, будут: Желтый = 0, Зеленый = 1, Красный = 2, Синий = 3.Это сделает его бесполезным в качестве флагов.
Вот пример правильного объявления:
[Flags]
public enum MyColors
{
Yellow = 1,
Green = 2,
Red = 4,
Blue = 8
}
Чтобы получить отдельные значения в вашем свойстве, можно сделать следующее:
if (myProperties.AllowedColors.HasFlag(MyColor.Yellow))
{
// Yellow is allowed...
}
или до .NET 4:
if((myProperties.AllowedColors & MyColor.Yellow) == MyColor.Yellow)
{
// Yellow is allowed...
}
if((myProperties.AllowedColors & MyColor.Green) == MyColor.Green)
{
// Green is allowed...
}
Под одеялом
Это работает, потому что при перечислении вы использовали степени двойки.Под обложкой ваши значения перечисления выглядят следующим образом (двоичные единицы и нули):
Yellow: 00000001
Green: 00000010
Red: 00000100
Blue: 00001000
Аналогично, после того как вы установили свое свойство Разрешенные цвета к красному, зеленому и синему с помощью двоичного поразрядного ИЛИ |
оператор, Разрешенные цвета выглядит так:
myProperties.AllowedColors: 00001110
Поэтому, когда вы получаете значение, вы фактически выполняете побитовое И. &
по ценностям:
myProperties.AllowedColors: 00001110
MyColor.Green: 00000010
-----------------------
00000010 // Hey, this is the same as MyColor.Green!
Значение Нет = 0
А что касается использования 0
в вашем перечислении, цитируя MSDN:
[Flags]
public enum MyColors
{
None = 0,
....
}
Используйте None в качестве имени перечисляемой константы флага, значение которой равно нулю. Вы не можете использовать перечисляемую константу 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 и так далее.Это не влияет на ваш код, поскольку все выполняется во время компиляции.
Объединение ответов 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
}
Я считаю, что это легче читать, чем большинство способов проверки включенных флагов.
В дополнение к принятому ответу в C#7 флаги перечисления могут быть записаны с использованием двоичных литералов:
[Flags]
public enum MyColors
{
None = 0b0000,
Yellow = 0b0001,
Green = 0b0010,
Red = 0b0100,
Blue = 0b1000
}
Я думаю, что это представление дает понять, как работают флаги. под одеялом.
@Нидоноку
Чтобы добавить еще один флаг к существующему набору значений, используйте оператор присваивания ИЛИ.
Mode = Mode.Read;
//Add Mode.Write
Mode |= Mode.Write;
Assert.True(((Mode & Mode.Write) == Mode.Write)
&& ((Mode & Mode.Read) == Mode.Read)));
Добавить Mode.Write
:
Mode = Mode | Mode.Write;
Мне кажется, что-то слишком многословно в этом if ((x & y) == y)...
построить, особенно если x
И y
оба являются составными наборами флагов, и вам нужно только знать, есть ли любой перекрывать.
В этом случае все, что вам действительно нужно знать, это если после наложения битовой маски есть ненулевое значение[1].
[1] См. комментарий Джейме.Если бы мы были по-настоящему битовая маска, Нам нужно только проверить, что результат был положительным.Но с тех пор
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();
}
}
}
Флаги позволяют использовать битовые маски внутри перечисления.Это позволяет комбинировать значения перечисления, сохраняя при этом те, которые указаны.
[Flags]
public enum DashboardItemPresentationProperties : long
{
None = 0,
HideCollapse = 1,
HideDelete = 2,
HideEdit = 4,
HideOpenInNewWindow = 8,
HideResetSource = 16,
HideMenu = 32
}
При работе с флагами я часто объявляю дополнительные элементы None и All.Это полезно для проверки того, установлены ли все флаги или не установлен ни один флаг.
[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