首页 > C# > 创建将 T 约束为枚举的泛型方法

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

上一篇 下一篇

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

我得到一个错误约束不能是特殊类。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;
    }
}

编辑:(16年2015月<>日)Christopher Currens在下面的MSIL或F#中发布了编译器强制类型安全的通用解决方案,非常值得一看,并投票。如果解决方案在页面上进一步冒泡,我将删除此编辑。

编辑 2:(13 年 2021 月 7 日)由于自 C# 3.<> 以来,这个问题现在已经得到解决和支持,我已经更改了公认的答案,尽管对于学术和历史兴趣?来说,全面阅读顶级答案是值得的
分割线

网友回答:

此功能终于在 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

通过删除该行并调用 ilasm,如下所示:.assembly MyThing{}

ilasm.exe /DLL /OUTPUT=MyThing.netmodule

你得到一个网络模块而不是一个程序集。

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

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


F# 解决方案作为替代方法

额外信用:事实证明,除了 MSIL 之外,至少在一种其他 .NET 语言中可以对 进行通用限制:F#。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);

分割线

网友回答:

由于 Type 实现了接口,因此更好的实现应该是这样的:EnumIConvertible

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

从 C# 7.3(随 Visual Studio 2017 ≥ v15.7 一起提供)开始,此代码现在完全有效:

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

C# ≤ 7.2

您可以通过滥用约束继承来强制实施真正的编译器枚举约束。以下代码同时指定 a 和 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 和任何接口类型。

模板简介:该模板名称为【创建将 T 约束为枚举的泛型方法】,大小是暂无信息,文档格式为.编程语言,推荐使用Sublime/Dreamweaver/HBuilder打开,作品中的图片,文字等数据均可修改,图片请在作品中选中图片替换即可,文字修改直接点击文字修改即可,您也可以新增或修改作品中的内容,该模板来自用户分享,如有侵权行为请联系网站客服处理。欢迎来懒人模板【C#】栏目查找您需要的精美模板。

相关搜索
  • 下载密码 lanrenmb
  • 下载次数 282次
  • 使用软件 Sublime/Dreamweaver/HBuilder
  • 文件格式 编程语言
  • 文件大小 暂无信息
  • 上传时间 02-16
  • 作者 网友投稿
  • 肖像权 人物画像及字体仅供参考
栏目分类 更多 >
热门推荐 更多 >
微信公众平台 单页式简历模板 响应式 企业网站 微信素材 微信文章 html5 自适应 微信图片 微信模板
您可能会喜欢的其他模板