Что означает атрибут Enum [Flags] в C#?
Время от времени я вижу перечисление, подобное следующему:
[Flags]
public enum Options
{
None = 0,
Option1 = 1,
Option2 = 2,
Option3 = 4,
Option4 = 8
}
Я не понимаю, что именно [Flags]Атрибут делает.
У кого-нибудь есть хорошее объяснение или пример, который они могли бы опубликовать?
14 ответов
[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
}
Значения, если они объявлены таким образом, будут Yellow = 0, Green = 1, Red = 2, Blue = 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
Точно так же, после того как вы установили для свойства AllowedColors значение Red, Green и Blue с помощью двоичного двоичного ИЛИ | Оператор 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 в побитовой операции 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 и так далее. Это не влияет на ваш код, потому что все это делается во время компиляции
Комбинируя ответы /questions/14144956/chto-oznachaet-atribut-enum-flags-v-c/14144987#14144987 (объявление через битовое смещение) и /questions/14144956/chto-oznachaet-atribut-enum-flags-v-c/14144999#14144999 (используя комбинации в объявлении), вы можете скорее сдвинуть битовые предыдущие значения чем с помощью чисел. Не обязательно рекомендовать это, но просто указав, что вы можете.
Скорее, чем:
[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
В дополнение к принятому ответу, в C#7 флаги перечисления могут быть записаны с использованием двоичных литералов:
[Flags]
public enum MyColors
{
None = 0b0000,
Yellow = 0b0001,
Green = 0b0010,
Red = 0b0100,
Blue = 0b1000
}
Я думаю, что это представление проясняет, как флаги работают под крышками.
Пожалуйста, посмотрите следующее для примера, который показывает объявление и потенциальное использование:
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]
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 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
Чтобы добавить другой флаг к существующему набору значений, используйте оператор присваивания ИЛИ.
Mode = Mode.Read;
//Add Mode.Write
Mode |= Mode.Write;
Assert.True(((Mode & Mode.Write) == Mode.Write)
&& ((Mode & Mode.Read) == Mode.Read)));
Флаги позволяют вам использовать битовую маскировку в вашем перечислении. Это позволяет комбинировать значения перечисления, сохраняя при этом, какие из них указаны.
[Flags]
public enum DashboardItemPresentationProperties : long
{
None = 0,
HideCollapse = 1,
HideDelete = 2,
HideEdit = 4,
HideOpenInNewWindow = 8,
HideResetSource = 16,
HideMenu = 32
}
Есть что-то слишком многословное для меня о if ((x & y) == y)... построить, особенно если x А ТАКЖЕ y оба составных набора флагов, и вы только хотите знать, есть ли совпадения.
В этом случае все, что вам действительно нужно знать, это наличие ненулевого значения [1] после того, как вы замаскировали.
[1] См. Комментарий Хайме. Если бы мы были подлинно замаскированы, нам нужно было только проверить, что результат был положительным. Но с тех пор
enums может быть отрицательным, даже, как ни странно, в сочетании с[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();
}
}
}
Определите проблему
Давайте определим перечисление, представляющее типы пользователей:
public enum UserType
{
Customer = 1,
Driver = 2,
Admin = 3,
}
Мы определяем перечисление UserType, которое содержит три значения:Customer, Driver, and Admin.
Но что, если нам нужно представить набор значений?
Например, в компании по доставке мы знаем, что и администратор, и водитель являются сотрудниками. Итак, добавим новый элемент перечисления. Позже мы покажем вам, как мы можем представить с его помощью как администратора, так и водителя:
public enum UserType
{
Customer = 1,
Driver = 2,
Admin = 3,
Employee = 4
}
Определите и объявите атрибут флагов
Флаги — это атрибут, который позволяет нам представлять перечисление как набор значений, а не одно значение. Итак, давайте посмотрим, как мы можем реализовать атрибут Flags для перечисления:
[Flags]
public enum UserType
{
Customer = 1,
Driver = 2,
Admin = 4,
}
Мы добавляем атрибут и нумеруем значения со степенью двойки. Без обоих это не сработает.
Теперь, возвращаясь к нашей предыдущей задаче, мы можем представить с помощью оператора:
var employee = UserType.Driver | UserType.Admin;
Кроме того, мы можем определить его как константу внутри перечисления, чтобы использовать его напрямую:
[Flags]
public enum UserType
{
Customer = 1,
Driver = 2,
Admin = 4,
Employee = Driver | Admin
}
За кулисами
Чтобы лучше понять атрибут, мы должны вернуться к двоичному представлению числа. Например, мы можем представить 1 как двоичный0b_0001и 2 как0b_0010:
[Flags]
public enum UserType
{
Customer = 0b_0001,
Driver = 0b_0010,
Admin = 0b_0100,
Employee = Driver | Admin, //0b_0110
}
Мы видим, что каждое значение представлено активным битом. Отсюда и пришла идея нумерации значений степенью 2. Мы также можем отметить, чтоEmployeeсодержит два активных бита, то есть является составным из двух значений Driver и Admin.
Операции с атрибутом флагов
Мы можем использовать побитовые операторы для работы сFlags.
Инициализировать значение
Для инициализации мы должны использовать значение 0 с именем None, что означает, что коллекция пуста:
[Flags]
public enum UserType
{
None = 0,
Customer = 1,
Driver = 2,
Admin = 4,
Employee = Driver | Admin
}
Теперь мы можем определить переменную:
var flags = UserType.None;
Добавить значение
Мы можем повысить ценность, используя|оператор:
flags |= UserType.Driver;
Теперь переменная flags равна Driver.
Удалить значение
Мы можем удалить значение, используя&, ~операторы:
flags &= ~UserType.Driver;
Теперь переменная flags равна None.
Мы можем проверить, существует ли значение, используя оператор:
Console.WriteLine((flags & UserType.Driver) == UserType.Driver);
РезультатFalse.
Кроме того, мы можем сделать это с помощью метода:
Console.WriteLine(flags.HasFlag(UserType.Driver));
Кроме того, результатом будет False.
Как мы видим, в обоих случаях, используя&оператор и метод дают один и тот же результат, но какой из них нам следует использовать? Чтобы выяснить это, мы проверим производительность на нескольких фреймворках.
Измерьте производительность
Сначала мы создадим консольное приложение, а в.csprojфайл мы заменимTargetFramworkтег сTargetFramworksярлык:
<TargetFrameworks>net48;netcoreapp3.1;net6.0</TargetFrameworks>
We use the TargetFramworks tag to support multiple frameworks: .NET Framework 4.8, .Net Core 3.1, and .Net 6.0.
Во-вторых, давайте представимBenchmarkDotNetбиблиотека для получения результатов тестов:
[Benchmark]
public bool HasFlag()
{
var result = false;
for (int i = 0; i < 100000; i++)
{
result = UserType.Employee.HasFlag(UserType.Driver);
}
return result;
}
[Benchmark]
public bool BitOperator()
{
var result = false;
for (int i = 0; i < 100000; i++)
{
result = (UserType.Employee & UserType.Driver) == UserType.Driver;
}
return result;
}
Мы добавляем[SimpleJob(RuntimeMoniker.Net48)],[SimpleJob(RuntimeMoniker.NetCoreApp31)], и[SimpleJob(RuntimeMoniker.Net60)]атрибутыHasFlagBenchmarkerclass, чтобы увидеть разницу в производительности между разными версиями.NET Framework / .NET Core:
Итак, в.NET Framework 4.8аHasFlagметод был намного медленнее, чемBitOperator. Но производительность улучшается в.Net Core 3.1и.Net 6.0. Таким образом, в более новых версиях мы можем использовать оба способа.
Приносим извинения, если кто-то уже заметил этот сценарий. Прекрасный пример флагов, которые мы можем увидеть в отражении. Да Флаги привязки ENUM.https://docs.microsoft.com/en-us/dotnet/api/system.reflection.bindingflags?view=netframework-4.8
[System.Flags]
[System.Runtime.InteropServices.ComVisible(true)]
[System.Serializable]
public enum BindingFlags
Применение
// BindingFlags.InvokeMethod
// Call a static method.
Type t = typeof (TestClass);
Console.WriteLine();
Console.WriteLine("Invoking a static method.");
Console.WriteLine("-------------------------");
t.InvokeMember ("SayHello", BindingFlags.InvokeMethod | BindingFlags.Public |
BindingFlags.Static, null, null, new object [] {});
Флаги используются, когда перечислимое значение представляет коллекцию членов перечисления.
здесь мы используем поразрядные операторы, | и &
пример
[Flags] public enum Sides { Left=0, Right=1, Top=2, Bottom=3 } Sides leftRight = Sides.Left | Sides.Right; Console.WriteLine (leftRight);//Left, Right string stringValue = leftRight.ToString(); Console.WriteLine (stringValue);//Left, Right Sides s = Sides.Left; s |= Sides.Right; Console.WriteLine (s);//Left, Right s ^= Sides.Right; // Toggles Sides.Right Console.WriteLine (s); //Left