Создать универсальный метод, ограничивающий 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.

справедливо, но есть ли обходной путь, чтобы разрешить общее перечисление, или мне придется имитировать

20 ответов


С Enum тип реализует 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#), но is возможно в 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-фалами MSIL следует вместо сборки.

к сожалению, VS2010 (и ранее, очевидно) не поддерживает добавление ссылок netmodule, что означает, что вам придется оставить его в 2 отдельных сборках при отладке. Единственный способ добавить их в сборку было бы запустить csc.исполняемые самостоятельно с помощью /addmodule:{files} аргумент командной строки. Это не было бы слишком болезненно в сценарии MSBuild. Конечно, если вы смелый или глупый, вы можете запустить csc самостоятельно вручную каждый раз. И это, безусловно, становится более сложным, поскольку несколько сборок нуждаются в доступе к нему.

Итак ,это можно сделать.Сеть. Стоит ли дополнительных усилий? Что ж, думаю, я позволю тебе принять решение.


F решение# как альтернатива

дополнительный кредит: оказывается, что общее ограничение на enum возможно, по крайней мере, на одном другом языке .NET, кроме MSIL: 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);

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 компилятора, злоупотребляя наследованием ограничений. В следующем коде указывается как class и 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 системой типов.Объект, Система.Велоэтапе, Системы.Перечисление и любой тип интерфейса.


редактировать

на этот вопрос теперь великолепно ответил Жюльен 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);

старый

мои старые улучшения на ответ Вивека С помощью комментариев и "new" события:

  • использовать TEnum для ясности для пользователей
  • добавить дополнительные ограничения интерфейса для дополнительной проверки ограничений
  • пусть TryParse дескриптор ignoreCase С существующим параметром (введено в VS2010 / .Net 4)
  • при необходимости используйте generic default стоимостью (введено в VS2005 / .Net 2)
  • использовать дополнительные аргументы(введено в VS2010 / .Net 4) по умолчанию ценности для 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;
    }
}

вы можете определить статический конструктор для класса, который проверит, что тип T является перечислением, и выдаст исключение, если это не так. Это метод, упомянутый Джеффри Рихтером в его книге CLR via C#.

internal sealed class GenericTypeThatRequiresAnEnum<T> {
    static GenericTypeThatRequiresAnEnum() {
        if (!typeof(T).IsEnum) {
        throw new ArgumentException("T must be an enumerated type");
        }
    }
}

затем в методе parse вы можете просто использовать перечисление.Parse(typeof (T), input, true) для преобразования из строки в перечисление. Последний параметр true предназначен для игнорирования случая ввода.


Я изменил образец 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);
    }
}

Я попытался немного улучшить код:

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

следует также учитывать, что с момента выпуска 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, см. Следующее скриншот: enter image description here

EDIT 1-Требуемая версия Visual Studio и рассмотрение ReSharper

чтобы Visual Studio распознала новый синтаксис, вам нужна хотя бы версия 15.7. Вы можете найти, что также упоминается в примечаниях к выпуску Microsoft, см. Visual Studio 2017 15.7 Примечания К Выпуску. Спасибо @MohamedElshawaf за указание на этот действительный вопрос.

Pls также обратите внимание, что в моем случае ReSharper 2018.1 на момент написания это редактирование еще не поддерживает C# 7.3. Активировав ReSharper, он выделяет ограничение перечисления как ошибку, сообщающую мне не может использовать ' система.Массив", " Система.Делегировать", " Система.Перечисление', 'Системы.ValueType', 'object' как ограничение параметра типа. ReSharper предлагает как быстрое исправление удалить ограничение перечисления типа paramter T метода

однако, если вы временно отключите ReSharper под Инструменты - > Параметры - > ReSharper Ultimate - > Генерал!--20--> вы увидите, что синтаксис отлично подходит, учитывая, что вы используете VS 15.7 или выше и C# 7.3 или выше.


У меня есть конкретное требование, где я должен использовать перечисление с текстом, связанным со значением перечисления. Например, когда я использую 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;
      }
}

достаточно интересно, видимо это возможно на других языках (управляемый C++, IL напрямую).

Цитата:

... Оба ограничения фактически производят действительный IL и также могут использоваться C#, если они написаны на другом языке (вы можете объявить эти ограничения в управляемом C++ или в IL).

кто знает


Это мой взгляд на это. В сочетании с ответами и 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


существующие ответы верны с C# запрос (привязали к corefx запрос функции), чтобы разрешить следующее;

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

на момент написания статьи эта функция "обсуждается" на совещаниях по разработке языков.

редактировать

по состоянию на Науфальинформация, это вводится в C# 7.3.


Мне всегда это нравилось (вы можете изменить по мере необходимости):

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, но для тех, кто не хочет иметь дело с сложным бизнесом включения MSIL в процесс сборки, я написал аналогичную функцию на C#.

обратите внимание, что вы не можете использовать общее ограничение, как 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;
}

Я инкапсулировал решение 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);
        }
    }
}

Я создал метод расширения 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

как указано в других ответах ранее; хотя это не может быть выражено в исходном коде, это действительно можно сделать на уровне IL. @Christopher Currens ответ показывает, как IL это делает.

С Фодыс надстройкой ExtraConstraints.Фоди!--6--> есть очень простой способ, в комплекте с build-tooling, чтобы достичь этого. Просто добавьте свои пакеты nuget (Fody, ExtraConstraints.Fody) к вашему проекту и добавьте ограничения следующим образом (выдержка из Readme 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.NET.


Если это нормально использовать прямое литье после этого, я думаю, вы можете использовать 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);

в java вы бы использовали...

    SomeClass<T extends enum> {
}

довольно просто, это.