如何向枚举类型添加扩展方法

Question

我有这个枚举代码:

enum Duration { Day, Week, Month };

我能为这个枚举类型添加扩展方法吗？

- user2110292

---

你看过这个吗？https://dev59.com/D3E95IYBdhLWcg3wKq6q - badpanda

另外，这个：https://dev59.com/RXVC5IYBdhLWcg3wfxM8 - badpanda

简短回答，是的。在这种情况下，您可能需要考虑使用“TimeSpan”。 - Jodrell

在枚举上使用扩展方法会让我感到不舒服。创建一个类来封装所需内容。保持枚举尽可能简单。如果需要更多与之相关的逻辑，则创建一个 Duration 类，其中包含天、周、月等，并包含任何原本应该在扩展方法中的逻辑。 - Jason Evans

我喜欢为标志组编写枚举扩展方法。例如，我更喜欢在if语句中使用Day.IsWorkday()而不是(Day & Days.Workday) > 0，其中Days.Workday被定义为Monday | Tuesday ... | Friday。在我看来，前者更清晰，并且完全实现了后者。 - Sebastian Werk

Answer 1

根据这个网站所述：

扩展方法提供了一种编写现有类方法的方式，让你的团队中的其他人可能会发现和使用。 鉴于枚举是像任何其他类一样的类，因此将它们扩展不应该太令人惊讶，例如：

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处理并将它们抽象化，直到你可以做得更好。记得也要检查数值范围。

您可以在微软MSDN网站这里了解更多信息。

- One Man Crew

---

我认为“枚举是邪恶的”评论有些不合适，但确实有其现实基础。我发现如果过度使用枚举，它们可能会成为问题，因为它们会将您锁定在某些上下文和行为中。 - Ed Schwehm

在C#中，枚举类型有些糟糕，因为以下代码可以编译并运行： Duration d = 0; - Graham

鉴于“enums are classes”（枚举是类），不，它们并不是类。 - wingerse

我只在需要直接与枚举相关的情况下使用这种扩展，例如星期几和扩展方法IsWeekday()、IsWeekendday()。但是类是用来封装行为的，所以如果要封装大量或复杂的行为，则使用类可能更好。如果是有限且基本的话，我个人认为枚举上的扩展还可以接受。就像大多数设计决策一样，在选择之间存在模糊的边界（依我之见）。值得注意的是，扩展只能在顶层静态类上进行，不能在嵌套类上进行。如果您的枚举是类的一部分，则需要创建一个类。 - FreeText

如果你在VS2019中按F12键并选中Enum（注意不是小写的enum），就会跳转到元数据，其中包含了public abstract class Enum : ValueType, IComparable, ... - 因此，在我看来它看起来像一个类，因为我认为enum和Enum是同义词。 - StayOnTarget

Answer 2

您也可以向枚举类型添加扩展方法，而不是枚举实例：

/// <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不同的类型才能工作。

- ShawnFeatherly

---

类可以被声明为static以确保其所有方法都像扩展一样工作吗？ - Jatin Sanghvi

对于未来的读者：Enum<T> 的名称歧义有点令人困惑。这个类也可以被称为 EnumUtils<T>，方法调用将解析为 EnumUtils<Duration>.Count。 - Namoshek

从C# 7.3开始，您可以使用where T : System.Enum替代where T : struct, IConvertible（然后也可以删除ArgumentException）。 - Tobias Xy

Answer 3

当然可以，例如，你想在枚举值上使用DescriptionAttribute：

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

- Stacked

---

我想创建一个扩展，几乎与你的示例完全相同，只是我的使用了DisplayAttribute Localized GetDescription。谢谢。 - George

这是一个不错的替代方案，尽管我认为命名空间只是System.ComponentModel？ - TomDestry

很好的观点，感谢您展示实现以及扩展代码。此外，使用您的实现，您还可以这样调用它：var description = Duration.Week.GetDescription(); - Spencer Sullivan

好的，你写的 GetDescription() 方法也可以用于其他枚举类型，但我想知道如果你使用 (this Duration value) 而不是 (this Enum value) 声明它，是否可以简化它，这样你就知道你正在处理特定的 Duration 类型了？ - ivo.tisljar

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

< p > IConvertible 的诀窍在于其继承层次结构，请参见MDSN

感谢ShawnFeatherly的答案

- Basheer AL-MOMANI

---

最佳答案！ - Marco Alves

同上。如果我直接调用扩展方法（例如 MyExtention.DoThing(myvalue)），它可以工作，但实际上并没有附加到枚举上（例如 myvalue.DoThing()）。 - Sinaesthetic

FYI，C# 7.3 现在支持将 Enum 作为泛型类型约束。 - redtetrahedron

Answer 5

一个简单的解决方法。

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

Answer 6

你可以为任何东西创建扩展，甚至包括object（尽管这不是最佳实践）。将扩展方法理解为public static方法。你可以在方法上使用任何参数类型。

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

- Tim Schmelter

Answer 7

请参见MSDN。

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

- LukeHennerley

---

在枚举中使用void返回值有点奇怪。我会考虑一个更现实的示例。 - psubsee2003

@psubsee2003问道：OP肯定有足够的知识来修改它以适应自己的需要吧？为什么样例很重要，回答最初的问题就足够了。 - LukeHennerley

只有我一个人觉得 MSDN 上的代码示例很奇怪吗？大多数情况下，你需要费些功夫才能理解它们想要做什么！ - Stacked

Answer 8

我们刚刚为C#制作了一个枚举扩展https://github.com/simonmau/enum_ext。

它只是类型安全枚举的实现，但它非常好用，因此我们制作了一个包来分享-玩得开心。

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

我知道这个例子有点无用，但你能理解我的意思;)

- simonmau