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


1187

我建立一个功能扩展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#中发布了由编译器强制执行的类型安全的通用解决方案,这很值得一看,并值得一提。如果解决方案在页面上冒泡,我将删除此编辑。


10
也许您应该使用 ToUpperInvariant()而不是ToLower()...
Max Galkin

31
@Shimmy:将值类型传递给扩展方法后,就在对其进行复制,因此您无法更改其状态。
Garo Yeriazarian

4
知道这是一个旧线程,不知道它们是否已更改,但是扩展方法适用于值类型,请确保它们不一定总是有意义,但是我使用了“ public static TimeSpan Seconds(this int x){ return TimeSpan.FromSeconds(x);}“以启用“ Wait.For(5.Seconds())...”的语法
Jens

6
意识到这不是问题的一部分,但是您可以通过使用String.Equals与StringComparison.InvariantCultureIgnoreCase
Firestrand,2012年

Answers:


1005

由于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。机会虽然很少。


2
从.NET 2.0开始,泛型可用。因此,它们在vb 2005中也可用。
Vivek

46
好吧,让它变得更加受约束,然后,如果您选择沿着这条路...使用“类TestClass <T>,其中T:struct,IComparable,IFormattable,IConvertible”
Ricardo Nolde 2010年

106
另一个建议是使用标识符TEnum定义通用类型。因此:public TEnum GetEnumFromString <TEnum>(字符串值),其中TEnum:struct,IConvertible,IComparible,IFormattable {}
Lisa

11
通过包含其他接口不会带来太多收益,因为几乎所有内置值类型都实现了所有这些接口。对于通用扩展方法的约束尤其如此,这对于操作枚举非常方便,除了这些扩展方法就像病毒一样,会感染所有对象。IConvertable至少将其范围缩小了很多。
russbishop 2014年

2
@SamIam:发布时,该线程已经有6年半了,而且您是正确的,没有编译时检查任何答案。然后,仅3天后,即6年之后,您便实现了自己的愿望-请参阅下面的Julien Lebosquain的帖子。
David I. McIntosh

662

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{}并按以下方式调用ilasm:

ilasm.exe /DLL /OUTPUT=MyThing.netmodule

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

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

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


F#解决方案作为替代

额外的功劳:事实证明,enum除了MSIL:F#之外,至少还可以使用一种其他.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(代码非常不同的),并且它依赖于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);

67
是的,非常顽固。我对可以使用IL进行编码的人表示最大的敬意,并且知道如何在更高的语言级别上支持这些功能-在应用程序,业务规则,UI,组件库等中,我们中的许多人仍将其视为低级别的功能。 。
TonyG

13
我真正想知道的是为什么C#团队尚未开始允许这样做,因为MSIL已经支持了它。
MgSam 2012年

25
@MgSam-从埃里克·利珀特(Eric Lippert)There's no particularly unusual reason why not; we have lots of other things to do, limited budgets, and this one has never made it past the "wouldn't this be nice?" discussion in the language design team.
克里斯托弗·柯伦斯

5
@LordofScripts:我认为原因是,由于其中一个限制类T,以System.Enum将不能够做所有的事情T,人们可能会想到,C#的作者估计他们可能也完全禁止它。我认为该决定是不幸的,因为C#只是忽略了对System.Enum约束的任何特殊处理,因此有可能编写一种HasAnyFlags<T>(this T it, T other)扩展方法,该方法的速度要比Enum.HasFlag(Enum)其数量级快,并且可以对其参数进行类型检查。
supercat 2013年

9
我认为我从未有过一个项目,但我并没有在这里结束。C#6是110%的语法糖,这没入吗?废话
Michael Blackburn

214

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

您可以通过滥用约束继承使真正的编译器强制实施枚举约束。以下代码同时指定了a classstruct约束:

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和任何接口类型。


7
@ DavidI.McIntosh EnumClassUtils<System.Enum>足以将T限制为System.Enum任何派生类型。structParse随后进一步限制了它真正的枚举类型。您需要限制Enum在某个时候。为此,您的类必须嵌套。参见gist.github.com/MrJul/7da12f5f2d6c69f03d79
Julien Lebosquain 2015年

