質問
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");
コメントで提案されているオプションの 1 つは、拡張機能を追加することです。これは非常に簡単です。
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
enum を保持しているかどうか (つまり 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 にも同じことが当てはまります。)
パフォーマンス重視のコードで文字列を列挙型に変換する必要がある場合、最善の策は、 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()
カンマで区切られた複数の引数を受け入れ、それらをバイナリの「or」で結合します。 |
. 。これを無効にすることはできませんし、私の意見では、無効にする必要はほとんどありません。
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);
}
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);
}
.NET 4.5 の try/catch および TryParse() メソッドを使用せずに、文字列を TEnum に解析します。
/// <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.
私は class (解析とパフォーマンスが向上した Enum の厳密に型指定されたバージョン) を使用しました。GitHub で見つけたもので、.NET 3.5 でも動作するはずです。辞書をバッファリングするため、ある程度のメモリ オーバーヘッドが発生します。
StatusEnum MyStatus = Enum<StatusEnum>.Parse("Active");
ブログ投稿は Enums – NET 3.5 の構文の改善、パフォーマンスの向上、TryParse.
そしてコード: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 値を持つ enum 値のケースが考慮されていないことがわかりました。それでは、次のようにしてみましょう。
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 からオブジェクト値を取得する必要があります。その後、オブジェクト値を特定の enum 値に変更する必要があります。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);}