C# 中隐藏的枚举值

Question

我有一个枚举，我想“隐藏”它的一个值（因为我添加它是为了将来的支持）。 该代码是用 C# 编写的。

public enum MyEnum
{
   ValueA = 0,

   ValueB = 1,

   Reserved
}

我不想允许使用此代码的人使用此值（MyEnum.Reserved）。 有什么想法吗？ TIA

Answer 1

您可以使用“Obsolete”属性 - 语义上不正确，但它会执行您想要的操作：

public enum MyEnum 
{ 
  ValueA = 0, 
  ValueB = 1, 
  [Obsolete("Do not use this", true)]
  Reserved 
}

任何尝试使用 Foo.Reserved 项进行编译的人都会收到错误

Answer 2

如果您不想显示它，则不要包含它：

public enum MyEnum
{
    ValueA = 0,
    ValueB = 1,
}

请注意，此枚举的用户仍然可以将任何整数值分配给声明为 MyEnum 的变量：

MyEnum e = (MyEnum)2;  // works!

这意味着接受枚举的方法应始终验证此值使用前输入：

void DoIt(MyEnum e)
{
    if (e != MyEnum.ValueA && e != MyEnum.ValueB)
    {
        throw new ArgumentException();
    }

    // ...
}

因此，只需稍后在需要时添加您的值，然后修改您的方法以接受它。

Answer 3

这在 C# 中是不可能的。如果 Enum 本身可访问，则所有枚举值都可访问。

模拟实现此目的的唯一方法是使用不易访问的静态字段，该字段使用 Enum 中尚未使用的整数值。

public enum MyEnum {
  ValueA = 0;
  ValueB = 1;
}

internal static class MyEnumEx {
  internal static MyEnum Reserved = (MyEnum)42;
}

我很好奇你为什么要这样做。无论您做什么，用户仍然可以提供 Reserved 值。需要做的就是将适当值的 int 转换为 MyEnum 类型。

// Code that shouldn't access Reserve
MyEnum reserved = (MyEnum)42;  // Woot!

Answer 4

如果要隐藏智能感知或 PropertyGrid 枚举成员，可以应用：

[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]

和

[System.ComponentModel.Browsable(false)]

示例：

  public enum MyEnum
  {
     A,

     B,
     [System.ComponentModel.Browsable(false)]
     [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]
     C
  }

C 不可见

Answer 5

您可以通过使用自己的自定义类型而不是枚举来实现类似的效果：

// This type works pretty much the same way an enum works;
// each specific value can be cast to/from an int, and each has
// a specific name that is returned on calling ToString().
public sealed class MyEnum
{
    private readonly int _value;
    private readonly string _name;

    // private constructor -- ensure that the static members you define below
    // are the only MyEnum instances accessible from any outside code
    private MyEnum(int value, string name)
    {
        _value = value;
        _name = name;
    }

    // no need to override Equals or GetHashCode, believe it or not --
    // one instance per value means we can use reference equality and
    // that should be just fine
    public override string ToString()
    {
        return _name;
    }

    // provide direct access only to these members
    public static readonly MyEnum ValueA = new MyEnum(0, "ValueA");
    public static readonly MyEnum ValueB = new MyEnum(1, "ValueB");

    // this member is only available to you within the current assembly
    internal static readonly MyEnum Reserved = new MyEnum(-1, "Reserved");
}

您甚至可以通过以下方式进一步模拟枚举值的行为 ：例如，重载 explicit 运算符以将 MyEnum 对象转换为 int 值（采纳 JaredPar 的建议，使用此运算符而不是 implicit） ）：

public static explicit operator MyEnum(int value)
{
    switch (value)
    {
        case 0:
            return ValueA;
        case 1:
            return ValueB;
        default:
            throw new InvalidCastException();
    }
}

public static explicit operator int(MyEnum value)
{
    return value._value;
}

Answer 6

我对枚举标志也有类似的问题，但我使用的解决方案应该在没有标志属性的情况下工作。

您可以创建两种枚举类型，一种用于保留值，另一种用于公共可用值。您可以将 HasFlag 与保留类型一起使用而无需强制转换，但赋值需要强制转换。

[Flags]
public enum MyEnumReserved {
   Income = 1,
   Expense = 2,
   Discretionary = 4,
   Critical = 8
}

[Flags]
public enum MyEnum {
   Income = MyEnumReserved.Income,
   DiscretionaryExpense = MyEnumReserved.Expense | MyEnumReserved.Discretionary,
   CriticalExpense = MyEnumReserved.Expense | MyEnumReserved.Critical
}

bool IsIncome(MyEnum val) => val.HasFlag(MyEnumReserved.Income);

...
MyEnum foo = (MyEnum)MyEnumReserved.Expense | (MyEnum)MyEnumReserved.Discretionary;

Answer 7

您无法隐藏它，但您可以添加注释，表明该值目前没有任何作用。否则，只需删除它并在添加支持时添加它，只要原始值不改变，这就不应该破坏依赖于它的任何其他代码。

Answer 8

您在内部使用“隐藏”值吗？如果不是：

public enum MyEnum
{
   ValueA = 0,
   ValueB = 1,
   //TODO: Reserved
}

定义未使用的变量不会带来任何好处。

Answer 9

实现此目的的一种方法是设置此变量 null 的值。
因此，当从 enum 调用它时，它将为 null。简而言之用户无法访问它的值。

public enum MyEnum
{
   ValueA = 0,
   ValueB = 1,

   Reserved.None
}