7
明确地说,我的评论“不愉快”不是对您的解决方案的评论-这确实是一个不错的技巧。MS强迫我们使用这种令人费解的骇客,只是“不愉快”。
David I. McIntosh

2
有没有办法将其用于扩展方法?
Mord Zuber 2015年

3
是什么在where TClass : class这里约束增益?
tsemer'1

2
@Trinkyoenum DefinitelyNotAnInt : byte { Realize, That, I, Am, Not, An, Int } enum AlsoNotAnInt : long { Well, Bummer }
M.Stramm '18

30

编辑

Julien Lebosquain现在已经很好地回答了这个问题。我也想延长他的答案ignoreCasedefaultValue和可选的参数,同时加入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的清晰度,为用户
  • 添加更多接口约束以进行其他约束检查
  • 让我们使用现有参数进行TryParse处理ignoreCase(在VS2010 / .Net 4中引入)
  • (可选)使用通用default(在VS2005 / .Net 2中引入)
  • 使用默认值的可选参数(在VS2010 / .Net 4中引入),用于defaultValueignoreCase

导致:

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

18

您可以为该类定义一个静态构造函数,该构造函数将检查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参数用于忽略输入的大小写。


1
对于泛型类,这是一个不错的选择-但是,对于泛型方法,这当然没有帮助。
McGarnagle,2015年

另外,在编译时也不强制执行此操作,您只会知道Enum T在构造函数执行时提供了non 。尽管这比等待实例构造函数好得多。
jrh

15

还应该考虑到,由于开箱即用地支持使用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的“枚举”约束作为快速解决方案

但是,如果您在“ 工具”->“选项”->“ ReSharper Ultimate”->“常规”下暂时关闭ReSharper,则使用VS 15.7或更高版本以及C#7.3或更高版本时,语法会非常完美。


1
您正在使用哪个VS版本?
mshwf

1
@MohamedElshawaf我相信它是15.7版,其中包含对C#7.3的支持
Patrick Roberts

1
我认为最好编写where T : struct, Enum,以避免将System.Enum自身作为类型参数传递。
Mariusz Pawelski '18年

就像我写的@MariuszPawelski一样struct, Enum。我的理由在这里的答案和评论中得到了解释。
Stephen Kennedy

ReSharper信息确实对我有所帮助。注意最新的预览版本支持此功能。
DalSoft

11

我修改了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);
    }
}

13
如果失败,我将不返回默认值。我会让异常传播(就像Enum.Parse一样)。而是使用TryParse返回布尔值,并使用out参数返回结果。
马克·辛普森

1
OP希望它不区分大小写,不是。
Konrad Morawski

9

我试图对代码进行一些改进:

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

1
这比接受的答案要好,因为defaultValue.ToString("D", System.Globalization.NumberFormatInfo.CurrentInfo)即使您不知道它是哪种枚举,也可以调用它,而只是该对象是枚举。
styfle

1
预先检查IsDefined会破坏大小写不敏感。不像ParseIsDefined没有ignoreCase论据,MSDN说它只匹配精确的大小写
Nyerguds

5

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

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

4

希望这会有所帮助:

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

1
如果您需要不区分大小写,只需替换return (TValue)Enum.Parse(typeof (TValue), value);return (TValue)Enum.Parse(typeof (TValue), value, true);
Paulo Santos

3

足够有趣的是,显然这在其他语言中也是可能的(直接由Managed C ++,IL)。

报价:

...这两个约束实际上都产生有效的IL,并且如果用另一种语言编写,则也可以由C#使用(您可以在托管C ++或IL中声明这些约束)。

谁知道


2
C ++托管扩展没有对泛型的任何支持,我想您的意思是C ++ / CLI。
Ben Voigt

3

这是我的看法。从答案和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));
    }
}

MSDN来源


2
这真的没有道理。如果TEnum实际上是一个Enum类型,但是text是一个空字符串,那么您会ArgumentException说“ TEnum必须是Enum类型”。
尼克,

3

从C#<= 7.2开始,现有答案是正确的。但是,存在一个C#语言功能请求(与corefx功能请求绑定)以允许以下操作:

