处理意外枚举值的首选方法是什么？

Question

假设我们有一个接受枚举值的方法。在此方法检查该值是否有效后，它会switches 覆盖可能的值。所以问题是，在验证值范围之后处理意外值的首选方法是什么？

例如：

enum Mood { Happy, Sad }

public void PrintMood(Mood mood)
{
    if (!Enum.IsDefined(typeof(Mood), mood))
    {
        throw new ArgumentOutOfRangeException("mood");
    }

    switch (mood)
    {
        case Happy: Console.WriteLine("I am happy"); break;
        case Sad:   Console.WriteLine("I am sad"); break;
        default: // what should we do here?
    }

处理default 案件的首选方法是什么？

• 留言// can never happen
• Debug.Fail()（或Debug.Assert(false)）
• throw new NotImplementedException()（或任何其他例外）
• 我没想到的其他方式

Answer 1

我猜上面的大部分答案都是正确的，但我不确定是否正确。

正确的答案是，你很少切换 OO 语言，这表明你做错了 OO。在这种情况下，它完美地表明您的 Enum 类存在问题。

您应该只调用 Console.WriteLine(mood.moodMessage())，并为每个状态定义 moodMessage。

如果添加了一个新状态——你的所有代码都应该自动适应，不会失败、抛出异常或需要更改。

编辑：对评论的回应。

在您的示例中，要成为“良好的 OO”，文件模式的功能将由 FileMode 对象控制。它可以包含一个委托对象，其“打开、读取、写入...”操作对于每个 FileMode 都不同，因此 File.open("name", FileMode.Create) 可以实现为（抱歉对不熟悉API）：

open(String name, FileMode mode) {
    // May throw an exception if, for instance, mode is Open and file doesn't exist
    // May also create the file depending on Mode
    FileHandle fh = mode.getHandle(name);
    ... code to actually open fh here...
    // Let Truncate and append do their special handling
    mode.setPosition(fh);
}

这比尝试使用开关来做这件事要简洁得多......（顺便说一下，这些方法既是包私有的，也可能委托给“模式”类）

当 OO 做得好时，每一个方法看起来都像是几行真正易懂、简单的代码——太简单了。你总是觉得有一个大杂乱的“奶酪核”把所有的小玉米片放在一起，但你永远找不到它——一直都是玉米片……

Answer 2

我更喜欢throw new NotImplementedException("Unhandled Mood: " + mood)。重点是以后枚举可能会发生变化，这个方法可能不会相应更新。抛出异常似乎是最安全的方法。

我不喜欢Debug.Fail() 方法，因为该方法可能是库的一部分，并且新值可能不会在调试模式下进行测试。在这种情况下，使用该库的其他应用程序可能会面临奇怪的运行时行为，而在引发异常的情况下，错误将立即被知晓。

注意：NotImplementedException 存在于 commons.lang 中。

Answer 3

在 Java 中，标准方法是抛出 AssertionError，原因有两个：

1. 这可确保即使 asserts 被禁用，也会引发错误。
2. 您断言没有其他枚举值，因此 AssertionError 比 NotImplementedException 更好地记录您的假设（Java 无论如何都没有）。

Answer 4

我的意见是，由于这是一个程序员错误，您应该对其进行断言或抛出 RuntimException（Java 或其他语言的等价物）。我有自己的 UnhandledEnumException，它从我用于此的 RuntimeException 扩展而来。

Answer 5

正确的程序响应应该是死，以使开发人员能够轻松发现问题。 mmyers 和 JaredPar 都提供了很好的方法来做到这一点。

为什么会死？这似乎太极端了！

原因是如果您没有正确处理枚举值而只是失败，那么您将程序置于意外状态。一旦你处于一个意想不到的状态，谁知道发生了什么。这可能会导致不良数据、难以追踪的错误，甚至是安全漏洞。

此外，如果程序死掉了，那么您在 QA 中发现它的机会就会大得多，因此它甚至不会被淘汰。

Answer 6

对于我的代码库中的几乎每个 switch 语句，我都有以下默认情况

switch( value ) { 
...
default:
  Contract.InvalidEnumValue(value);
}

该方法将在检测到错误时抛出一个详细说明枚举值的异常。

public static void InvalidEnumValue<T>(T value) where T: struct
{
    ThrowIfFalse(typeof(T).IsEnum, "Expected an enum type");
    Violation("Invalid Enum value of Type {0} : {1}", new object[] { typeof(T).Name, value });
}

Answer 7

对于 C#，值得了解的是 Enum.IsDefined() is dangerous。你不能像现在这样依赖它。得到不符合预期值的东西是抛出异常并大声死亡的好例子。

在 Java 中，情况有所不同，因为枚举是类而不是整数，因此您确实无法获得意外值（除非枚举已更新而您的 switch 语句未更新），这是我更喜欢 Java 枚举的一个重要原因。您还必须满足空值。但是得到一个你不认识的非空情况也是抛出异常的好例子。

Answer 8

您可以跟踪默认调用传递的枚举的值。抛出异常是可以的，但在大型应用程序中，您的代码会在多个地方不关心枚举的其他值。
因此，除非您确定代码打算处理枚举的所有可能值，否则您必须稍后返回并删除异常。

Answer 9

这是证明测试驱动开发为何如此重要的问题之一。

在这种情况下，我会选择 NotSupportedException，因为实际上该值未处理，因此不受支持。 NotImplementedException 提供了更多的想法：“这还没有完成”;)

调用代码应该能够处理这种情况，并且可以创建单元测试来轻松测试这种情况。

Answer 10

称之为意见或偏好，但枚举背后的想法是它代表可能值的完整列表。如果在代码中传递“意外值”，则枚举（或枚举背后的目的）不是最新的。我个人的偏好是每个枚举都带有一个未定义的默认分配。鉴于枚举是一个已定义的列表，它永远不会与您的消费代码过时。

就我而言，如果您的函数获得意外值或 Undefined 时该怎么办，似乎不可能给出通用答案。对我来说，这取决于评估枚举值的原因的上下文：是代码执行应该停止的情况，还是可以使用默认值？

Answer 11

提供有效输入是调用函数的责任，并且隐含地不在枚举中的任何内容都是无效的（实用程序员似乎暗示了这一点）。也就是说，这意味着每次更改枚举时，都必须更改接受它作为输入的所有代码（以及将其作为输出的一些代码）。但无论如何，这可能是真的。如果您有一个经常更改的枚举，则考虑到枚举通常是编译时实体，您可能应该使用枚举以外的其他东西。

Answer 12

我通常尝试定义未定义的值（0）：

enum Mood { Undefined = 0, Happy, Sad }

这样我总能说：

switch (mood)
{
    case Happy: Console.WriteLine("I am happy"); break;
    case Sad:   Console.WriteLine("I am sad"); break;
    case Undefined: // handle undefined case
    default: // at this point it is obvious that there is an unknown problem
             // -> throw -> die :-)
}

至少我通常是这样做的。