c# - T を Enum に制約するジェネリックメソッドを作成する

Question

Enum.Parseという概念を拡張する機能を構築しています

Enum 値が見つからない場合にデフォルト値を解析できるようにします
大文字と小文字を区別しない

だから私は次のように書いた：

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;
}

エラー Constraint cannot be special class が発生していますSystem.Enum。

十分に公平ですが、ジェネリック列挙型を許可する回避策はありますか、それともParse関数を模倣して型を属性として渡す必要がありますか?これにより、醜いボクシング要件がコードに強制されます。

編集以下のすべての提案は大歓迎です、ありがとう。

解決しました（大文字と小文字を区別しないようにループを残しました-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 日) Christopher Currens は、以下の MSIL または F# でコンパイラを強制するタイプセーフなジェネリックソリューションを投稿しました。解決策がページのさらに上にある場合は、この編集を削除します。

編集2：（2021年4月13日）C＃7.3以降、これに対処し、サポートされているため、受け入れられた回答を変更しましたが、上位の回答を完全に熟読することは、学術的および歴史的関心のために価値があります:)

score 1075 · Accepted Answer

EnumType はインターフェイスを実装するため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ます。ただし、チャンスはまれです。

score 831 · Accepted Answer

この機能は C# 7.3 でついにサポートされました!

次のスニペット ( dotnet samplesから) は、その方法を示しています。

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# の場合、次のような関数が生成されます。

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 で実行できます。余分な努力をする価値はありますか？うーん、それはあなたに決めさせてあげましょう。

代替としての F# ソリューション

enum追加クレジット: MSIL 以外の少なくとも 1 つの .NET 言語で一般的な制限が可能であることがわかりました: F#。

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 が生成され (コードは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);

score 248 · Accepted Answer

C# ≧ 7.3

C# 7.3 (Visual Studio 2017 ≥ v15.7 で利用可能) 以降、このコードは完全に有効になりました。

public static TEnum Parse<TEnum>(string value)
    where TEnum : struct, Enum
{
 ...
}

C# ≤ 7.2

制約の継承を悪用することで、実際のコンパイラに enum 制約を強制させることができます。次のコードは、 aclassと a の両方の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、および任意のインターフェイスタイプに制限されます。

score 31 · Accepted Answer

編集

Julien Lebosquainがこの質問に見事に答えました。また、とを追加しながらignoreCase、defaultValueとオプションの引数で彼の答えを拡張したいと思います。TryParseParseOrDefault

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ユーザーにとって明確にするために使用する
追加の制約チェックのためにさらにインターフェース制約を追加します
let TryParsehandle ignoreCasewith existing parameter (VS2010/.Net 4 で導入)
オプションでジェネリックdefault値を使用(VS2005/.Net 2 で導入)
および_ _ defaultValue_ignoreCase

その結果：

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;
    }
}

score 20 · Accepted Answer

型 T が列挙型であることを確認し、そうでない場合は例外をスローするクラスの静的コンストラクターを定義できます。これは、Jeffery Richter が著書 CLR via C# で言及した方法です。

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) を使用して、文字列から列挙型に変換できます。最後の真のパラメーターは、入力の大文字と小文字を無視するためのものです。

score 18 · Accepted Answer

また、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 に変更する方法がわからない場合は、次のスクリーンショットを参照してください。

EDIT 1 - 必要な Visual Studio バージョンと ReSharper の検討

Visual Studio が新しい構文を認識するには、少なくともバージョン 15.7 が必要です。Microsoft のリリースノートにも記載されています。 Visual Studio 2017 15.7 リリースノートを参照してください。この有効な質問を指摘してくれた@MohamedElshawafに感謝します。

また、私の場合、この編集を書いている時点で ReSharper 2018.1 は C# 7.3 をまだサポートしていないことにも注意してください。ReSharper をアクティブにすると、 Enum 制約がエラーとして強調表示され、「System.Array」、「System.Delegate」、「System.Enum」、「System.ValueType」、「object」を型パラメーター制約として使用できません。ReSharper は、メソッドの型パラメーター T の「列挙型」制約を削除するための迅速な修正として提案します

ただし、 [ツール] -> [オプション] -> [ReSharper Ultimate] -> [全般]で ReSharper を一時的にオフにすると、VS 15.7 以降および C# 7.3 以降を使用していれば、構文が完全に問題ないことがわかります。

score 11 · Accepted Answer

コードを少し改善しようとしました：

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;
}

score 11 · Accepted Answer

dimarzionist によってサンプルを変更しました。このバージョンは列挙型でのみ機能し、構造体は通過させません。

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);
    }
}

score 6 · Accepted Answer

列挙値に関連付けられたテキストで列挙型を使用する必要がある特定の要件があります。たとえば、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());
}

score 6 · Accepted Answer

これが役に立てば幸いです：

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;
      }
}

score 3 · Accepted Answer

興味深いことに、明らかにこれは他の言語 (マネージ C++、IL 直接) で可能です。

引用するには:

... どちらの制約も実際には有効な IL を生成し、別の言語で記述されている場合は C# で使用することもできます (マネージド C++ または IL でこれらの制約を宣言できます)。

知るか

score 1 · Accepted Answer

IL を使用した Christopher Currens のソリューションが気に入りましたが、ビルドプロセスに MSIL を含めるというトリッキーなビジネスに対処したくない人のために、C# で同様の関数を記述しました。

where T : Enumただし、 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;
}

score 1 · Accepted Answer

私はいつもこれが好きでした（必要に応じて変更できます）：

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>();
}

score 1 · Accepted Answer

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);
        }
    }
}

c# - T を Enum に制約するジェネリック メソッドを作成する

22 に答える 22

この機能は C# 7.3 でついにサポートされました!

代替としての F# ソリューション

C# ≧ 7.3

C# ≤ 7.2

Related

Reference

c# - T を Enum に制約するジェネリックメソッドを作成する