【问题标题】:Creating property which may throw IndexOutOfRangeException创建可能引发 IndexOutOfRangeException 的属性
【发布时间】:2012-06-25 00:41:51
【问题描述】:

我有一个包含项目集合的类。为方便起见,我提供了由

实现的 GetCurrentItem
public Type GetCurrentItem
{
     get { return this.items[this.items.Count - 1]; }  
}

如果列表中没有项目,则会抛出异常。

我应该让异常被抛出还是应该返回null?如果这是我交给你的 API,你会期待什么?异常还是空?有没有更好的方法来处理这个?

【问题讨论】:

  • 哪个是正确的 API:Enumerable.Single 或 Enumerable.SingleOrDefault? (答案:视情况而定)

标签: c# api-design


【解决方案1】:

至于哪个更正确?正如柯克的评论所暗示的:这取决于。有时null 具有逻辑意义,有时如果没有合理的默认值,则异常更适合。我尝试做的一件事是考虑“调用GetCurrentItem 是逻辑上的失败还是安全的事情?”

如果在没有调用GetCurrentItem的情况下调用失败,那么抛出异常是正确的做法。例如,如果您的集合具有HasCurrent 或IsEmpty 属性,有人可以在调用GetCurrentItem 之前检查结果,那么他们应该“知道得更好”。但是,如果当前项目是 null 是使用您的类的正确逻辑方式,那么一定要以这种方式设计它。无论哪种方式,我都会在代码 cmets 中记录行为,让用户知道预期的行为。

不过我会这么说,暴露ArgumentOutOfRange 异常可能会影响实现细节。也就是说,如果这个类的用户不知道内部结构是一个数组或List<T>,那么不要放出那个异常,而是捕获它,包装它,然后抛出一个更有意义的(自定义,或类似InvalidOperationException)。

由于他们并没有真正直接传递参数,因此他们收到ArgumentOutOfRange 异常可能会令人困惑:-)

【讨论】:

  • 一个不错的例外选择是InvalidOperationException,遵循Stack<T>.Peek()设置的示例。
  • @MichaelLiu:是的,同意。正如您评论的那样,我在编辑中添加了它:-)
【解决方案2】:

异常应该用于异常情况。如果 CurrentItem 可以为 null,则不应引发异常。我不明白为什么没有 CurrentItem 是例外。

【讨论】:

    【解决方案3】:

    让它抛出一个错误。这就是其他集合的工作方式。应该由用户应用程序来处理潜在的异常(尤其是在使用集合时)。可能应该有一个bool HasSelection() 方法,用户可以在继续之前调用它。

    【讨论】:

      【解决方案4】:

      接下来的问题是您是否希望 GetCurrentItem 返回一个安全值。如果 Type 可以为空,则 GetCurrentItem 应该在没有当前项目时返回 null。如果您总是希望列表不为空并且总是默认选择某些内容,那么抛出一个有意义的异常。

      您通常不应该抛出异常,除非您的案例确实是异常而不是正常的用例。然而,这可能是相当主观的。

      【讨论】:

        【解决方案5】:

        我尝试从用户的角度来考虑它。去Principal of Least Astonishment。

        如果我正在使用库或对象并调用 GetCurrentItem 并抛出 IndexOutOfRangeException,我会想,“我没有调用任何带有索引的东西,我想要当前项目。”因此,我的建议是返回 null,这会让我想,“哦,没有当前项目。”

        或者,如果属性是一个索引器,并且我想在某个索引处获取一个项目,我不会对 IndexOutOfRangeException 感到惊讶。

        【讨论】:

          【解决方案6】:

          如果此 GetCurrentItem 对您的 API 有意义,我会在没有项目时抛出“InvalidOperationException”。如果允许 null 作为有效结果,您可能希望以不同的方式命名它。

          考虑现有的LINQ Last 方法是否已经提供了相同的功能。

          【讨论】:

            【解决方案7】:

            如有疑问,请遵循 .NET。此功能类似于 List.Last(),如果为空则抛出异常。

            http://msdn.microsoft.com/en-us/library/bb358775

            【讨论】:

              猜你喜欢
              • 1970-01-01
              • 1970-01-01
              • 1970-01-01
              • 1970-01-01
              • 2013-04-03
              • 2020-04-28
              • 1970-01-01
              • 2019-10-28
              • 1970-01-01
              相关资源
              最近更新 更多