验证枚举值

Question

我需要验证一个整数才能知道它是否是一个有效的枚举值。

在 C# 中执行此操作的最佳方法是什么？

Answer 1

你一定会喜欢这些认为数据不仅总是来自 UI，而且在你的控制范围内的 UI 的人！

IsDefined 适用于大多数情况，您可以从以下开始：

public static bool TryParseEnum<TEnum>(this int enumValue, out TEnum retVal)
{
 retVal = default(TEnum);
 bool success = Enum.IsDefined(typeof(TEnum), enumValue);
 if (success)
 {
  retVal = (TEnum)Enum.ToObject(typeof(TEnum), enumValue);
 }
 return success;
}

（如果您认为它不是合适的 int 扩展名，显然只需删除“this”）

Answer 2

恕我直言，标记为答案的帖子不正确。
参数和数据验证是我几十年前钻研的事情之一。

为什么

验证是必需的，因为基本上任何整数值都可以分配给枚举而不会引发错误。
我花了很多天研究 C# 枚举验证，因为它在很多情况下都是必要的功能。

在哪里

对我来说，枚举验证的主要目的是验证从文件中读取的数据：您永远不知道文件是否已损坏、是否被外部修改或被故意入侵。
并且对从剪贴板粘贴的应用程序数据进行枚举验证：您永远不知道用户是否编辑了剪贴板内容。

也就是说，我花了几天时间研究和测试许多方法，包括分析我能找到或设计的每种方法的性能。

调用 System.Enum 中的任何内容都非常慢，以至于对于包含成百上千个对象的函数来说，这些对象的属性中具有一个或多个必须验证边界的枚举，这会导致明显的性能损失。

最重要的是，在验证枚举值时远离 System.Enum 类中的所有内容，它非常慢。

结果

我目前用于枚举验证的方法可能会引起这里许多程序员的翻白眼，但恕我直言，对于我的特定应用程序设计而言，它是最不邪恶的。

我定义了一个或两个常量，它们是枚举的上限和（可选）下限，并在一对 if() 语句中使用它们进行验证。
一个缺点是，如果您更改枚举，您必须确保更新常量。
此方法也仅在枚举是“自动”样式时才有效，其中每个枚举元素都是增量整数值，例如 0,1,2,3,4,.... 它不能与标志或枚举一起正常工作具有非增量值。

另请注意，此方法几乎与常规 int32 上的 "" 一样快（在我的测试中获得了 38,000 个滴答声）。

例如：

public const MyEnum MYENUM_MINIMUM = MyEnum.One;
public const MyEnum MYENUM_MAXIMUM = MyEnum.Four;

public enum MyEnum
{
    One,
    Two,
    Three,
    Four
};

public static MyEnum Validate(MyEnum value)
{
    if (value < MYENUM_MINIMUM) { return MYENUM_MINIMUM; }
    if (value > MYENUM_MAXIMUM) { return MYENUM_MAXIMUM; }
    return value;
}

性能

对于那些感兴趣的人，我介绍了枚举验证的以下变体，以下是结果。

分析是在发布编译时以随机整数输入值在每个方法上循环一百万次执行的。每个测试运行 10 次以上并取平均值。滴答结果包括执行的总时间，其中包括随机数生成等，但这些在测试中将保持不变。 1 个滴答 = 10ns。

注意这里的代码不是完整的测试代码，它只是基本的枚举验证方法。还测试了许多其他变体，所有变体的结果都与此处显示的 1,800,000 个滴答声相似。

列出从最慢到最快的四舍五入结果，希望没有错别字。

在方法中确定的界限 = 13,600,000 个滴答声

public static T Clamp<T>(T value)
{
    int minimum = Enum.GetValues(typeof(T)).GetLowerBound(0);
    int maximum = Enum.GetValues(typeof(T)).GetUpperBound(0);

    if (Convert.ToInt32(value) < minimum) { return (T)Enum.ToObject(typeof(T), minimum); }
    if (Convert.ToInt32(value) > maximum) { return (T)Enum.ToObject(typeof(T), maximum); }
    return value;
}

Enum.IsDefined = 1,800,000 滴答
注意：此代码版本不会限制到最小值/最大值，但如果超出范围则返回默认值。

public static T ValidateItem<T>(T eEnumItem)
{
    if (Enum.IsDefined(typeof(T), eEnumItem) == true)
        return eEnumItem;
    else
        return default(T);
}

System.Enum Convert Int32 with casts = 1,800,000 滴答声

public static Enum Clamp(this Enum value, Enum minimum, Enum maximum)
{
    if (Convert.ToInt32(value) < Convert.ToInt32(minimum)) { return minimum; }
    if (Convert.ToInt32(value) > Convert.ToInt32(maximum)) { return maximum; }
    return value;
}

