Question

我正在使用基于Enum值的简单switch语句编写一些代码。在我看来，在将来某个时候开发人员可能会添加一个新值，所以我在运行时包含了一个默认方法来捕获它并抛出异常。但是我意识到每次输入这样的逻辑时我都应该这样做，而且我只会在运行时看到这些问题而不是编译时间。
我想知道是否有一些代码我可以添加以使编译器告诉开发人员他们需要在更新枚举值的情况下更新某些方法 - 除了向枚举本身添加注释之外？

e.g。（以下示例纯粹是理论上的;我选择了开发生命周期中的状态，以确保它对大多数人来说都是熟悉的。）

public enum DevelopmentStatusEnum
{
    Development
    //, QA //this may be added at some point in the future (or any other status could be)
    , SIT
    , UAT
    , Production
}

    public class Example
    {
        public void ExampleMethod(DevelopmentStatusEnum status)
        {
            switch (status)
            {
                case DevelopmentStatusEnum.Development: DoSomething(); break;
                case DevelopmentStatusEnum.SIT: DoSomething(); break;
                case DevelopmentStatusEnum.UAT: DoSomething(); break;
                case DevelopmentStatusEnum.Production: DoSomething(); break;
                default: throw new StupidProgrammerException(); //I'd like the compiler to ensure that this line never runs, even if a programmer edits the values available to the enum, alerting the program to add a new case statement for the new enum value
            }
        }
        public void DoSomething() { }
    }
    public class StupidProgrammerException: InvalidOperationException { }

这有点学术性，但我可以看到它有助于使我的应用程序健壮。有没有人在此之前尝试过这个/如何实现这个目标？

提前致谢，

JB

Answer 1

在这种情况下，我会尝试不使用枚举，而是使用具有公共静态只读字段的类，这些字段是类的实例。例如，查看.Net框架对颜色的作用。有一个类Color，你可以使用Color.Black，Color.Blue等对象。它们不是常量，但提供几乎所有相同的好处。此外，他们还有常量不具备的其他好处。请参阅C＃版本3语言规范，该规范也谈到了这一点。

但是这个想法是你没有案例陈述。您为每个“枚举”成员添加了足够的其他属性，方法（DoSomething或其他）可以正确处理它。当另一个开发人员想要添加另一个成员对象时，他需要提供所需的属性。我的例子：我需要一个“枚举”来表示用户可以在系统中执行的不同操作。需要检查这些操作的权限，记录等。我还需要父和子操作（重命名某些内容是“编辑它的一部分”等），用于将操作分组以用于过滤目的的抽象操作，以及特殊操作“所有“和”无“（没有未定义）。每个人都需要数据库中的ID和文本。如果某人发明了一种新的动作，我希望它仍然有效。我所做的就是这样（为了给你这个想法，省略了许多代码）：

  public class Action
  {
    protected Action(bool Abstract, Action Parent, int ID, string Name, bool Undefined)
    { /* snip */ }
    protected Action(bool Abstract, Action Parent, int ID, string Name)
      : this(Abstract, Parent, ID, Name, false)
    { }
    //----------------------------------------------------------------------------------------
    public static readonly Action All = new Action(true, null, 0, "All");
    public static readonly Action None = new Action(false, All, 6, "(Undefined)", true);
    public static readonly Action Modifying = new Action(true, All, 1, "Modifying");
    public static readonly Action Creating = new Action(false, Modifying, 2, "Creating");
    public static readonly Action Deleting = new Action(false, Modifying, 3, "Deleting");
    public static readonly Action Editing = new Action(false, Modifying, 4, "Editing");
    public static readonly Action Exporting = new Action(false, All, 5, "Exporting");
    public static readonly Action Renaming = new Action(false, Editing, 7, "Renaming");
    /* snip */
    //----------------------------------------------------------------------------------------
    /* template for new entries:
    public static readonly Action  = new Action(false, All, , "");
    */
  }

还有更多动作。并且在其他类中有许多方法可以对操作进行操作。只要每个操作都提供所需的信息，它们都会继续工作。添加动作的开发人员被迫提供信息。如果当前属性不足以进行某些未来的“特殊”操作，则必须在以后添加更多属性。请注意，构造函数是受保护的，因此只有类本身才能创建操作。我在主构造函数中省略了很多代码，用于检查重复的ID和名称以及许多其他内容。您现在可以像这样使用它：

Log.LogAction(Action.Renaming);

LogAction方法中没有case语句。它使用动作的属性。

你的枚举是什么？

此致

Answer 2

我找到了使用普通枚举的“解决方案”。原来，也许它可以用更好的设计来改进：

bool allCasesHandled;

switch (myEnumValue)
{
    case MyEnum.Value1:
        allCasesHandled = true;
        break;

    //default:
    //  allCasesHandled = true;
    //  break;
}
System.Diagnostics.Debug.WriteLine(allCasesHandled);

如果您尝试编译它，您将收到错误'使用未分配的变量'。

维护起来有点麻烦，但对于简单的情况，它可能很有用，特别是对于意图失败的行的注释。

Answer 3

我可能错了，但我不认为，编译器提供了这样的警告。您可以通过一些单元测试来捕获此类问题，这些单元测试会调用上述方法以及所有可能的枚举值（对此使用Enum.GetValues()）。每次开发人员添加枚举成员并忘记修改所有switch语句时，至少有一个单元测试会因“StupidProgrammerException”失败（顺便说一句：我会抛出ArgumentOutOfRangeException）。

Answer 4

我认为你可以为StyleCop编写规则并在PostBuild事件中运行它们，并且它们可以在Build窗口中输出警告。我们开始尝试这一段时间来添加警告以忽略方法的返回值，但从来没有完成它。最后我调查了一下，你需要分析IL，这并不总是很有趣。当然，我想这取决于你对乐趣的定义。

C＃确保有效的枚举值 - Futureproof方法

4 个答案: