Jak dodać metody rozszerzające do wyliczeń

122

Mam ten kod Enum:

enum Duration { Day, Week, Month };

Czy mogę dodać metody rozszerzenia dla tego wyliczenia?

user2110292
źródło
1
Widziałeś to? stackoverflow.com/questions/2422113/…
badpanda
krótka odpowiedź, tak. W tym konkretnym przypadku możesz rozważyć użycieTimeSpan
Jodrell
1
Używanie metod rozszerzających na wyliczeniu sprawiłoby, że czułbym się brudny. Utwórz klasę, aby hermetyzować to, co jest potrzebne. Utrzymuj wyliczenie tak proste, jak to tylko możliwe. Jeśli potrzebujesz więcej logiki z nim skojarzonej, utwórz klasę Duration, która uwidacznia dzień, tydzień, miesiąc oraz każdą inną logikę, która byłaby w metodzie rozszerzającej.
Jason Evans
2
Lubię mieć metody rozszerzenia wyliczeń dla grup flag. Wolę się, jeśli na przykład klauzule Day.IsWorkday()nad (Day & Days.Workday) > 0z Days.Workdayzdefiniowana jako Monday | Tuesday ... | Friday. Ta pierwsza jest moim zdaniem bardziej przejrzysta i ma zaimplementowaną dokładnie tę drugą.
Sebastian Werk,

Odpowiedzi:

114

Według tej strony :

Metody rozszerzające umożliwiają pisanie metod dla istniejących klas w sposób, w jaki inne osoby w Twoim zespole mogą faktycznie je odkrywać i używać. Biorąc pod uwagę, że wyliczenia są klasami jak wszystkie inne, nie powinno dziwić, że można je rozszerzyć, na przykład:

enum Duration { Day, Week, Month };

static class DurationExtensions 
{
  public static DateTime From(this Duration duration, DateTime dateTime) 
  {
    switch (duration) 
    {
      case Day:   return dateTime.AddDays(1);
      case Week:  return dateTime.AddDays(7);
      case Month: return dateTime.AddMonths(1);
      default:    throw new ArgumentOutOfRangeException("duration");
    }
  }
}

Myślę, że wyliczenia nie są ogólnie najlepszym wyborem, ale przynajmniej pozwala to scentralizować niektóre przełączniki / jeśli je obsługiwać i nieco je oddzielić, aż będziesz mógł zrobić coś lepszego. Pamiętaj, aby sprawdzić, czy wartości również mieszczą się w zakresie.

Możesz przeczytać więcej tutaj w Microsft MSDN.

Załoga One Man
źródło
Uważam, że komentarz „wyliczenia są złe” jest nie na miejscu, ale ma podstawę w rzeczywistości. Uważam, że wyliczenia mogą być problemem, są nadużywane, ponieważ w pewnym sensie zamykają cię w pewnych kontekstach i zachowaniach.
Ed Schwehm
1
Enumy w C # trochę do dupy, ponieważ kompiluje się i uruchamia:Duration d = 0;
Graham
16
Given that enums are classesnie, to nie są zajęcia.
Skrzydłowy Sendon
1
Używam tego rodzaju rozszerzenia tylko wtedy, gdy dotyczy bezpośrednio wyliczenia, na przykład dni tygodnia i metod rozszerzających IsWeekday (), IsWeekendday (). Ale klasy mają na celu hermetyzację zachowań, więc jeśli jest dużo lub skomplikowanych zachowań do hermetyzacji, klasa jest prawdopodobnie lepsza. Jeśli jest ograniczony i podstawowy, osobiście uważam, że rozszerzenia wyliczeń są w porządku. Podobnie jak w przypadku większości decyzji projektowych istnieją niejasne granice między wyborami (IMO). Warto zauważyć, że rozszerzenia można wykonywać tylko na klasach statycznych najwyższego poziomu, a nie na klasach zagnieżdżonych. Jeśli wyliczenie jest częścią klasy, musisz utworzyć klasę.
FreeText
51

Możesz również dodać metodę rozszerzenia do typu Enum zamiast wystąpienia Enum:

/// <summary> Enum Extension Methods </summary>
/// <typeparam name="T"> type of Enum </typeparam>
public class Enum<T> where T : struct, IConvertible
{
    public static int Count
    {
        get
        {
            if (!typeof(T).IsEnum)
                throw new ArgumentException("T must be an enumerated type");

            return Enum.GetNames(typeof(T)).Length;
        }
    }
}

Możesz wywołać powyższą metodę rozszerzenia, wykonując:

var result = Enum<Duration>.Count;

To nie jest prawdziwa metoda rozszerzenia. Działa tylko dlatego, że Enum <> jest innego typu niż System.Enum.

ShawnFeatherly
źródło
Czy klasa może staticzapewnić, że wszystkie jej metody zachowują się jak rozszerzenia?
Jatin Sanghvi,
15
Dla przyszłych czytelników: niejednoznaczność nazwy Enum<T>jest nieco myląca. Klasę można również wywołać, EnumUtils<T>a wywołanie metody rozwiązałoby się do EnumUtils<Duration>.Count.
Namoshek
46

Oczywiście możesz na przykład powiedzieć, że chcesz użyć DescriptionAttribuena swoich enumwartościach:

using System.ComponentModel.DataAnnotations;

