Enum ToString ด้วยสตริงที่เป็นมิตรกับผู้ใช้

Enum ของฉันประกอบด้วยค่าต่อไปนี้:

private enum PublishStatusses{
    NotCompleted,
    Completed,
    Error
};

ฉันต้องการที่จะสามารถส่งออกค่าเหล่านี้ในทางที่เป็นมิตรกับผู้ใช้ว่า
ฉันไม่จำเป็นต้องเปลี่ยนจากสตริงเป็นค่าอีกครั้ง

ฉันใช้Descriptionคุณลักษณะจาก System.ComponentModel namespace เพียงตกแต่ง Enum:

private enum PublishStatusValue
{
    [Description("Not Completed")]
    NotCompleted,
    Completed,
    Error
};

จากนั้นใช้รหัสนี้เพื่อดึงข้อมูล:

public static string GetDescription<T>(this T enumerationValue)
    where T : struct
{
    Type type = enumerationValue.GetType();
    if (!type.IsEnum)
    {
        throw new ArgumentException("EnumerationValue must be of Enum type", "enumerationValue");
    }

    //Tries to find a DescriptionAttribute for a potential friendly name
    //for the enum
    MemberInfo[] memberInfo = type.GetMember(enumerationValue.ToString());
    if (memberInfo != null && memberInfo.Length > 0)
    {
        object[] attrs = memberInfo[0].GetCustomAttributes(typeof(DescriptionAttribute), false);

        if (attrs != null && attrs.Length > 0)
        {
            //Pull out the description value
            return ((DescriptionAttribute)attrs[0]).Description;
        }
    }
    //If we have no description attribute, just return the ToString of the enum
    return enumerationValue.ToString();
}

ฉันทำได้ด้วยวิธีการขยาย:

public enum ErrorLevel
{
  None,
  Low,
  High,
  SoylentGreen
}

public static class ErrorLevelExtensions
{
  public static string ToFriendlyString(this ErrorLevel me)
  {
    switch(me)
    {
      case ErrorLevel.None:
        return "Everything is OK";
      case ErrorLevel.Low:
        return "SNAFU, if you know what I mean.";
      case ErrorLevel.High:
        return "Reaching TARFU levels";
      case ErrorLevel.SoylentGreen:
        return "ITS PEOPLE!!!!";
      default:
        return "Get your damn dirty hands off me you FILTHY APE!";
    }
  }
}

บางทีฉันอาจจะพลาดบางอย่าง แต่เกิดอะไรขึ้นกับ Enum.GetName?

public string GetName(PublishStatusses value)
{
    return Enum.GetName(typeof(PublishStatusses), value)
}

แก้ไข: สำหรับสตริงที่เป็นมิตรกับผู้ใช้คุณต้องผ่าน .resource เพื่อให้การแปลเป็นภาษาท้องถิ่น / สากลและมันจะดีกว่าที่จะใช้รหัสคงที่ตามคีย์ enum มากกว่าแอตทริบิวต์มัณฑนากรในที่เดียวกัน

ฉันสร้างวิธีการขยายย้อนกลับเพื่อแปลงคำอธิบายกลับเป็นค่า enum:

public static T ToEnumValue<T>(this string enumerationDescription) where T : struct
{
    var type = typeof(T);

    if (!type.IsEnum)
        throw new ArgumentException("ToEnumValue<T>(): Must be of enum type", "T");

    foreach (object val in System.Enum.GetValues(type))
        if (val.GetDescription<T>() == enumerationDescription)
            return (T)val;

    throw new ArgumentException("ToEnumValue<T>(): Invalid description for enum " + type.Name, "enumerationDescription");
}

ทางออกที่ง่ายที่สุดที่นี่คือการใช้วิธีการขยายที่กำหนดเอง (ใน. NET 3.5 อย่างน้อย - คุณสามารถแปลงเป็นวิธีผู้ช่วยคงที่สำหรับรุ่นกรอบก่อนหน้า)

public static string ToCustomString(this PublishStatusses value)
{
    switch(value)
    {
        // Return string depending on value.
    }
    return null;
}

ฉันสมมุติว่าคุณต้องการส่งคืนสิ่งอื่นนอกเหนือจากชื่อจริงของค่า enum (ซึ่งคุณสามารถรับได้โดยเพียงแค่โทร ToString)