public class MyGeneric<TEnum> where TEnum : System.Enum
{ }

在撰写本文时,该功能在语言开发会议上处于“讨论中”状态。

编辑

根据nawfal的信息,这在C#7.3中进行了介绍。


1
那里有趣的讨论,谢谢。尚无
定论

1
@johnc,非常真实,但值得一提,这一个经常问到的功能。即将来临的机会
很大。– DiskJunky


1

我一直很喜欢这样(您可以根据需要进行修改):

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

1

我喜欢Christopher Currens使用IL的解决方案,但是对于那些不想将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;
}

1

我已经将Vivek的解决方案封装到可以重用的实用程序类中。请注意,您仍然应该在类型上定义类型约束“ 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);
        }
    }
}

1

我创建了一个扩展方法,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

虽然可能可行,但几乎与该问题无关。
quetzalcoatl

1

如之前其他答案中所述;尽管这不能用源代码表示,但实际上可以在IL级别完成。@Christopher Currens的答案显示了IL如何做到这一点。

使用Fody的Add-In ExtraConstraints.Fody,有一种非常简单的方法,可以通过构建工具来完成。只需将它们的nuget包(FodyExtraConstraints.Fody)添加到您的项目中,并按如下所示添加约束(摘自ExtraConstraints的自述文件):

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> ()
{...}

关于Enums,您可能还需要注意非常有趣的Enums.NET


1

这是我的实现。基本上,您可以设置任何属性并且它可以工作。

public static class EnumExtensions
    {
        public static string GetDescription(this Enum @enum)
        {
            Type type = @enum.GetType();
            FieldInfo fi = type.GetField(@enum.ToString());
            DescriptionAttribute[] attrs =
                fi.GetCustomAttributes(typeof(DescriptionAttribute), false) as DescriptionAttribute[];
            if (attrs.Length > 0)
            {
                return attrs[0].Description;
            }
            return null;
        }
    }

0

如果以后可以使用直接强制转换,我想您可以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);

使用Enum.ToObject()会产生更灵活的结果。除此之外,您可以在不区分大小写的情况下进行字符串比较,从而无需调用ToLower()
DiskJunky

-6

仅出于完整性考虑,以下是Java解决方案。我相信同样可以在C#中完成。它避免了必须在代码中的任何地方指定类型-而是在尝试解析的字符串中指定它。

问题是没有任何方法可以知道String可能匹配哪个枚举-因此答案就是要解决该问题。

不仅接受字符串值,还接受同时具有枚举和“ enumeration.value”形式的值的字符串。下面的工作代码-需要Java 1.8或更高版本。这也将使XML更精确,因为您将看到诸如color =“ Color.red”之类的东西,而不仅仅是color =“ red”。

您将使用包含枚举名称点值名称的字符串来调用acceptEnumeratedValue()方法。

该方法返回形式的枚举值。

import java.util.HashMap;
import java.util.Map;
import java.util.function.Function;


public class EnumFromString {

    enum NumberEnum {One, Two, Three};
    enum LetterEnum {A, B, C};


    Map<String, Function<String, ? extends Enum>> enumsByName = new HashMap<>();

    public static void main(String[] args) {
        EnumFromString efs = new EnumFromString();

        System.out.print("\nFirst string is NumberEnum.Two - enum is " + efs.acceptEnumeratedValue("NumberEnum.Two").name());
        System.out.print("\nSecond string is LetterEnum.B - enum is " + efs.acceptEnumeratedValue("LetterEnum.B").name());

    }

    public EnumFromString() {
        enumsByName.put("NumberEnum", s -> {return NumberEnum.valueOf(s);});
        enumsByName.put("LetterEnum", s -> {return LetterEnum.valueOf(s);});
    }

    public Enum acceptEnumeratedValue(String enumDotValue) {

        int pos = enumDotValue.indexOf(".");

        String enumName = enumDotValue.substring(0, pos);
        String value = enumDotValue.substring(pos + 1);

        Enum enumeratedValue = enumsByName.get(enumName).apply(value);

        return enumeratedValue;
    }


}
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.