แอตทริบิวต์ [Flags] Enum หมายถึงอะไรใน C #

บางครั้งฉันเห็น enum เช่นนี้:

[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] ว่าไม่ได้ทำให้พลังค่า enum ของทั้งสองโดยอัตโนมัติ หากคุณเว้นค่าตัวเลข enum จะไม่ทำงานอย่างที่คาดไว้ในการดำเนินการระดับบิตเนื่องจากโดยค่าเริ่มต้นค่าเริ่มต้นด้วย 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

ในทำนองเดียวกันหลังจากที่คุณตั้งค่าคุณสมบัติAllowedColorsของคุณเป็นสีแดงสีเขียวและสีน้ำเงินโดยใช้ตัวดำเนินการ binary bitwise หรือ|ตัวดำเนินการAllowedColorsจะมีลักษณะดังนี้:

myProperties.AllowedColors: 00001110

ดังนั้นเมื่อคุณดึงค่าที่คุณกำลังดำเนินการจริง bitwise และ&ค่า:

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 เป็นชื่อของค่าคงที่ที่ระบุค่าสถานะซึ่งเป็นศูนย์ คุณไม่สามารถใช้ค่าคงที่ไม่มีการแจกแจงในการดำเนินการระดับบิตและระดับบิตเพื่อทดสอบการตั้งค่าสถานะเนื่องจากผลลัพธ์จะเป็นศูนย์เสมอ อย่างไรก็ตามคุณสามารถดำเนินการทางตรรกะไม่ใช่ค่าบิตเปรียบเทียบระหว่างค่าตัวเลขและค่าคงที่ไม่มีการแจกแจงเพื่อกำหนดว่าบิตใด ๆ ในค่าตัวเลขถูกตั้งค่า

คุณสามารถค้นหาข้อมูลเพิ่มเติมเกี่ยวกับแอ็ตทริบิวต์ค่าสถานะและการใช้งานได้ที่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");
            }
        }
    }
}

ในส่วนขยายของคำตอบที่ยอมรับใน C # 7 ธง enum สามารถเขียนได้โดยใช้ตัวอักษรไบนารี:

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

ผมคิดว่าการแสดงนี้จะทำให้มันชัดเจนว่าธงทำงานภายใต้ครอบคลุม

ฉันถามเมื่อเร็ว ๆ นี้เกี่ยวกับสิ่งที่คล้ายกัน

หากคุณใช้การตั้งค่าสถานะคุณสามารถเพิ่มวิธีการขยายการ enums เพื่อให้ตรวจสอบการตั้งค่าสถานะที่มีอยู่ได้ง่ายขึ้น (ดูโพสต์เพื่อดูรายละเอียด)

วิธีนี้ช่วยให้คุณ:

[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)));

เมื่อทำงานกับการตั้งค่าสถานะฉันมักจะประกาศเพิ่มเติมไม่มีรายการและทั้งหมด สิ่งเหล่านี้มีประโยชน์ในการตรวจสอบว่ามีการตั้งค่าสถานะทั้งหมดหรือไม่ตั้งค่าสถานะ

[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

 
อัปเดต 2019-10:

ตั้งแต่ C # 7.0 คุณสามารถใช้ตัวอักษรไบนารีซึ่งน่าจะอ่านง่ายกว่า:

[Flags] 
enum SuitsFlags { 

    None =     0b0000,

    Spades =   0b0001, 
    Clubs =    0b0010, 
    Diamonds = 0b0100, 
    Hearts =   0b1000,

    All =      0b1111

}

วิธีเพิ่มMode.Write:

Mode = Mode | Mode.Write;

มีบางอย่างที่เป็นสุดเหวี่ยง verbose กับผมเกี่ยวกับการif ((x & y) == y)...สร้างโดยเฉพาะอย่างยิ่งถ้าxและyมีทั้งชุดสารประกอบของธงและคุณเพียงต้องการที่จะรู้ว่าถ้ามีใด ๆที่ทับซ้อนกัน

ในกรณีนี้สิ่งที่คุณต้องการจริงๆที่จะรู้คือถ้ามีค่าที่ไม่ใช่ศูนย์ [1] หลังจากที่คุณได้ bitmasked

[1] ดูความคิดเห็นของ Jaime หากเราทำการbitmasking อย่างแท้จริงเราจะต้องตรวจสอบว่าผลลัพธ์นั้นเป็นค่าบวกเท่านั้น แต่เนื่องจาก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();
        }
    }
}

ค่าสถานะอนุญาตให้คุณใช้ bitmasking ในการแจงนับของคุณ สิ่งนี้ช่วยให้คุณสามารถรวมค่าการแจงนับในขณะที่การรักษาที่ระบุไว้

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

ขออภัยหากบางคนสังเกตเห็นสถานการณ์นี้แล้ว ตัวอย่างที่สมบูรณ์แบบของธงที่เราสามารถมองเห็นได้ ใช่การเชื่อมต่อธง 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 [] {});