โพสต์อื่นนั่นคือ Java คุณไม่สามารถใส่วิธีใน Enums ใน C #

ทำอะไรแบบนี้:

PublishStatusses status = ...
String s = status.ToString();

หากคุณต้องการใช้ค่าการแสดงผลที่แตกต่างกันสำหรับค่า enum ของคุณคุณสามารถใช้แอตทริบิวต์และ Reflection

วิธีที่ง่ายที่สุดคือการรวมคลาสส่วนขยายนี้ไว้ในโครงการของคุณซึ่งจะทำงานร่วมกับ enum ใด ๆ ในโครงการ:

public static class EnumExtensions
{
    public static string ToFriendlyString(this Enum code)
    {
        return Enum.GetName(code.GetType(), code);
    }
}

การใช้งาน:

enum ExampleEnum
{
    Demo = 0,
    Test = 1, 
    Live = 2
}

...

ExampleEnum ee = ExampleEnum.Live;
Console.WriteLine(ee.ToFriendlyString());

ตัวเลือกดั้งเดิมอื่น ๆ เพิ่มเติมที่หลีกเลี่ยงคลาส / ประเภทการอ้างอิง:

• วิธีการอาร์เรย์
• วิธีซ้อนโครงสร้าง

วิธีการอาร์เรย์

private struct PublishStatusses
{
    public static string[] Desc = {
        "Not Completed",
        "Completed",
        "Error"
    };

    public enum Id
    {
        NotCompleted = 0,
        Completed,
        Error
    };
}

การใช้

string desc = PublishStatusses.Desc[(int)PublishStatusses.Id.Completed];

วิธีซ้อนโครงสร้าง

private struct PublishStatusses
{
    public struct NotCompleted
    {
        public const int Id = 0;
        public const string Desc = "Not Completed";
    }

    public struct Completed
    {
        public const int Id = 1;
        public const string Desc = "Completed";
    }

    public struct Error
    {
        public const int Id = 2;
        public const string Desc = "Error";
    }            
}

การใช้

int id = PublishStatusses.NotCompleted.Id;
string desc = PublishStatusses.NotCompleted.Desc;

อัปเดต (03/09/2018)

ไฮบริดของวิธีการขยายและเทคนิคแรกข้างต้น

ฉันต้องการให้กำหนดจำนวน enums ที่พวกเขา "เป็น" (ใกล้กับแหล่งกำเนิดของพวกเขาและไม่ได้อยู่ในบาง namespace ทั่วโลกร่วมกัน)

namespace ViewModels
{
    public class RecordVM
    {
        //public enum Enum { Minutes, Hours }
        public struct Enum
        {
            public enum Id { Minutes, Hours }
            public static string[] Name = { "Minute(s)", "Hour(s)" };
        }
    }
}

ดูเหมือนว่าวิธีการขยายเหมาะสำหรับพื้นที่ส่วนกลางและนิยาม "การแปล" ของ enum ตอนนี้ทำให้วิธีการขยายอย่างละเอียดยิ่งขึ้น

namespace Common
{
    public static class EnumExtensions
    {
        public static string Name(this RecordVM.Enum.Id id)
        {
            return RecordVM.Enum.Name[(int)id];
        }
    }   
}

ตัวอย่างการใช้ enum และวิธีการขยาย

namespace Views
{
    public class RecordView 
    {
        private RecordDataFieldList<string, string> _fieldUnit;

        public RecordView()
        {
            _fieldUnit.List = new IdValueList<string, string>
            {            
                new ListItem<string>((int)RecordVM.Enum.Id.Minutes, RecordVM.Enum.Id.Minutes.Name()),
                new ListItem<string>((int)RecordVM.Enum.Id.Hours, RecordVM.Enum.Id.Hours.Name())
            };
        }

        private void Update()
        {    
            RecordVM.Enum.Id eId = DetermineUnit();

            _fieldUnit.Input.Text = _fieldUnit.List.SetSelected((int)eId).Value;
        }
    }
}