if() 最小/最大常数 = 43,000 个滴答 = 获胜者快 42 倍和 316 倍。

public static MyEnum Clamp(MyEnum value)
{
    if (value < MYENUM_MINIMUM) { return MYENUM_MINIMUM; }
    if (value > MYENUM_MAXIMUM) { return MYENUM_MAXIMUM; }
    return value;
}

-eol-

Answer 3

正如其他人所提到的，Enum.IsDefined 很慢，如果它处于循环中，您必须注意这一点。

进行多重比较时，更快的方法是首先将值放入HashSet。然后只需使用Contains 来检查该值是否有效，如下所示：

int userInput = 4;
// below, Enum.GetValues converts enum to array. We then convert the array to hashset.
HashSet<int> validVals = new HashSet<int>((int[])Enum.GetValues(typeof(MyEnum)));
// the following could be in a loop, or do multiple comparisons, etc.
if (validVals.Contains(userInput))
{
    // is valid
}

Answer 4

这是一个快速的通用解决方案，使用静态构造的HashSet<T>。

您可以在工具箱中定义一次，然后将其用于所有枚举验证。

public static class EnumHelpers
{
    /// <summary>
    /// Returns whether the given enum value is a defined value for its type.
    /// Throws if the type parameter is not an enum type.
    /// </summary>
    public static bool IsDefined<T>(T enumValue)
    {
        if (typeof(T).BaseType != typeof(System.Enum)) throw new ArgumentException($"{nameof(T)} must be an enum type.");

        return EnumValueCache<T>.DefinedValues.Contains(enumValue);
    }

    /// <summary>
    /// Statically caches each defined value for each enum type for which this class is accessed.
    /// Uses the fact that static things exist separately for each distinct type parameter.
    /// </summary>
    internal static class EnumValueCache<T>
    {
        public static HashSet<T> DefinedValues { get; }

        static EnumValueCache()
        {
            if (typeof(T).BaseType != typeof(System.Enum)) throw new Exception($"{nameof(T)} must be an enum type.");

            DefinedValues = new HashSet<T>((T[])System.Enum.GetValues(typeof(T)));
        }
    }
}

请注意，通过使用带有字符串键的字典（注意不区分大小写和数字字符串表示），这种方法也很容易扩展到枚举解析。

Answer 5

Brad Abrams 在他的帖子 The Danger of Oversimplification 中特别警告了 Enum.IsDefined。

摆脱此要求（即验证枚举的需要）的最佳方法是删除用户可能会出错的方式，例如某种输入框。例如，使用带有下拉菜单的枚举来强制使用有效的枚举。

Answer 6

此答案是对 deegee 的回答的回应，该回答提出了 System.Enum 的性能问题，因此不应将其视为我首选的通用答案，更多地解决严格性能场景中的枚举验证。

如果您遇到关键任务性能问题，其中缓慢但功能性代码在紧密循环中运行，那么我个人会考虑尽可能将代码移出循环，而不是通过减少功能来解决。将代码限制为仅支持连续枚举可能是寻找错误的噩梦，例如，如果将来有人决定弃用某些枚举值。简单地说，您可以在开始时调用 Enum.GetValues 一次，以避免触发所有反射等数千次。这应该可以立即提高性能。如果你需要更高的性能并且你知道你的很多枚举是连续的（但你仍然想支持'gappy'枚举），你可以更进一步，做一些类似的事情：

public abstract class EnumValidator<TEnum> where TEnum : struct, IConvertible
{
    protected static bool IsContiguous
    {
        get
        {
            int[] enumVals = Enum.GetValues(typeof(TEnum)).Cast<int>().ToArray();

            int lowest = enumVals.OrderBy(i => i).First();
            int highest = enumVals.OrderByDescending(i => i).First();

            return !Enumerable.Range(lowest, highest).Except(enumVals).Any();
        }
    }

    public static EnumValidator<TEnum> Create()
    {
        if (!typeof(TEnum).IsEnum)
        {
            throw new ArgumentException("Please use an enum!");
        }

        return IsContiguous ? (EnumValidator<TEnum>)new ContiguousEnumValidator<TEnum>() : new JumbledEnumValidator<TEnum>();
    }

    public abstract bool IsValid(int value);
}

public class JumbledEnumValidator<TEnum> : EnumValidator<TEnum> where TEnum : struct, IConvertible
{
    private readonly int[] _values;

    public JumbledEnumValidator()
    {
        _values = Enum.GetValues(typeof (TEnum)).Cast<int>().ToArray();
    }

