一种选择是在调试模式下进行几乎方法合同检查。为美观的表单添加一个扩展方法:
[Conditional("DEBUG")]
public static bool AssertIsValid(this System.Enum value)
{
if (!System.Enum.IsDefined(value.GetType(), value))
throw new EnumerationValueNotSupportedException(value.GetType(), value); //custom exception
}
我想它可能只有在调试模式下才能通过你的开发/测试环境和单元测试,并且在生产中没有开销(尽管这取决于你)
public string GetCallingCode(Guid countryId)
{
var country = GetCountry(countryId);
country.AssertIsValid(); //throws if the country is not defined
switch (country)
{
case Country.UnitedStates:
return "1";
case Country.Mexico:
return "52";
}
}
我建议尽管这实际上是您的GetCountry
方法的责任。它应该识别出countryId
无效并抛出异常。
无论如何,这也应该被您的单元测试所捕获,或者以某种方式更好地处理。无论您在何处将字符串/int 转换为枚举,都应该由一个单一的方法处理,该方法反过来可以检查/抛出(就像任何Parse
方法一样),并有一个检查所有有效数字的单元测试。
一般来说,我不认为各种ArgumentExceptions
(等等)是一个很好的候选,因为有几个条件(非参数)案例。我认为如果您将检查代码移动到一个位置,您不妨抛出自己的异常,该异常可以准确地传达给任何正在监听的开发人员。
编辑:考虑到讨论,我认为这里有两个特殊情况。
案例 1:将底层类型转换为等效枚举
如果您的方法采用某种类型的输入数据(字符串、整数、Guid?),则执行转换为枚举的代码应该验证您是否有一个可用的实际枚举。这就是我在上面的答案中发布的情况。在这种情况下,可能会抛出您自己的异常或可能InvalidEnumArgumentException
.
这应该像任何标准输入验证一样对待。在您的系统中的某个地方,您正在提供垃圾输入,因此请像处理任何其他解析机制一样处理它。
var country = GetCountry(countryId);
switch (country)
{
case Country.UnitedStates:
return "1";
case Country.Mexico:
return "52";
}
private Country GetCountry(Guid countryId)
{
//get country by ID
if (couldNotFindCountry)
throw new EnumerationValueNotSupportedException(.... // or InvalidEnumArgumentException
return parsedCountry;
}
编辑:当然,编译器要求你的方法抛出/返回,所以不太确定你应该在这里做什么。我想这取决于你。如果确实发生了这种情况,那可能是一个愚蠢的异常(下面的案例 2),因为您通过了输入验证但没有更新开关/案例来处理新值,所以也许应该这样做throw new BoneheadedException()
;
案例 2:添加一个新的枚举值,您的代码中的 switch/case 块不处理该值
如果您是代码的所有者,这属于 Eric Lippert 在@NominSim 的回答中描述的“Boneheaded”异常。尽管这实际上根本不会导致异常,同时使程序处于异常/无效状态。
最好的方法可能是在您对枚举执行 switch/case(或类似操作)运行的任何地方,您应该考虑编写一个单元测试,自动针对枚举的所有定义值运行该方法。因此,如果你懒惰或不小心错过了一个块,你的单元测试会警告你,你没有更新一个方法来解释你的枚举列表的变化。
最后,如果您的枚举来自您没有意识到他们更新了值的第 3 方,您应该编写一个快速的单元测试来验证您的所有预期值。因此,如果您编写程序时检查UnitedStates
and Mexico
,那么您的单元测试应该只是这些值的 switch/case 块并抛出异常,否则会在/如果它们最终添加时警告您Canada
。当更新 3rd 方库后该测试失败时,您知道必须在哪里/在哪里进行更改才能兼容。
因此,在这个“案例 2”中,您应该抛出任何您想要的旧异常,因为只要它准确地向您或您的单元测试的消费者传达缺少的内容,它将由您的单元测试处理。
在任何一种情况下,我都不认为 switch/case 代码应该过分关心无效输入并且不在那里抛出异常。它们应该在设计时抛出(通过单元测试)或在验证/解析输入时抛出(因此抛出适当的“解析/验证”异常)
编辑:我偶然发现了Eric Lippert 的一篇文章,其中讨论了 C# 编译器如何检测具有返回值的方法是否在没有返回的情况下达到其“终点”。编译器擅长保证端点有时是不可达的,但在上述情况下,我们的开发人员知道它是不可达的(除非在上面提到的情况下BoneheadedExceptions
发挥作用)。
没有讨论的内容(至少我看到了)作为开发人员应该做什么来解决这些情况。编译器要求您提供返回值或抛出异常,即使您知道它永远不会到达该代码。在这种情况下,谷歌搜索并没有神奇地出现一些可以利用的异常(尽管我无法找出好的搜索词),我宁愿抛出一个异常并被告知我认为它无法到达终点的假设是不正确的,而不是返回一些可能不会通知我问题或导致不良行为的值。在这种情况下,也许某种UnexpectedCodePathFailedToReturnValueException
形式是最有效的。当我有时间时,我会做更多的挖掘,也许会发布一个关于程序员的问题争取一些讨论。