为未处理的枚举值抛出的正确异常是什么？

Question

这是我的other question about unhandled cases with enums 的另一个案例，建议我将其作为一个单独的问题提出。

假设我们有 SomeEnum 并有一个 switch 语句来处理它：

enum SomeEnum
{
  One,
  Two
}

void someFunc()
{
  SomeEnum value = someOtherFunc();
  switch(value)
  {
     case One:
       ... break;
     case Two:
       ... break;
     default:
         throw new ??????Exception("Unhandled value: " + value.ToString());    
  }
}

如您所见，我们处理所有可能的枚举值，但仍保留默认值，以防添加新成员时抛出异常，并且我们希望确保我们知道丢失的处理。

我的问题是：在您想要通知给定代码路径未处理/实现或不应该访问的情况下，正确的例外是什么？我们曾经使用NotImplementedException，但它似乎并不合适。我们的下一个候选人是InvalidOperationException，但这个词听起来不太对。什么是正确的，为什么？

Answer 1

尝试使用InvalidEnumArgumentException Class

void someFunc()
{
  SomeEnum value = someOtherFunc();
  switch(value)
  {
     case One:
       ... break;
     case Two:
       ... break;
     default:
          throw new InvalidEnumArgumentException(); 
  }
}

Answer 2

我认为这取决于枚举所代表的语义。

InvalidOperationException 表示对象状态时是合适的。

NotSupportedException 表示不受支持的应用程序功能时是合适的。

NotImplementedException 适用于当前未实现但可能在未来版本中实现的应用程序功能。

...

Answer 3

开关盒的 ReSharper 命题：

switch(parameter)
{
   default:
      throw new ArgumentOutOfRangeException("parameter");
}

但它可能不符合您的需求，在这种情况下，您可以定义一个自定义异常类型，了解在此函数中执行的操作：SomeEnumOutOfRangeException...

Answer 4

由于这是一个失败的内部操作（产生无效的东西），InvalidOperationException 是要走的路。

文档只是说：

当方法调用对于对象的当前状态无效时引发的异常。

这很合适，因为对象的当前状态导致someOtherFunc的返回值无效，因此应该首先避免调用someFunc。

Answer 5

这种情况实际上是合同失败，不一定特定于枚举。如果你不能使用代码契约，你可以创建自己的异常类型并抛出它。

case One:
   ... break;
 case Two:
   ... break;
 default:
    throw new ContractViolationException("Invalid enum");

Answer 6

如果添加了一个新值而您忘记在某处处理它，则这是一个编程错误，或者 Eric Lippert 称之为Boneheaded Exception。我创建了自己的 BoneheadedException 类，每当我检测到没有 FCL 异常类型更适合的编程错误时，我都会抛出该类。

Answer 7

我会说 NotImplementedException 因为您正在为未实现的枚举值抛出异常。

Answer 8

就我个人而言，我在我的项目中添加了一个自定义异常：

public class UnexpectedEnumValueException<T> : Exception
{
    public UnexpectedEnumValueException( T value )
        : base( "Value " + value + " of enum " + typeof( T ).Name + " is not supported" )
    {
    }
}

那么我可以根据需要使用它：

enum SomeEnum
{
  One,
  Two
}

void someFunc()
{
  SomeEnum value = someOtherFunc();
  switch(value)
  {
   case SomeEnum.One:
    ... break;
   case SomeEnum.Two:
    ... break;
   default:
      throw new UnexpectedEnumValueException<SomeEnum>(value);    
  }
}

这样，我可以搜索“UnexpectedEnumValueException”，例如，当我向 SomeEnum 添加新值并且我想查找所有可能受更改影响的地方时。错误消息比一般异常要清楚得多。

Answer 9

在这种情况下，我尝试使用字典而不是 switch 语句。 （一般来说，像这样的映射最好用字典来定义；我几乎认为switch 语句会自动产生代码气味，因为总是或几乎总是有更好的方法来组织这样的映射。）

如果您使用字典，那么如果您尝试使用尚未计算的值来索引您的字典，您将得到一个 KeyNotFoundException，并且不再有理由问“我该怎么办在默认情况下？”。

Answer 10

这些天我写了两个自定义异常：UnexpectedValueException 和 UnexpectedTypeException。在我看来，这些都是非常有价值的例外，因为一旦您发现发生了意外（即假定不存在）值或类型，您就应该抛出尽可能有意义的消息。

class UnexpectedValueException : Exception {
   public UnexpectedValueException(object pValue)
   : base($"The value '{pValue}' of type '{pValue?.GetType().ToString() ?? "<null>"}' was not expected to exist.") {
   }
}

enum SomeEnum {
   One,
   Two,
   Three
}

void someFunc() {
   SomeEnum value = someOtherFunc();

   switch (value) {
      case One: ... break;
      case Two: ... break;
      default: throw new UnexpectedValueException(value);    
   }
}

Answer 11

我决定使用的是ArgumentOutOfRangeException，带有一个自定义错误消息，灵感来自InvalidEnumArgumentException 的默认消息（我不喜欢使用它，因为它在 System.ComponentModel 中）：

参数“{nameof(theArgument)}”({theArgument}) 的值对于枚举类型“{nameof(TheEnumType)}”无效。

这是它的样子：

return level switch
{
    LogEventLevel.Verbose => "VERBOSE",
    LogEventLevel.Debug => "DEBUG",
    LogEventLevel.Information => "INFO",
    LogEventLevel.Warning => "WARN",
    LogEventLevel.Error => "ERROR",
    LogEventLevel.Fatal => "FATAL",
    _ => throw new ArgumentOutOfRangeException(nameof(level), level,
        $"The value of argument '{nameof(level)}' ({level}) is invalid for enum type '{nameof(LogEventLevel)}'.")
};