私はEnum.Parse
の概念を拡張する機能を構築しています。
だから私は次のように書いた:
public static T GetEnumFromString<T>(string value, T defaultValue) where T : Enum
{
if (string.IsNullOrEmpty(value)) return defaultValue;
foreach (T item in Enum.GetValues(typeof(T)))
{
if (item.ToString().ToLower().Equals(value.Trim().ToLower())) return item;
}
return defaultValue;
}
Error Constraintが特別なクラスSystem.Enum
になることはできません。
十分に公平ですが、Generic Enumを許可するための回避策はありますか、それともParse
関数を模倣して属性として型を渡す必要があるでしょう。
_ edit _ 以下のすべての提案は大歓迎です、ありがとう。
解決しました(大文字と小文字を区別しないためにループを終了しました - XMLを解析するときにこれを使用しています)
public static class EnumUtils
{
public static T ParseEnum<T>(string value, T defaultValue) where T : struct, IConvertible
{
if (!typeof(T).IsEnum) throw new ArgumentException("T must be an enumerated type");
if (string.IsNullOrEmpty(value)) return defaultValue;
foreach (T item in Enum.GetValues(typeof(T)))
{
if (item.ToString().ToLower().Equals(value.Trim().ToLower())) return item;
}
return defaultValue;
}
}
編集: (2015年2月16日)Julien Lebosquainが最近 コンパイラによるMSILまたはF#での型保証された一般的な解決策 を投稿しました。解決策がページの上にさらに上がったら私はこの編集を削除します。
Enum
TypeはIConvertible
インターフェースを実装しているので、より良い実装は次のようになります。
public T GetEnumFromString<T>(string value) where T : struct, IConvertible
{
if (!typeof(T).IsEnum)
{
throw new ArgumentException("T must be an enumerated type");
}
//...
}
これはまだIConvertible
を実装している値型の受け渡しを許可します。しかしその可能性は稀です。
次のスニペット( からのdotnetサンプル )は、それが使用することを示しています。
public static Dictionary<int, string> EnumNamedValues<T>() where T : System.Enum
{
var result = new Dictionary<int, string>();
var values = Enum.GetValues(typeof(T));
foreach (int item in values)
result.Add(item, Enum.GetName(typeof(T), item));
return result;
}
必ずC#プロジェクトの言語バージョンをバージョン7.3に設定してください。
以下の元の答え:
私は試合に遅刻しました、しかし、私はそれがどうやってされることができるか見るために挑戦としてそれを取りました。 C#(またはVB.NET、F#の場合はスクロールダウン)では不可能ですが、MSILでは可能です。私はこれを書いた……。
// license: http://www.Apache.org/licenses/LICENSE-2.0.html
.Assembly MyThing{}
.class public abstract sealed MyThing.Thing
extends [mscorlib]System.Object
{
.method public static !!T GetEnumFromString<valuetype .ctor ([mscorlib]System.Enum) T>(string strValue,
!!T defaultValue) cil managed
{
.maxstack 2
.locals init ([0] !!T temp,
[1] !!T return_value,
[2] class [mscorlib]System.Collections.IEnumerator enumerator,
[3] class [mscorlib]System.IDisposable disposer)
// if(string.IsNullOrEmpty(strValue)) return defaultValue;
ldarg strValue
call bool [mscorlib]System.String::IsNullOrEmpty(string)
brfalse.s HASVALUE
br RETURNDEF // return default it empty
// foreach (T item in Enum.GetValues(typeof(T)))
HASVALUE:
// Enum.GetValues.GetEnumerator()
ldtoken !!T
call class [mscorlib]System.Type [mscorlib]System.Type::GetTypeFromHandle(valuetype [mscorlib]System.RuntimeTypeHandle)
call class [mscorlib]System.Array [mscorlib]System.Enum::GetValues(class [mscorlib]System.Type)
callvirt instance class [mscorlib]System.Collections.IEnumerator [mscorlib]System.Array::GetEnumerator()
stloc enumerator
.try
{
CONDITION:
ldloc enumerator
callvirt instance bool [mscorlib]System.Collections.IEnumerator::MoveNext()
brfalse.s LEAVE
STATEMENTS:
// T item = (T)Enumerator.Current
ldloc enumerator
callvirt instance object [mscorlib]System.Collections.IEnumerator::get_Current()
unbox.any !!T
stloc temp
ldloca.s temp
constrained. !!T
// if (item.ToString().ToLower().Equals(value.Trim().ToLower())) return item;
callvirt instance string [mscorlib]System.Object::ToString()
callvirt instance string [mscorlib]System.String::ToLower()
ldarg strValue
callvirt instance string [mscorlib]System.String::Trim()
callvirt instance string [mscorlib]System.String::ToLower()
callvirt instance bool [mscorlib]System.String::Equals(string)
brfalse.s CONDITION
ldloc temp
stloc return_value
leave.s RETURNVAL
LEAVE:
leave.s RETURNDEF
}
finally
{
// ArrayList's Enumerator may or may not inherit from IDisposable
ldloc enumerator
isinst [mscorlib]System.IDisposable
stloc.s disposer
ldloc.s disposer
ldnull
ceq
brtrue.s LEAVEFINALLY
ldloc.s disposer
callvirt instance void [mscorlib]System.IDisposable::Dispose()
LEAVEFINALLY:
endfinally
}
RETURNDEF:
ldarg defaultValue
stloc return_value
RETURNVAL:
ldloc return_value
ret
}
}
これは= C/Cが有効であればのようになる)関数を生成します。
T GetEnumFromString<T>(string valueString, T defaultValue) where T : Enum
それから次のC#コードで:
using MyThing;
// stuff...
private enum MyEnum { Yes, No, Okay }
static void Main(string[] args)
{
Thing.GetEnumFromString("No", MyEnum.Yes); // returns MyEnum.No
Thing.GetEnumFromString("Invalid", MyEnum.Okay); // returns MyEnum.Okay
Thing.GetEnumFromString("AnotherInvalid", 0); // compiler error, not an Enum
}
残念ながら、これはあなたのコードのこの部分をC#の代わりにMSILで書かなければならないことを意味します、あなたがSystem.Enum
によってあなたがこのメソッドを制約することができるということだけのさらなる利点があります。それはまた別のアセンブリにコンパイルされるので、それはまた残念なことです。しかし、それはあなたがそのように展開しなければならないという意味ではありません。
次のように行.Assembly MyThing{}
を削除し、ilasmを呼び出すことによって。
ilasm.exe /DLL /OUTPUT=MyThing.netmodule
あなたはアセンブリの代わりにネットモジュールを手に入れます。
残念ながら、VS2010(そして以前のバージョンでは明らかに)はネットモジュール参照の追加をサポートしていません。つまり、デバッグ時には2つの別々のアセンブリに入れておく必要があります。アセンブリの一部としてそれらを追加できる唯一の方法は、/addmodule:{files}
コマンドライン引数を使用してcsc.exeを自分で実行することです。 MSBuildスクリプトでは、{あまりにも苦痛ではありません。もちろん、あなたが勇敢であれば、毎回手動でcscを実行することができます。そして、複数のアセンブリがアクセスする必要があるため、確かに複雑になります。
だから、それは。NETで行うことができます。それは余分な努力の価値がありますか?うーん、まあ、私はあなたにそれを決定させますね。
追加クレジット:enum
に対する一般的な制限は、MSIL:F#以外の少なくとも1つの他の.NET言語でも可能です。
type MyThing =
static member GetEnumFromString<'T when 'T :> Enum> str defaultValue: 'T =
/// protect for null (only required in interop with C#)
let str = if isNull str then String.Empty else str
Enum.GetValues(typedefof<'T>)
|> Seq.cast<_>
|> Seq.tryFind(fun v -> String.Compare(v.ToString(), str.Trim(), true) = 0)
|> function Some x -> x | None -> defaultValue
これは、完全なVisual Studio IDEをサポートするよく知られた言語であるため、保守が簡単ですが、それでも解決策として別のプロジェクトが必要です。しかし、当然のことながら、かなり異なるIL(コードisは非常に異なる)が生成され、他の外部ライブラリと同じようにFSharp.Core
ライブラリに依存します。
これがあなたがそれをどのように使うことができるか(基本的にMSILの解決策と同じです)、そしてそれがそれ以外は同義の構造体で正しく失敗することを示すために:
// works, result is inferred to have type StringComparison
var result = MyThing.GetEnumFromString("OrdinalIgnoreCase", StringComparison.Ordinal);
// type restriction is recognized by C#, this fails at compile time
var result = MyThing.GetEnumFromString("OrdinalIgnoreCase", 42);
C#7.3(Visual Studio 2017≥v15.7以降で利用可能)以降、このコードは完全に有効になりました。
public static TEnum Parse<TEnum>(string value)
where TEnum : struct, Enum { ... }
制約の継承を悪用することで、実際のコンパイラでenum制約を強制することができます。次のコードは、class
とstruct
の両方の制約を同時に指定しています。
public abstract class EnumClassUtils<TClass>
where TClass : class
{
public static TEnum Parse<TEnum>(string value)
where TEnum : struct, TClass
{
return (TEnum) Enum.Parse(typeof(TEnum), value);
}
}
public class EnumUtils : EnumClassUtils<Enum>
{
}
使用法:
EnumUtils.Parse<SomeEnum>("value");
注:これはC#5.0言語仕様で具体的に述べられています。
型パラメータSが型パラメータTに依存する場合、次のようになります。[...] Sが値型制約を持ち、Tが参照型制約を持つことは有効です。事実上、これはTをSystem.Object、System.ValueType、System.Enum、および任意のインターフェイス型に制限します。
編集
質問は Julien Lebosquain によって見事に答えられました。私はまた、ignoreCase
とdefaultValue
を追加しながら、TryParse
、ParseOrDefault
、およびオプションの引数で彼の答えを拡張したいと思います。
public abstract class ConstrainedEnumParser<TClass> where TClass : class
// value type constraint S ("TEnum") depends on reference type T ("TClass") [and on struct]
{
// internal constructor, to prevent this class from being inherited outside this code
internal ConstrainedEnumParser() {}
// Parse using pragmatic/adhoc hard cast:
// - struct + class = enum
// - 'guaranteed' call from derived <System.Enum>-constrained type EnumUtils
public static TEnum Parse<TEnum>(string value, bool ignoreCase = false) where TEnum : struct, TClass
{
return (TEnum)Enum.Parse(typeof(TEnum), value, ignoreCase);
}
public static bool TryParse<TEnum>(string value, out TEnum result, bool ignoreCase = false, TEnum defaultValue = default(TEnum)) where TEnum : struct, TClass // value type constraint S depending on T
{
var didParse = Enum.TryParse(value, ignoreCase, out result);
if (didParse == false)
{
result = defaultValue;
}
return didParse;
}
public static TEnum ParseOrDefault<TEnum>(string value, bool ignoreCase = false, TEnum defaultValue = default(TEnum)) where TEnum : struct, TClass // value type constraint S depending on T
{
if (string.IsNullOrEmpty(value)) { return defaultValue; }
TEnum result;
if (Enum.TryParse(value, ignoreCase, out result)) { return result; }
return defaultValue;
}
}
public class EnumUtils: ConstrainedEnumParser<System.Enum>
// reference type constraint to any <System.Enum>
{
// call to parse will then contain constraint to specific <System.Enum>-class
}
使用例
WeekDay parsedDayOrArgumentException = EnumUtils.Parse<WeekDay>("monday", ignoreCase:true);
WeekDay parsedDayOrDefault;
bool didParse = EnumUtils.TryParse<WeekDay>("clubs", out parsedDayOrDefault, ignoreCase:true);
parsedDayOrDefault = EnumUtils.ParseOrDefault<WeekDay>("friday", ignoreCase:true, defaultValue:WeekDay.Sunday);
古い
Vivekの答え にコメントと '新しい'開発を使用して私の古い改善:
TEnum
を使用しますTryParse
/ ignoreCase
を既存のパラメータで処理します(VS2010/.Net 4で導入)default
value を使用します(VS2005/.Net 2で導入)defaultValue
とignoreCase
には、 オプションの引数 (VS2010/.Net 4で導入)をデフォルト値で使用するその結果:
public static class EnumUtils
{
public static TEnum ParseEnum<TEnum>(this string value,
bool ignoreCase = true,
TEnum defaultValue = default(TEnum))
where TEnum : struct, IComparable, IFormattable, IConvertible
{
if ( ! typeof(TEnum).IsEnum) { throw new ArgumentException("TEnum must be an enumerated type"); }
if (string.IsNullOrEmpty(value)) { return defaultValue; }
TEnum lResult;
if (Enum.TryParse(value, ignoreCase, out lResult)) { return lResult; }
return defaultValue;
}
}
型Tが列挙型であることを確認し、そうでない場合は例外をスローするクラスの静的コンストラクタを定義できます。これはJeffery RichterがC#を介して彼の著書CLRで述べた方法です。
internal sealed class GenericTypeThatRequiresAnEnum<T> {
static GenericTypeThatRequiresAnEnum() {
if (!typeof(T).IsEnum) {
throw new ArgumentException("T must be an enumerated type");
}
}
}
次にparseメソッドで、Enum.Parse(typeof(T)、input、true)を使用して文字列から列挙型に変換できます。最後のtrueパラメータは入力の大文字と小文字の区別を無視するためのものです。
Enum制約を使用したC#7.3のリリース以降、追加のチェックや処理を行わなくてもすぐにサポートされることも考慮に入れる必要があります。
プロジェクトの言語バージョンをC#7.3に変更したことを考えれば、次のコードは完璧に動作するでしょう。
private static T GetEnumFromString<T>(string value, T defaultValue) where T : Enum
{
// Your code goes here...
}
言語バージョンをC#7.3に変更する方法がわからない場合は、次のスクリーンショットを参照してください。
編集1 - 必要なVisual StudioのバージョンとReSharperの検討
Visual Studioが新しい構文を認識するためには、少なくともバージョン15.7が必要です。これはMicrosoftのリリースノートにも記載されています。 Visual Studio 2017 15.7リリースノート を参照してください。この有効な質問を指摘してくれてありがとう@MohamedElshawaf。
Plsはまた、私の場合、このEDITを書いている時点でReSharper 2018.1がC#7.3をまだサポートしていないことにも注意してください。 ReSharperを有効にすると、Enum制約がエラーとして強調表示されます。'System.Array'、 'System.Delegate'、 'System.Enum'、 'System.ValueType'、 'object'を型パラメーター制約として使用できません 。 ReSharperはへの手っ取り早い解決策として提案している。method型のパラメータTの 'Enum'制約を削除する
ただし、Tools - > Options - > ReSharper Ultimate - > Generalで一時的にReSharperをオフにすると、VS 15.7以上およびC#7.3以上を使用するのであれば、構文はまったく問題ないことがわかります。
私はdimarzionistによってサンプルを修正しました。このバージョンはEnumsでのみ動作し、構造体を通過させません。
public static T ParseEnum<T>(string enumString)
where T : struct // enum
{
if (String.IsNullOrEmpty(enumString) || !typeof(T).IsEnum)
throw new Exception("Type given must be an Enum");
try
{
return (T)Enum.Parse(typeof(T), enumString, true);
}
catch (Exception ex)
{
return default(T);
}
}
私は少しコードを改良しようとしました:
public T LoadEnum<T>(string value, T defaultValue = default(T)) where T : struct, IComparable, IFormattable, IConvertible
{
if (Enum.IsDefined(typeof(T), value))
{
return (T)Enum.Parse(typeof(T), value, true);
}
return defaultValue;
}
Enum値に関連付けられたテキストと共にenumを使用する必要がある場合、特定の要件があります。例えば、enumを使ってエラーの種類を指定するときは、エラーの詳細を記述する必要があります。
public static class XmlEnumExtension
{
public static string ReadXmlEnumAttribute(this Enum value)
{
if (value == null) throw new ArgumentNullException("value");
var attribs = (XmlEnumAttribute[]) value.GetType().GetField(value.ToString()).GetCustomAttributes(typeof (XmlEnumAttribute), true);
return attribs.Length > 0 ? attribs[0].Name : value.ToString();
}
public static T ParseXmlEnumAttribute<T>(this string str)
{
foreach (T item in Enum.GetValues(typeof(T)))
{
var attribs = (XmlEnumAttribute[])item.GetType().GetField(item.ToString()).GetCustomAttributes(typeof(XmlEnumAttribute), true);
if(attribs.Length > 0 && attribs[0].Name.Equals(str)) return item;
}
return (T)Enum.Parse(typeof(T), str, true);
}
}
public enum MyEnum
{
[XmlEnum("First Value")]
One,
[XmlEnum("Second Value")]
Two,
Three
}
static void Main()
{
// Parsing from XmlEnum attribute
var str = "Second Value";
var me = str.ParseXmlEnumAttribute<MyEnum>();
System.Console.WriteLine(me.ReadXmlEnumAttribute());
// Parsing without XmlEnum
str = "Three";
me = str.ParseXmlEnumAttribute<MyEnum>();
System.Console.WriteLine(me.ReadXmlEnumAttribute());
me = MyEnum.One;
System.Console.WriteLine(me.ReadXmlEnumAttribute());
}
これが役に立つことを願っています:
public static TValue ParseEnum<TValue>(string value, TValue defaultValue)
where TValue : struct // enum
{
try
{
if (String.IsNullOrEmpty(value))
return defaultValue;
return (TValue)Enum.Parse(typeof (TValue), value);
}
catch(Exception ex)
{
return defaultValue;
}
}
これは私の考えです。答えとMSDNからの組み合わせ
public static TEnum ParseToEnum<TEnum>(this string text) where TEnum : struct, IConvertible, IComparable, IFormattable
{
if (string.IsNullOrEmpty(text) || !typeof(TEnum).IsEnum)
throw new ArgumentException("TEnum must be an Enum type");
try
{
var enumValue = (TEnum)Enum.Parse(typeof(TEnum), text.Trim(), true);
return enumValue;
}
catch (Exception)
{
throw new ArgumentException(string.Format("{0} is not a member of the {1} enumeration.", text, typeof(TEnum).Name));
}
}
興味深いことに、どうやらこれは 他の言語では可能です (Managed C++、IL)。
引用するには:
...両方の制約は実際に有効なILを生成し、別の言語で書かれている場合はC#でも使用できます(これらの制約はマネージC++またはILで宣言できます)。
知るか
既存の回答は、C#<= 7.2以降で当てはまります。しかし、以下を可能にするC#言語 feature request ( corefx feature requestに結び付けられている)があります。
public class MyGeneric<TEnum> where TEnum : System.Enum
{ }
これを書いている時点での機能は、Language Development Meetingsの "In討議中"です。
_編集_
Vivekのソリューションを再利用できるユーティリティクラスにカプセル化しました。あなたはまだあなたの型に "where T:struct、IConvertible"型制約を定義すべきであることに注意してください。
using System;
internal static class EnumEnforcer
{
/// <summary>
/// Makes sure that generic input parameter is of an enumerated type.
/// </summary>
/// <typeparam name="T">Type that should be checked.</typeparam>
/// <param name="typeParameterName">Name of the type parameter.</param>
/// <param name="methodName">Name of the method which accepted the parameter.</param>
public static void EnforceIsEnum<T>(string typeParameterName, string methodName)
where T : struct, IConvertible
{
if (!typeof(T).IsEnum)
{
string message = string.Format(
"Generic parameter {0} in {1} method forces an enumerated type. Make sure your type parameter {0} is an enum.",
typeParameterName,
methodName);
throw new ArgumentException(message);
}
}
/// <summary>
/// Makes sure that generic input parameter is of an enumerated type.
/// </summary>
/// <typeparam name="T">Type that should be checked.</typeparam>
/// <param name="typeParameterName">Name of the type parameter.</param>
/// <param name="methodName">Name of the method which accepted the parameter.</param>
/// <param name="inputParameterName">Name of the input parameter of this page.</param>
public static void EnforceIsEnum<T>(string typeParameterName, string methodName, string inputParameterName)
where T : struct, IConvertible
{
if (!typeof(T).IsEnum)
{
string message = string.Format(
"Generic parameter {0} in {1} method forces an enumerated type. Make sure your input parameter {2} is of correct type.",
typeParameterName,
methodName,
inputParameterName);
throw new ArgumentException(message);
}
}
/// <summary>
/// Makes sure that generic input parameter is of an enumerated type.
/// </summary>
/// <typeparam name="T">Type that should be checked.</typeparam>
/// <param name="exceptionMessage">Message to show in case T is not an enum.</param>
public static void EnforceIsEnum<T>(string exceptionMessage)
where T : struct, IConvertible
{
if (!typeof(T).IsEnum)
{
throw new ArgumentException(exceptionMessage);
}
}
}
私はいつもこれが好きでした(あなたは適切に修正することができます):
public static IEnumerable<TEnum> GetEnumValues()
{
Type enumType = typeof(TEnum);
if(!enumType.IsEnum)
throw new ArgumentException("Type argument must be Enum type");
Array enumValues = Enum.GetValues(enumType);
return enumValues.Cast<TEnum>();
}
前の他の答えで述べたように。これはソースコードでは表現できませんが、実際にはILレベルで実行できます。 @Christopher Currens 答え は、ILがそれをどのように行うかを示しています。
Fody sアドイン ExtraConstraints.Fody これを実現するには、非常に単純な方法で、ビルドツールを使用します。それらのnugetパッケージ(Fody
、ExtraConstraints.Fody
)をプロジェクトに追加し、次のように制約を追加してください(ExtraConstraintsのReadmeからの抜粋)。
public void MethodWithEnumConstraint<[EnumConstraint] T>() {...}
public void MethodWithTypeEnumConstraint<[EnumConstraint(typeof(ConsoleColor))] T>() {...}
そして、Fodyは、制約が存在するために必要なILを追加します。また、デリゲートを制限するという追加の機能にも注意してください。
public void MethodWithDelegateConstraint<[DelegateConstraint] T> ()
{...}
public void MethodWithTypeDelegateConstraint<[DelegateConstraint(typeof(Func<int>))] T> ()
{...}
Enumに関しては、非常に興味深い Enums.NET にも注目してください。
私は拡張メソッドMethod to get integer value from enum
を作りましたメソッド実装を見てみましょう
public static int ToInt<T>(this T soure) where T : IConvertible//enum
{
if (typeof(T).IsEnum)
{
return (int) (IConvertible)soure;// the tricky part
}
//else
// throw new ArgumentException("T must be an enumerated type");
return soure.ToInt32(CultureInfo.CurrentCulture);
}
これが使い方です
MemberStatusEnum.Activated.ToInt()// using extension Method
(int) MemberStatusEnum.Activated //the ordinary way
私はChristopher CurrensのILを使用したソリューションを気に入っていましたが、MSILを自分のビルドプロセスに含めるという面倒なビジネスに対処したくない人のために、私はC#で同様の関数を書きました。
Enumは特別な型なので、where T : Enum
のような一般的な制限を使用することはできません。したがって、与えられたジェネリック型が本当に列挙型かどうかをチェックする必要があります。
私の機能は次のとおりです。
public static T GetEnumFromString<T>(string strValue, T defaultValue)
{
// Check if it realy enum at runtime
if (!typeof(T).IsEnum)
throw new ArgumentException("Method GetEnumFromString can be used with enums only");
if (!string.IsNullOrEmpty(strValue))
{
IEnumerator enumerator = Enum.GetValues(typeof(T)).GetEnumerator();
while (enumerator.MoveNext())
{
T temp = (T)enumerator.Current;
if (temp.ToString().ToLower().Equals(strValue.Trim().ToLower()))
return temp;
}
}
return defaultValue;
}
後で直接キャストを使用しても構わない場合は、必要に応じて、メソッドでSystem.Enum
基本クラスを使用できると思います。あなただけの型パラメータを慎重に置き換える必要があります。そのため、メソッドの実装は次のようになります。
public static class EnumUtils
{
public static Enum GetEnumFromString(string value, Enum defaultValue)
{
if (string.IsNullOrEmpty(value)) return defaultValue;
foreach (Enum item in Enum.GetValues(defaultValue.GetType()))
{
if (item.ToString().ToLower().Equals(value.Trim().ToLower())) return item;
}
return defaultValue;
}
}
それからあなたはそれを使うことができます:
var parsedOutput = (YourEnum)EnumUtils.GetEnumFromString(someString, YourEnum.DefaultValue);