หมายเหตุ:ฉันตัดสินใจที่จะกำจัดEnumwrapper (และNamearray) จริง ๆ แล้วเนื่องจากเป็นสิ่งที่ดีที่สุดที่สตริงชื่อมาจากทรัพยากร (เช่นไฟล์ config หรือ DB) แทนที่จะเป็นรหัสยากและเพราะฉันสิ้นสุดการวางวิธีการขยายในViewModelsเนมสเปซ (ในไฟล์ "CommonVM.cs" อื่น) รวมทุกอย่าง.Idกลายเป็นสิ่งที่ทำให้เสียสมาธิและยุ่งยาก

namespace ViewModels
{
    public class RecordVM
    {
        public enum Enum { Minutes, Hours }
        //public struct Enum
        //{
        //    public enum Id { Minutes, Hours }
        //    public static string[] Name = { "Minute(s)", "Hour(s)" };
        //}
    }
}

CommonVM.cs

//namespace Common
namespace ViewModels
{
    public static class EnumExtensions
    {
        public static string Name(this RecordVM.Enum id)
        {
            //return RecordVM.Enum.Name[(int)id];
            switch (id)
            {
                case RecordVM.Enum.Minutes: return "Minute(s)";                    
                case RecordVM.Enum.Hours: return "Hour(s)";
                default: return null;
            }
        }
    }   
}

ตัวอย่างการใช้ enum และวิธีการขยาย

namespace Views
{
    public class RecordView 
    {
        private RecordDataFieldList<string, string> _fieldUnit

        public RecordView()
        {
            _fieldUnit.List = new IdValueList<string, string>
            {            
                new ListItem<string>((int)RecordVM.Enum.Id.Minutes, RecordVM.Enum.Id.Minutes.Name()),
                new ListItem<string>((int)RecordVM.Enum.Id.Hours, RecordVM.Enum.Id.Hours.Name())
            };
        }

        private void Update()
        {    
            RecordVM.Enum eId = DetermineUnit();

            _fieldUnit.Input.Text = _fieldUnit.List.SetSelected((int)eId).Value;
        }
    }
}

คุณสามารถใช้Humanizerแพคเกจที่มีเมตตากรุณา Enums possiblity ตัวอย่าง:

enum PublishStatusses
{
    [Description("Custom description")]
    NotCompleted,
    AlmostCompleted,
    Error
};

จากนั้นคุณสามารถใช้Humanizeวิธีการขยายบน enum โดยตรง:

var st1 = PublishStatusses.NotCompleted;
var str1 = st1.Humanize(); // will result in Custom description

var st2 = PublishStatusses.AlmostCompleted;
var str2 = st2.Humanize(); // will result in Almost completed (calculated automaticaly)

ด้วยความเคารพ Ray Booysen มีข้อผิดพลาดในรหัส: Enum ToString กับสตริงที่เป็นมิตรต่อผู้ใช้

คุณจำเป็นต้องมีคุณสมบัติหลายบัญชีในค่า enum

