在C#中将字符串转换为枚举

c# string enums

539966 观看

22回复

10519 作者的声誉

在C#中将字符串转换为枚举值的最佳方法是什么?

我有一个包含枚举值的HTML选择标记。发布页面时,我想获取值(将以字符串的形式)并将其转换为枚举值。

在一个理想的世界里,我可以这样做:

StatusEnum MyStatus = StatusEnum.Parse("Active");

但那不是有效的代码。

作者: Ben Mills 的来源 发布者: 2008 年 8 月 19 日

回应 22


82

3165 作者的声誉

你正在寻找Enum.Parse

SomeEnum enum = (SomeEnum)Enum.Parse(typeof(SomeEnum), "EnumValue");
作者: DavidWhitney 发布者: 2008 年 8 月 19 日

1191

96395 作者的声誉

决定

在.NET Core和.NET> 4中,有一个通用的解析方法

Enum.TryParse("Active", out StatusEnum myStatus);

这还包括C#7的新内联out变量,因此这将执行try-parse,转换为显式枚举类型并初始化+填充myStatus变量。

如果您可以访问C#7和最新的.NET,这是最好的方法。

原始答案

在.NET中它相当丑陋(直到4或以上):

StatusEnum MyStatus = (StatusEnum) Enum.Parse(typeof(StatusEnum), "Active", true);

我倾向于简化这个:

public static T ParseEnum<T>(string value)
{
    return (T) Enum.Parse(typeof(T), value, true);
}

然后我可以这样做:

StatusEnum MyStatus = EnumUtil.ParseEnum<StatusEnum>("Active");

评论中建议的一个选项是添加一个扩展,这很简单:

public static T ToEnum<T>(this string value)
{
    return (T) Enum.Parse(typeof(T), value, true);
}

StatusEnum MyStatus = "Active".ToEnum<StatusEnum>();

最后,如果无法解析字符串,您可能希望使用默认枚举:

public static T ToEnum<T>(this string value, T defaultValue) 
{
    if (string.IsNullOrEmpty(value))
    {
        return defaultValue;
    }

    T result;
    return Enum.TryParse<T>(value, true, out result) ? result : defaultValue;
}

这使得这个电话:

StatusEnum MyStatus = "Active".ToEnum(StatusEnum.None);

但是,我会小心地将这样的扩展方法添加到string(没有命名空间控制)它将出现在所有实例上,string无论它们是否包含枚举(因此1234.ToString().ToEnum(StatusEnum.None)有效但无意义)。通常最好避免使用仅在非常特定的上下文中应用的额外方法来混淆Microsoft的核心类,除非您的整个开发团队非常了解这些扩展的作用。

作者: Keith 发布者: 2008 年 8 月 19 日

15

29587 作者的声誉

Enum.Parse是你的朋友:

StatusEnum MyStatus = (StatusEnum)Enum.Parse(typeof(StatusEnum), "Active");
作者: tags2k 发布者: 2008 年 8 月 19 日

16

22337 作者的声誉

object Enum.Parse(System.Type enumType, string value, bool ignoreCase);

所以,如果你有一个名为heart的枚举,它将如下所示:

   enum Mood
   {
      Angry,
      Happy,
      Sad
   } 

   // ...
   Mood m = (Mood) Enum.Parse(typeof(Mood), "Happy", true);
   Console.WriteLine("My mood is: {0}", m.ToString());
作者: brendan 发布者: 2008 年 8 月 19 日

7

85862 作者的声誉

// str.ToEnum<EnumType>()
T static ToEnum<T>(this string str) 
{ 
    return (T) Enum.Parse(typeof(T), str);
}
作者: Mark Cidade 发布者: 2008 年 8 月 19 日

174

9711 作者的声誉

请注意,Enum.Parse()的性能很糟糕,因为它是通过反射实现的。(对于Enum.ToString也是如此,这是另一种方式。)

如果您需要在性能敏感的代码中将字符串转换为枚举,最好的办法是Dictionary<String,YourEnum>在启动时创建并使用它来进行转换。

作者: McKenzieG1 发布者: 2008 年 9 月 2 日

9

1779 作者的声誉

我们无法假设完全有效的输入,并且随着@ Keith的回答变化:

public static TEnum ParseEnum<TEnum>(string value) where TEnum : struct
{
    TEnum tmp; 
    if (!Enum.TryParse<TEnum>(value, true, out tmp))
    {
        tmp = new TEnum();
    }
    return tmp;
}
作者: gap 发布者: 2012 年 8 月 30 日

5

51 作者的声誉

将字符串解析为TEnum,不使用try / catch,也不使用.NET 4.5中的TryParse()方法

/// <summary>
/// Parses string to TEnum without try/catch and .NET 4.5 TryParse()
/// </summary>
public static bool TryParseToEnum<TEnum>(string probablyEnumAsString_, out TEnum enumValue_) where TEnum : struct
{
    enumValue_ = (TEnum)Enum.GetValues(typeof(TEnum)).GetValue(0);
    if(!Enum.IsDefined(typeof(TEnum), probablyEnumAsString_))
        return false;

    enumValue_ = (TEnum) Enum.Parse(typeof(TEnum), probablyEnumAsString_);
    return true;
}
作者: jite.gs 发布者: 2013 年 10 月 17 日

