创建将 T 约束为枚举的泛型方法

我正在构建一个函数来扩展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;
}

我收到了一个错误约束,它不能是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 日)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的值类型。机会虽然很少。

C#7.3 最终支持此功能!

以下代码段(来自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#, 它将生成如下所示的函数:

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
}

不幸的是,这意味着用 MSIL 而不是 C#来编写代码的这一部分,唯一的附加好处是您可以通过System.Enum约束此方法。这也很让人讨厌,因为它被编译成一个单独的程序集。但是,这并不意味着您必须采用这种方式进行部署。

通过删除.assembly MyThing{}.assembly MyThing{}以下方式调用 ilasm:

ilasm.exe /DLL /OUTPUT=MyThing.netmodule

您将得到一个 netmodule 而不是一个程序集。

不幸的是,VS2010(显然是更早的版本)不支持添加 netmodule 引用,这意味着在调试时必须将其保留在 2 个单独的程序集中。可以将它们添加为程序集一部分的唯一方法是使用/addmodule:{files}命令行参数自己运行 csc.exe。在 MSBuild 脚本中不会痛苦。当然,如果您勇敢或愚蠢,则可以每次手动手动运行 csc。随着多个程序集需要访问它,它肯定会变得更加复杂。

因此,可以在. Net 中完成。值得付出额外的努力吗?嗯,我想我会让你决定那个。


F#解决方案作为替代

额外的功劳:事实证明,除了 MSIL:F#之外,至少还可以使用一种其他. NET 语言对enum进行一般性限制。

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

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

您可以通过滥用约束继承使真正的编译器强制实施枚举约束。以下代码同时指定了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现在已经很好地回答了这个问题。我还想在添加TryParseParseOrDefault同时,使用ignoreCasedefaultValue和可选参数扩展他的答案。

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 (在 VS2005 / .Net 2 中引入)
  • defaultValueignoreCase使用具有默认值的可选参数 (在 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 在他的书 CLR 中通过 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)从字符串转换为枚举。最后一个 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 指出这个有效的问题。

请注意,就我而言,撰写本 EDIT 时的 ReSharper 2018.1 尚不支持 C#7.3。激活 ReSharper 后,它突出显示了 Enum 约束,因为它告诉我不能使用'System.Array','System.Delegate','System.Enum','System.ValueType','object' 作为类型参数约束 。 ReSharper 建议删除方法类型 T 的'Enum' 约束作为快速解决方案

但是,如果您在 “ 工具”->“选项”->“ReSharper Ultimate”->“常规”下暂时关闭 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;
}

我确实有具体要求,要求将枚举与与枚举值关联的文本一起使用。例如,当我使用枚举指定错误类型时,需要使用它来描述错误详细信息。

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