public static string GetDescription<T>(this object enumerationValue)
            where T : struct
    {
        Type type = enumerationValue.GetType();
        if (!type.IsEnum)
        {
            throw new ArgumentException("EnumerationValue must be of Enum type", "enumerationValue");
        }

        //Tries to find a DescriptionAttribute for a potential friendly name
        //for the enum
        MemberInfo[] memberInfo = type.GetMember(enumerationValue.ToString());
        if (memberInfo != null && memberInfo.Length > 0)
        {
            object[] attrs = memberInfo[0].GetCustomAttributes(typeof(DescriptionAttribute), false);

            if (attrs != null && attrs.Length > 0 && attrs.Where(t => t.GetType() == typeof(DescriptionAttribute)).FirstOrDefault() != null)
            {
                //Pull out the description value
                return ((DescriptionAttribute)attrs.Where(t=>t.GetType() == typeof(DescriptionAttribute)).FirstOrDefault()).Description;
            }
        }
        //If we have no description attribute, just return the ToString of the enum
        return enumerationValue.ToString();

public enum MyEnum
{
    [Description("Option One")]
    Option_One
}

public static string ToDescriptionString(this Enum This)
{
    Type type = This.GetType();

    string name = Enum.GetName(type, This);

    MemberInfo member = type.GetMembers()
        .Where(w => w.Name == name)
        .FirstOrDefault();

    DescriptionAttribute attribute = member != null
        ? member.GetCustomAttributes(true)
            .Where(w => w.GetType() == typeof(DescriptionAttribute))
            .FirstOrDefault() as DescriptionAttribute
        : null;

    return attribute != null ? attribute.Description : name;
}

แทนที่จะใช้ enum ให้ใช้คลาสแบบคงที่

แทนที่

private enum PublishStatuses{
    NotCompleted,
    Completed,
    Error
};

กับ

private static class PublishStatuses{
    public static readonly string NotCompleted = "Not Completed";
    public static readonly string Completed = "Completed";
    public static readonly string Error = "Error";
};

มันจะถูกใช้เช่นนี้

PublishStatuses.NotCompleted; // "Not Completed"

ปัญหาโดยใช้วิธีแก้ปัญหา "วิธีการขยาย" ด้านบน:

Enum ส่วนตัวมักจะใช้ในชั้นเรียนอื่น โซลูชันเมธอดส่วนขยายไม่ถูกต้องเนื่องจากต้องอยู่ในคลาสของตัวเอง โซลูชันนี้สามารถเป็นส่วนตัวและฝังตัวในคลาสอื่น

ฉันเป็นแฟน VB.NET ดังนั้นนี่คือรุ่นของฉันซึ่งรวมเมธอด DescriptionAttribute เข้ากับวิธีการขยาย ก่อนผลลัพธ์:

Imports System.ComponentModel ' For <Description>

Module Module1
  ''' <summary>
  ''' An Enum type with three values and descriptions
  ''' </summary>
  Public Enum EnumType
    <Description("One")>
    V1 = 1

    ' This one has no description
    V2 = 2

    <Description("Three")>
    V3 = 3
  End Enum

  Sub Main()
    ' Description method is an extension in EnumExtensions
    For Each v As EnumType In [Enum].GetValues(GetType(EnumType))
      Console.WriteLine("Enum {0} has value {1} and description {2}",
        v,
        CInt(v),
        v.Description
      )
    Next
    ' Output:
    ' Enum V1 has value 1 and description One
    ' Enum V2 has value 2 and description V2
    ' Enum V3 has value 3 and description Three
  End Sub
End Module

สิ่งของพื้นฐาน: Enum เรียกว่า EnumType ที่มีสามค่า V1, V2 และ V3 "วิเศษ" ที่เกิดขึ้นในการเรียก Console.WriteLine ใน Sub Main () v.Descriptionที่อาร์กิวเมนต์สุดท้ายเป็นเพียง สิ่งนี้จะคืนค่า "หนึ่ง" สำหรับ V1, "V2" สำหรับ V2 และ "สาม" สำหรับ V3 คำอธิบาย - วิธีการนี้เป็นวิธีการขยายที่กำหนดไว้ในโมดูลอื่นที่เรียกว่า EnumExtensions:

Option Strict On
Option Explicit On
Option Infer Off

Imports System.Runtime.CompilerServices
Imports System.Reflection
Imports System.ComponentModel

Module EnumExtensions
  Private _Descriptions As New Dictionary(Of String, String)

  ''' <summary>
  ''' This extension method adds a Description method
  ''' to all enum members. The result of the method is the
  ''' value of the Description attribute if present, else
  ''' the normal ToString() representation of the enum value.
  ''' </summary>
  <Extension>
  Public Function Description(e As [Enum]) As String
    ' Get the type of the enum
    Dim enumType As Type = e.GetType()
    ' Get the name of the enum value
    Dim name As String = e.ToString()

    ' Construct a full name for this enum value
    Dim fullName As String = enumType.FullName + "." + name

    ' See if we have looked it up earlier
    Dim enumDescription As String = Nothing
    If _Descriptions.TryGetValue(fullName, enumDescription) Then
      ' Yes we have - return previous value
      Return enumDescription
    End If

    ' Find the value of the Description attribute on this enum value
    Dim members As MemberInfo() = enumType.GetMember(name)
    If members IsNot Nothing AndAlso members.Length > 0 Then
      Dim descriptions() As Object = members(0).GetCustomAttributes(GetType(DescriptionAttribute), False)
      If descriptions IsNot Nothing AndAlso descriptions.Length > 0 Then
        ' Set name to description found
        name = DirectCast(descriptions(0), DescriptionAttribute).Description
      End If
    End If

    ' Save the name in the dictionary:
    _Descriptions.Add(fullName, name)

    ' Return the name
    Return name
  End Function
End Module

เนื่องจากการค้นหาแอตทริบิวต์คำอธิบายโดยใช้Reflectionช้าการค้นหาจึงถูกแคชในส่วนตัวDictionaryด้วยซึ่งจะถูกเติมตามความต้องการ

(ขออภัยสำหรับโซลูชัน VB.NET - ควรจะค่อนข้างตรงไปตรงมาเพื่อแปลเป็น C # และ C # ของฉันเป็นสนิมในวิชาใหม่เช่นส่วนขยาย)

สรุปการทำความสะอาดของคำแนะนำข้างต้นพร้อมตัวอย่าง:

namespace EnumExtensions {

using System;
using System.Reflection;

public class TextAttribute : Attribute {
   public string Text;
   public TextAttribute( string text ) {
      Text = text;
   }//ctor
}// class TextAttribute

public static class EnumExtender {

public static string ToText( this Enum enumeration ) {

   MemberInfo[] memberInfo = enumeration.GetType().GetMember( enumeration.ToString() );

   if ( memberInfo != null && memberInfo.Length > 0 ) {

      object[] attributes = memberInfo[ 0 ].GetCustomAttributes( typeof(TextAttribute),  false );

      if ( attributes != null && attributes.Length > 0 ) {
         return ( (TextAttribute)attributes[ 0 ] ).Text;
      }

   }//if

   return enumeration.ToString();

}//ToText

}//class EnumExtender

}//namespace

การใช้:

using System;
using EnumExtensions;

class Program {

public enum Appearance {

  [Text( "left-handed" ) ]
  Left,

  [Text( "right-handed" ) ]
  Right,

}//enum

static void Main( string[] args ) {

   var appearance = Appearance.Left;
   Console.WriteLine( appearance.ToText() );

}//Main

}//class

ใช้Enum.GetName

จากลิงค์ด้านบน ...

using System;

public class GetNameTest {
    enum Colors { Red, Green, Blue, Yellow };
    enum Styles { Plaid, Striped, Tartan, Corduroy };

    public static void Main() {

        Console.WriteLine("The 4th value of the Colors Enum is {0}", Enum.GetName(typeof(Colors), 3));
        Console.WriteLine("The 4th value of the Styles Enum is {0}", Enum.GetName(typeof(Styles), 3));
    }
}
// The example displays the following output:
//       The 4th value of the Colors Enum is Yellow
//       The 4th value of the Styles Enum is Corduroy

ตามเอกสารนี้: https://docs.microsoft.com/pt-br/dotnet/api/system.enum.tostring?view=netframework-4.8

เป็นไปได้ที่จะแปลงตัวแจงนับเป็นสตริงโดยใช้รูปแบบดังนี้:

public enum Example
{
    Example1,
    Example2
}

Console.WriteLine(Example.Example1.ToString("g"));

//Outputs: "Example1"

คุณสามารถดูรูปแบบที่เป็นไปได้ทั้งหมดในลิงค์นี้: https://docs.microsoft.com/pt-br/dotnet/api/system.string?view=netframework-4.8

นี่คือการอัปเดตโค้ดของ Ray Booysen ที่ใช้เมธอด GetCustomAttributes ทั่วไปและ LINQ เพื่อทำให้สิ่งต่าง ๆ เป็นระเบียบมากขึ้น

    /// <summary>
    /// Gets the value of the <see cref="T:System.ComponentModel.DescriptionAttribute"/> on an struct, including enums.  
    /// </summary>
    /// <typeparam name="T">The type of the struct.</typeparam>
    /// <param name="enumerationValue">A value of type <see cref="T:System.Enum"/></param>
    /// <returns>If the struct has a Description attribute, this method returns the description.  Otherwise it just calls ToString() on the struct.</returns>
    /// <remarks>Based on http://stackoverflow.com/questions/479410/enum-tostring/479417#479417, but useful for any struct.</remarks>
    public static string GetDescription<T>(this T enumerationValue) where T : struct
    {
        return enumerationValue.GetType().GetMember(enumerationValue.ToString())
                .SelectMany(mi => mi.GetCustomAttributes<DescriptionAttribute>(false),
                    (mi, ca) => ca.Description)
                .FirstOrDefault() ?? enumerationValue.ToString();
    }   

สรุปได้ดียิ่งขึ้น:

using System;
using System.Reflection;

public class TextAttribute : Attribute
{
    public string Text;
    public TextAttribute(string text)
    {
        Text = text;
    }
}  

public static class EnumExtender
{
    public static string ToText(this Enum enumeration)
    {
        var memberInfo = enumeration.GetType().GetMember(enumeration.ToString());
        if (memberInfo.Length <= 0) return enumeration.ToString();

        var attributes = memberInfo[0].GetCustomAttributes(typeof(TextAttribute), false);
        return attributes.Length > 0 ? ((TextAttribute)attributes[0]).Text : enumeration.ToString();
    }
}

การใช้งานเช่นเดียวกับขีดเส้นใต้อธิบาย

สำหรับธง enum ได้แก่

    public static string Description(this Enum value)
    {
        Type type = value.GetType();

        List<string> res = new List<string>();
        var arrValue = value.ToString().Split(',').Select(v=>v.Trim());
        foreach (string strValue in arrValue)
        {
            MemberInfo[] memberInfo = type.GetMember(strValue);
            if (memberInfo != null && memberInfo.Length > 0)
            {
                object[] attrs = memberInfo[0].GetCustomAttributes(typeof(DescriptionAttribute), false);

                if (attrs != null && attrs.Length > 0 && attrs.Where(t => t.GetType() == typeof(DescriptionAttribute)).FirstOrDefault() != null)
                {
                    res.Add(((DescriptionAttribute)attrs.Where(t => t.GetType() == typeof(DescriptionAttribute)).FirstOrDefault()).Description);
                }
                else
                    res.Add(strValue);
            }
            else
                res.Add(strValue);
        }

        return res.Aggregate((s,v)=>s+", "+v);
    }

ในกรณีที่คุณต้องการเพิ่มช่องว่างระหว่างคำมันง่ายเหมือน

string res = Regex.Replace(PublishStatusses.NotCompleted, "[A-Z]", " $0").Trim();

ฉันใช้คลาสทั่วไปเพื่อเก็บคู่ enum / description และคลาสตัวช่วยเหลือแบบซ้อนเพื่อรับคำอธิบาย

enum :

enum Status { Success, Fail, Pending }

ชั้นสามัญ:

หมายเหตุ:เนื่องจากคลาสทั่วไปไม่สามารถถูก จำกัด โดยenumฉันถูกบังคับโดยstructแทนและตรวจสอบenumใน Constructor

public class EnumX<T> where T : struct
{
    public T Code { get; set; }
    public string Description { get; set; }

    public EnumX(T code, string desc)
    {
        if (!typeof(T).IsEnum) throw new NotImplementedException();

        Code = code;
        Description = desc;
    }

    public class Helper
    {
        private List<EnumX<T>> codes;

        public Helper(List<EnumX<T>> codes)
        {
            this.codes = codes;
        }

        public string GetDescription(T code)
        {
            EnumX<T> e = codes.Where(c => c.Code.Equals(code)).FirstOrDefault();
            return e is null ? "Undefined" : e.Description;
        }
    }
}

การใช้งาน:

EnumX<Status>.Helper StatusCodes = new EnumX<Status>.Helper(new List<EnumX<Status>>()
        {
            new EnumX<Status>(Status.Success,"Operation was successful"),
            new EnumX<Status>(Status.Fail,"Operation failed"),
            new EnumX<Status>(Status.Pending,"Operation not complete. Please wait...")
        });

        Console.WriteLine(StatusCodes.GetDescription(Status.Pending));

ฉันคิดว่าวิธีที่ดีที่สุด (และง่ายที่สุด) ในการแก้ปัญหาของคุณคือการเขียน Extension-Method สำหรับ enum ของคุณ:

public static string GetUserFriendlyString(this PublishStatusses status)
    {

    }

หากคุณต้องการบางสิ่งบางอย่างที่ปรับแต่งได้อย่างสมบูรณ์ลองโซลูชันของฉันที่นี่:

http://www.kevinwilliampang.com/post/Mapping-Enums-To-Strings-and-Strings-to-Enums-in-NET.aspx

โดยทั่วไปโพสต์จะสรุปวิธีแนบแอตทริบิวต์คำอธิบายกับแต่ละ enums ของคุณและให้วิธีการทั่วไปในการแมปจาก enum ไปยังคำอธิบาย