282

10949 作者的声誉

使用Enum.TryParse<T>(String, T)(≥.NET4.0):

StatusEnum myStatus;
Enum.TryParse("Active", out myStatus);

使用C#7.0的参数类型内联可以进一步简化:

Enum.TryParse("Active", out StatusEnum myStatus);
作者: Erwin Mayer 发布者: 2013 年 12 月 5 日

26

2389 作者的声誉

您现在可以使用扩展方法

public static T ToEnum<T>(this string value, bool ignoreCase = true)
{
    return (T) Enum.Parse(typeof (T), value, ignoreCase);
}

您可以通过以下代码调用它们(这里FilterType是一个枚举类型):

FilterType filterType = type.ToEnum<FilterType>();
作者: Foyzul Karim 发布者: 2014 年 2 月 10 日

12

434 作者的声誉

您可以使用默认值扩展接受的答案以避免例外:

public static T ParseEnum<T>(string value, T defaultValue) where T : struct
{
    try
    {
        T enumValue;
        if (!Enum.TryParse(value, true, out enumValue))
        {
            return defaultValue;
        }
        return enumValue;
    }
    catch (Exception)
    {
        return defaultValue;
    }
}

然后你称之为:

StatusEnum MyStatus = EnumUtil.ParseEnum("Active", StatusEnum.None);
作者: Nelly 发布者: 2014 年 12 月 9 日

1

740 作者的声誉

I used class (strongly-typed version of Enum with parsing and performance improvements). I found it on GitHub, and it should work for .NET 3.5 too. It has some memory overhead since it buffers a dictionary.

StatusEnum MyStatus = Enum<StatusEnum>.Parse("Active");

The blogpost is Enums – Better syntax, improved performance and TryParse in NET 3.5.

And code: https://github.com/damieng/DamienGKit/blob/master/CSharp/DamienG.Library/System/EnumT.cs

作者: Patrik Lindström 发布者: 2015 年 7 月 1 日

1

741 作者的声誉

public static T ParseEnum<T>(string value)            //function declaration  
{
    return (T) Enum.Parse(typeof(T), value);
}

Importance imp = EnumUtil.ParseEnum<Importance>("Active");   //function call

====================A Complete Program====================

using System;

class Program
{
    enum PetType
    {
    None,
    Cat = 1,
    Dog = 2
    }

    static void Main()
    {

    // Possible user input:
    string value = "Dog";

    // Try to convert the string to an enum:
    PetType pet = (PetType)Enum.Parse(typeof(PetType), value);

    // See if the conversion succeeded:
    if (pet == PetType.Dog)
    {
        Console.WriteLine("Equals dog.");
    }
    }
}
-------------
Output

Equals dog.
作者: Rae Lee 发布者: 2015 年 8 月 18 日

2

574 作者的声誉

我喜欢扩展方法解决方案..

namespace System
{
    public static class StringExtensions
    {

        public static bool TryParseAsEnum<T>(this string value, out T output) where T : struct
        {
            T result;

            var isEnum = Enum.TryParse(value, out result);

            output = isEnum ? result : default(T);

            return isEnum;
        }
    }
}

Here below my implementation with tests.

using static Microsoft.VisualStudio.TestTools.UnitTesting.Assert;
using static System.Console;

private enum Countries
    {
        NorthAmerica,
        Europe,
        Rusia,
        Brasil,
        China,
        Asia,
        Australia
    }

   [TestMethod]
        public void StringExtensions_On_TryParseAsEnum()
        {
            var countryName = "Rusia";

            Countries country;
            var isCountry = countryName.TryParseAsEnum(out country);

            WriteLine(country);

            IsTrue(isCountry);
            AreEqual(Countries.Rusia, country);

            countryName = "Don't exist";

            isCountry = countryName.TryParseAsEnum(out country);

            WriteLine(country);

            IsFalse(isCountry);
            AreEqual(Countries.NorthAmerica, country); // the 1rst one in the enumeration
        }
作者: alhpe 发布者: 2015 年 10 月 1 日

16

3403 作者的声誉

谨防:

enum Example
{
    One = 1,
    Two = 2,
    Three = 3
}

Enum.(Try)Parse() 接受多个逗号分隔的参数,并将它们与二进制'或'组合|。你不能禁用它,在我看来你几乎从不想要它。

var x = Enum.Parse("One,Two"); // x is now Three

即使Three没有定义,x仍然会得到int值3。更糟糕的是:Enum.Parse()可以为你提供一个甚至没有为枚举定义的值!

我不想让用户自愿或不情愿地触发这种行为。

另外,正如其他人所提到的,对于大型枚举,性能不太理想,即可能值的数量是线性的。

