如何向Enums添加扩展方法

时间:2013-03-13 14:26:24

标签: c# .net enums

我有这个枚举代码:

enum Duration { Day, Week, Month };

我可以为此枚举添加扩展方法吗?

8 个答案:

答案 0 :(得分:85)

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

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

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

答案 1 :(得分:36)

您还可以向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&lt;&gt;是一个与System.Enum不同的类型。

答案 2 :(得分:29)

当然,您可以,例如,您希望在DescriptionAttribue值上使用enum

using System.ComponentModel.DataAnnotations;

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

答案 3 :(得分:19)

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

如果要将方法添加到所有枚举,例如返回当前值的int而不是显式转换

,该怎么办?
public static class EnumExtentions
{
    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

答案 4 :(得分:7)

您可以为任何内容创建扩展程序,甚至是object(尽管那是not considered best-practice)。像public static方法一样理解扩展方法。您可以在方法上使用您喜欢的任何参数类型。

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

答案 5 :(得分:4)

请参阅MSDN

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

答案 6 :(得分: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);

答案 7 :(得分:1)

我们刚刚为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}";
    }
}

我知道这个例子是没有用的,但是你明白了;)