public enum Duration 
{ 
    [Description("Eight hours")]
    Day,

    [Description("Five days")]
    Week,

    [Description("Twenty-one days")] 
    Month 
}

Teraz chcesz móc zrobić coś takiego:

Duration duration = Duration.Week;
var description = duration.GetDescription(); // will return "Five days"

Twoja metoda rozszerzenia GetDescription()może być zapisana w następujący sposób:

using System.ComponentModel;
using System.Reflection;

public static string GetDescription(this Enum value)
{
    FieldInfo fieldInfo = value.GetType().GetField(value.ToString());
    if (fieldInfo == null) return null;
    var attribute = (DescriptionAttribute)fieldInfo.GetCustomAttribute(typeof(DescriptionAttribute));
    return attribute.Description;
}
Ułożone
źródło
Chciałem stworzyć rozszerzenie do prawie dokładnie tego, co zrobiłeś, z wyjątkiem mojego użycia DisplayAttribute Localized GetDescription. okrzyki
George
To fajna alternatywa, chociaż myślę, że przestrzeń nazw to po prostu System.ComponentModel?
TomDestry
Fajna perspektywa i dziękuję za pokazanie implementacji oraz kodu rozszerzenia. Aby uzupełnić: swoją implementację możesz również nazwać w ten sposób: var description = Duration.Week.GetDescription ();
Spencer Sullivan
31

Wszystkie odpowiedzi są świetne, ale mówią o dodaniu metody rozszerzenia do określonego typu wyliczenia.

A co, jeśli chcesz dodać metodę do wszystkich wyliczeń, na przykład zwracającą int bieżącej wartości zamiast jawnego rzutowania?

public static class EnumExtensions
{
    public static int ToInt<T>(this T soure) where T : IConvertible//enum
    {
        if (!typeof(T).IsEnum)
            throw new ArgumentException("T must be an enumerated type");

        return (int) (IConvertible) soure;
    }

    //ShawnFeatherly funtion (above answer) but as extention method
    public static int Count<T>(this T soure) where T : IConvertible//enum
    {
        if (!typeof(T).IsEnum)
            throw new ArgumentException("T must be an enumerated type");

        return Enum.GetNames(typeof(T)).Length;
    }
}

Sztuczka IConvertiblepolega na tym, że Hierarchia dziedziczenia, patrz MDSN

Dziękuję ShawnFeatherly za odpowiedź

Basheer AL-MOMANI
źródło
1
najlepsza odpowiedź!
Marco Alves
Tak samo. Działa, jeśli dzwonię bezpośrednio do rozszerzenia (np. MyExtention.DoThing(myvalue)), Ale w rzeczywistości nie dołączam do wyliczenia (np. myvalue.DoThing())
Sinaesthetic
1
FYI, C # 7.3 obsługuje teraz Enum jako ograniczenie typu ogólnego
redtetrahedron
7

Możesz utworzyć rozszerzenie dla wszystkiego, nawet object(chociaż nie jest to uważane za najlepszą praktykę ). Zrozum metodę rozszerzania tak samo, jak public staticmetodę. Możesz użyć dowolnego typu parametru w metodach.

public static class DurationExtensions
{
  public static int CalculateDistanceBetween(this Duration first, Duration last)
  {
    //Do something here
  }
}
Tim Schmelter
źródło
5

Zobacz MSDN .

public static class Extensions
{
  public static string SomeMethod(this Duration enumValue)
  {
    //Do something here
    return enumValue.ToString("D"); 
  }
}
LukeHennerley
źródło
7
voidWartość zwracana na enum jest trochę dziwne. Pomyślałbym o bardziej realistycznej próbce.
psubsee2003
3
@ psubsee2003 OP z pewnością ma wystarczającą wiedzę, aby zmienić to zgodnie z jego potrzebami? Dlaczego próbka ma znaczenie, wystarczy odpowiedzieć na wstępne pytanie.
LukeHennerley
3
Czy tylko ja uważam, że przykłady kodu w witrynie MSDN są dziwne? W większości przypadków potrzebujesz prawdziwego wysiłku, aby zrozumieć, co próbują zrobić!
Skumulowany
0

właśnie stworzyliśmy rozszerzenie wyliczenia dla c # https://github.com/simonmau/enum_ext

To tylko implementacja dla typesafeenum, ale działa świetnie, więc stworzyliśmy pakiet do udostępnienia - baw się dobrze

public sealed class Weekday : TypeSafeNameEnum<Weekday, int>
{
    public static readonly Weekday Monday = new Weekday(1, "--Monday--");
    public static readonly Weekday Tuesday = new Weekday(2, "--Tuesday--");
    public static readonly Weekday Wednesday = new Weekday(3, "--Wednesday--");
    ....

    private Weekday(int id, string name) : base(id, name)
    {
    }

    public string AppendName(string input)
    {
        return $"{Name} {input}";
    }
}

Wiem, że przykład jest trochę bezużyteczny, ale masz pomysł;)

simonmau
źródło
0

Proste obejście.

public static class EnumExtensions
{
    public static int ToInt(this Enum payLoad) {

        return ( int ) ( IConvertible ) payLoad;

    }
}

int num = YourEnum.AItem.ToInt();
Console.WriteLine("num : ", num);
M. Hamza Rajput
źródło