我建议如下:

    public static bool TryParse<T>(string value, out T result)
        where T : struct
    {
        var cacheKey = "Enum_" + typeof(T).FullName;

        // [Use MemoryCache to retrieve or create&store a dictionary for this enum, permanently or temporarily.
        // [Implementation off-topic.]
        var enumDictionary = CacheHelper.GetCacheItem(cacheKey, CreateEnumDictionary<T>, EnumCacheExpiration);

        return enumDictionary.TryGetValue(value.Trim(), out result);
    }

    private static Dictionary<string, T> CreateEnumDictionary<T>()
    {
        return Enum.GetValues(typeof(T))
            .Cast<T>()
            .ToDictionary(value => value.ToString(), value => value, StringComparer.OrdinalIgnoreCase);
    }
作者: Timo 发布者: 2015 年 12 月 14 日

1

841 作者的声誉

For performance this might help:

    private static Dictionary<Type, Dictionary<string, object>> dicEnum = new Dictionary<Type, Dictionary<string, object>>();
    public static T ToEnum<T>(this string value, T defaultValue)
    {
        var t = typeof(T);
        Dictionary<string, object> dic;
        if (!dicEnum.ContainsKey(t))
        {
            dic = new Dictionary<string, object>();
            dicEnum.Add(t, dic);
            foreach (var en in Enum.GetValues(t))
                dic.Add(en.ToString(), en);
        }
        else
            dic = dicEnum[t];
        if (!dic.ContainsKey(value))
            return defaultValue;
        else
            return (T)dic[value];
    }
作者: Koray 发布者: 2016 年 6 月 22 日

1

3427 作者的声誉

I found that here the case with enum values that have EnumMember value was not considered. So here we go:

using System.Runtime.Serialization;

public static TEnum ToEnum<TEnum>(this string value, TEnum defaultValue) where TEnum : struct
{
    if (string.IsNullOrEmpty(value))
    {
        return defaultValue;
    }

    TEnum result;
    var enumType = typeof(TEnum);
    foreach (var enumName in Enum.GetNames(enumType))
    {
        var fieldInfo = enumType.GetField(enumName);
        var enumMemberAttribute = ((EnumMemberAttribute[]) fieldInfo.GetCustomAttributes(typeof(EnumMemberAttribute), true)).FirstOrDefault();
        if (enumMemberAttribute?.Value == value)
        {
            return Enum.TryParse(enumName, true, out result) ? result : defaultValue;
        }
    }

    return Enum.TryParse(value, true, out result) ? result : defaultValue;
}

And example of that enum:

public enum OracleInstanceStatus
{
    Unknown = -1,
    Started = 1,
    Mounted = 2,
    Open = 3,
    [EnumMember(Value = "OPEN MIGRATE")]
    OpenMigrate = 4
}
作者: isxaker 发布者: 2016 年 10 月 4 日

3

1274 作者的声誉

使用TryParse的超级简单代码:

var value = "Active";

StatusEnum status;
if (!Enum.TryParse<StatusEnum>(value, out status))
    status = StatusEnum.Unknown;
作者: Brian Rice 发布者: 2016 年 11 月 25 日

1

81 作者的声誉

您必须使用Enum.Parse从Enum获取对象值,之后您必须将对象值更改为特定的枚举值。可以使用Convert.ChangeType来转换为枚举值。请查看以下代码段

public T ConvertStringValueToEnum<T>(string valueToParse){
    return Convert.ChangeType(Enum.Parse(typeof(T), valueToParse, true), typeof(T));
}
作者: Bartosz Gawron 发布者: 2017 年 2 月 8 日

1

644 作者的声誉

试试这个样本:

 public static T GetEnum<T>(string model)
    {
        var newModel = GetStringForEnum(model);

        if (!Enum.IsDefined(typeof(T), newModel))
        {
            return (T)Enum.Parse(typeof(T), "None", true);
        }

        return (T)Enum.Parse(typeof(T), newModel.Result, true);
    }

    private static Task<string> GetStringForEnum(string model)
    {
        return Task.Run(() =>
        {
            Regex rgx = new Regex("[^a-zA-Z0-9 -]");
            var nonAlphanumericData = rgx.Matches(model);
            if (nonAlphanumericData.Count < 1)
            {
                return model;
            }
            foreach (var item in nonAlphanumericData)
            {
                model = model.Replace((string)item, "");
            }
            return model;
        });
    }

在此示例中,您可以发送每个字符串,并设置您的Enum。如果您Enum拥有所需的数据,请将其作为您的Enum类型返回。

作者: AmirReza-Farahlagha 发布者: 2018 年 10 月 1 日

0

300 作者的声誉

        <Extension()>
    Public Function ToEnum(Of TEnum)(ByVal value As String, ByVal defaultValue As TEnum) As TEnum
        If String.IsNullOrEmpty(value) Then
            Return defaultValue
        End If

        Return [Enum].Parse(GetType(TEnum), value, True)
    End Function
作者: AHMED RABEE 发布者: 2019 年 5 月 22 日

0

300 作者的声誉

public TEnum ToEnum<TEnum>(this string value, TEnum defaultValue){
if (string.IsNullOrEmpty(value))
    return defaultValue;

return Enum.Parse(typeof(TEnum), value, true);}
作者: AHMED RABEE 发布者: 2019 年 5 月 22 日
32x32