Преобразование строки в перечисление в C#
https://stackoverflow.com/questions/16100
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianВопрос
Как лучше всего преобразовать строку в значение перечисления в C#?
У меня есть тег выбора HTML, содержащий значения перечисления.Когда страница публикуется, я хочу получить значение (которое будет в виде строки) и преобразовать его в значение перечисления.
В идеальном мире я мог бы сделать что-то вроде этого:
StatusEnum MyStatus = StatusEnum.Parse("Active");
но это недействительный код.
Решение
В .NET Core и .NET >4 существует общий метод анализа:
Enum.TryParse("Active", out StatusEnum myStatus);
Сюда также входит новая встроенная функция C#7. out переменные, поэтому выполняется синтаксический анализ, преобразование в явный тип перечисления и инициализация + заполнение 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 дополнительными методами, которые применяются только в очень специфических контекстах, если вся ваша команда разработчиков не очень хорошо понимает, что делают эти расширения.
Другие советы
Использовать Enum.TryParse<T>(String, T) (≥ .NET 4.0):
StatusEnum myStatus;
Enum.TryParse("Active", out myStatus);
Его можно еще больше упростить с помощью C# 7.0. тип параметра, встраивание:
Enum.TryParse("Active", out StatusEnum myStatus);
Обратите внимание, что производительность Enum.Parse() ужасна, поскольку она реализована посредством отражения.(То же самое относится и к Enum.ToString, который работает в другую сторону.)
Если вам нужно преобразовать строки в Enums в коде, чувствительном к производительности, лучше всего создать Dictionary<String,YourEnum> при запуске и используйте это для преобразований.
Вы ищете Enum.Parse.
SomeEnum enum = (SomeEnum)Enum.Parse(typeof(SomeEnum), "EnumValue");
Вы можете использовать методы расширения сейчас:
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>();
object Enum.Parse(System.Type enumType, string value, bool ignoreCase);
Итак, если бы у вас было перечисление с именем «mood», оно выглядело бы так:
enum Mood
{
Angry,
Happy,
Sad
}
// ...
Mood m = (Mood) Enum.Parse(typeof(Mood), "Happy", true);
Console.WriteLine("My mood is: {0}", m.ToString());ОСТЕРЕГАТЬСЯ:
enum Example
{
One = 1,
Two = 2,
Three = 3
}
Enum.(Try)Parse() принимает несколько аргументов, разделенных запятыми, и объединяет их с помощью двоичного «или» |.Вы не можете отключить это, и, по моему мнению, оно вам почти никогда не понадобится.
var x = Enum.Parse("One,Two"); // x is now Three
Даже если Three не было определено, x все равно получит целое значение 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);
}
Enum.Parse твой друг:
StatusEnum MyStatus = (StatusEnum)Enum.Parse(typeof(StatusEnum), "Active");
Вы можете расширить принятый ответ значением по умолчанию, чтобы избежать исключений:
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);
Мы не могли предположить, что введенные данные абсолютно верны, и использовали этот вариант ответа @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;
}
// str.ToEnum<EnumType>()
T static ToEnum<T>(this string str)
{
return (T) Enum.Parse(typeof(T), str);
}
Анализирует строку в TEnum без try/catch и без метода TryParse() из .NET 4.5.
/// <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;
}
Супер простой код с использованием TryParse:
var value = "Active";
StatusEnum status;
if (!Enum.TryParse<StatusEnum>(value, out status))
status = StatusEnum.Unknown;
Мне нравится решение метода расширения..
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;
}
}
}
Ниже моя реализация с тестами.
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
}
public static T ParseEnum<T>(string value) //function declaration
{
return (T) Enum.Parse(typeof(T), value);
}
Importance imp = EnumUtil.ParseEnum<Importance>("Active"); //function call
===================Полная программа===================
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.
Я использовал класс (строго типизированная версия Enum с улучшениями синтаксического анализа и производительности).Я нашел его на GitHub, и он должен работать и для .NET 3.5.У него есть некоторые затраты памяти, поскольку он буферизует словарь.
StatusEnum MyStatus = Enum<StatusEnum>.Parse("Active");
Сообщение в блоге Перечисления: улучшенный синтаксис, улучшенная производительность и TryParse в NET 3.5..
И код:https://github.com/damieng/DamienGKit/blob/master/CSharp/DamienG.Library/System/EnumT.cs
Для производительности это может помочь:
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];
}
Я обнаружил, что здесь не рассматривается случай со значениями перечисления, имеющими значение EnumMember.Итак, поехали:
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;
}
И пример этого перечисления:
public enum OracleInstanceStatus
{
Unknown = -1,
Started = 1,
Mounted = 2,
Open = 3,
[EnumMember(Value = "OPEN MIGRATE")]
OpenMigrate = 4
}
Вам нужно использовать Enum.Parse, чтобы получить значение объекта из Enum, после этого вам нужно изменить значение объекта на определенное значение перечисления.Приведение к значению перечисления можно выполнить с помощью Convert.ChangeType.Пожалуйста, посмотрите следующий фрагмент кода
public T ConvertStringValueToEnum<T>(string valueToParse){
return Convert.ChangeType(Enum.Parse(typeof(T), valueToParse, true), typeof(T));
}
Попробуйте этот образец:
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 тип.
<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
public TEnum ToEnum<TEnum>(this string value, TEnum defaultValue){
if (string.IsNullOrEmpty(value))
return defaultValue;
return Enum.Parse(typeof(TEnum), value, true);}