    public override bool IsValid(int value)
    {
        return _values.Contains(value);
    }
}

public class ContiguousEnumValidator<TEnum> : EnumValidator<TEnum> where TEnum : struct, IConvertible
{
    private readonly int _highest;
    private readonly int _lowest;

    public ContiguousEnumValidator()
    {
        List<int> enumVals = Enum.GetValues(typeof (TEnum)).Cast<int>().ToList();

        _lowest = enumVals.OrderBy(i => i).First();
        _highest = enumVals.OrderByDescending(i => i).First();
    }

    public override bool IsValid(int value)
    {
        return value >= _lowest && value <= _highest;
    }
}

你的循环变成这样的地方：

//Pre import-loop
EnumValidator< MyEnum > enumValidator = EnumValidator< MyEnum >.Create();
while(import)   //Tight RT loop.
{
    bool isValid = enumValidator.IsValid(theValue);
}

我确信 EnumValidator 类可以更高效地编写（这只是一个快速演示），但坦率地说，谁在乎导入循环之外发生了什么？唯一需要超快的位是在循环内。这就是采用抽象类路线的原因，以避免循环中不必要的 if-enumContiguous-then-else （工厂 Create 基本上是预先完成的）。 您会注意到有点虚伪，为简洁起见，此代码将功能限制为 int-enums。我应该使用 IConvertible 而不是直接使用 int 但这个答案已经够罗嗦了！

Answer 7

这就是我根据网上多个帖子的做法。这样做的原因是为了确保标有Flags 属性的枚举也可以成功验证。

public static TEnum ParseEnum<TEnum>(string valueString, string parameterName = null)
{
    var parsed = (TEnum)Enum.Parse(typeof(TEnum), valueString, true);
    decimal d;
    if (!decimal.TryParse(parsed.ToString(), out d))
    {
        return parsed;
    }

    if (!string.IsNullOrEmpty(parameterName))
    {
        throw new ArgumentException(string.Format("Bad parameter value. Name: {0}, value: {1}", parameterName, valueString), parameterName);
    }
    else
    {
        throw new ArgumentException("Bad value. Value: " + valueString);
    }
}

Answer 8

根据 Timo 的回答，我精心设计了以下扩展方法（C# 6 语法）以提供快速、通用的解决方案。

这避免了Enum.IsDefined 的性能问题，而且语法更简洁。

public static class EnumHelpers
{
    /// <summary>
    /// Returns whether the given enum value is a defined value for its type.
    /// </summary>
    public static bool IsDefined<T>(this T enumValue)
        where T : Enum
        => EnumValueCache<T>.DefinedValues.Contains(enumValue);

    /// <summary>
    /// Caches the defined values for each enum type for which this class is accessed.
    /// </summary>
    private static class EnumValueCache<T>
        where T : Enum
    {
        public static readonly HashSet<T> DefinedValues = new HashSet<T>((T[])Enum.GetValues(typeof(T)));
    }
}

用法：

if (!myEnumValue.IsDefined())
   // ...

Answer 9

您可以为您的项目使用 FluentValidation。这是“枚举验证”的一个简单示例

让我们使用 FluentValidation 创建一个 EnumValidator 类；

public class EnumValidator<TEnum> : AbstractValidator<TEnum> where TEnum : struct, IConvertible, IComparable, IFormattable
{
    public EnumValidator(string message)
    {
        RuleFor(a => a).Must(a => typeof(TEnum).IsEnum).IsInEnum().WithMessage(message);
    }

}

现在我们创建了 enumvalidator 类；让我们创建一个类来调用 enumvalidor 类；

 public class Customer 
{
  public string Name { get; set; }
  public Address address{ get; set; }
  public AddressType type {get; set;}
}
public class Address 
{
  public string Line1 { get; set; }
  public string Line2 { get; set; }
  public string Town { get; set; }
  public string County { get; set; }
  public string Postcode { get; set; }

}

public enum AddressType
{
   HOME,
   WORK
}

是时候为客户类中的地址类型调用我们的枚举验证器了。

public class CustomerValidator : AbstractValidator<Customer>
{
    public CustomerValidator()
   {
     RuleFor(x => x.type).SetValidator(new EnumValidator<AddressType>("errormessage");
  }
}

Answer 10

我发现这个link 回答得很好。它使用：

(ENUMTYPE)Enum.ToObject(typeof(ENUMTYPE), INT)

Answer 11

要验证一个值是否是枚举中的有效值，只需要调用静态方法Enum.IsDefined即可。

int value = 99;//Your int value
if (Enum.IsDefined(typeof(your_enum_type), value))
{
   //Todo when value is valid
}else{
   //Todo when value is not valid
}