如何向 Enums 添加扩展方法

Question

我有这个枚举代码：

enum Duration { Day, Week, Month };

我可以为这个 Enum 添加扩展方法吗？

Answer 1

当然你可以，例如，你想在你的enum 值上使用DescriptionAttribue：

using System.ComponentModel;

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

    [Description("Five days")]
    Week,

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

现在您希望能够执行以下操作：

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

你的扩展方法GetDescription()可以这样写：

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

Answer 2

一个简单的解决方法。

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

        return ( int ) ( IConvertible ) payLoad;

    }
}

int num = YourEnum.AItem.ToInt();
Console.WriteLine("num : ", num);

Answer 3

我们刚刚为 c# https://github.com/simonmau/enum_ext做了一个枚举扩展

这只是 typesafeenum 的一个实现，但它工作得很好，所以我们制作了一个包来分享 - 玩得开心

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

我知道这个例子有点没用，但你明白了 ;)

Answer 4

所有答案都很好，但他们正在谈论将扩展方法添加到特定类型的枚举。

如果您想为所有枚举添加一个方法，例如返回一个当前值的 int 而不是显式转换，该怎么办？

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

IConvertible 背后的技巧是它的继承层次结构，请参阅MDSN

感谢ShawnFeatherly for his answer

Answer 5

据此site：

扩展方法提供了一种为现有类编写方法的方法，您的团队中的其他人可能会实际发现和使用这种方法。鉴于枚举和其他任何类一样，您可以扩展它们应该不会太令人惊讶，例如：

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

我认为枚举通常不是最好的选择，但至少这可以让你集中一些 switch/if 处理并将它们抽象一点，直到你可以做得更好。记得检查值是否也在范围内。

您可以在 Microsft MSDN 上阅读更多 here。

Answer 6

见MSDN。

public static class Extensions
{
  public static string SomeMethod(this Duration enumValue)
  {
    //Do something here
    return enumValue.ToString("D"); 
  }
}

Answer 7

您还可以向 Enum 类型添加扩展方法，而不是 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;
        }
    }
}

您可以通过以下方式调用上述扩展方法：

var result = Enum<Duration>.Count;

这不是真正的扩展方法。它之所以有效，是因为 Enum 是与 System.Enum 不同的类型。

Answer 8

你可以为任何东西创建一个扩展，甚至是object（虽然那是not considered best-practice）。将扩展方法理解为public static 方法。您可以在方法上使用您喜欢的任何参数类型。

public static class DurationExtensions
{
  public static int CalculateDistanceBetween(this Duration first, Duration last)
  {
    //Do something here
  }
}