如何指定接口的实现者抛出的异常？

Question

我目前正在开发一个解决方案，并以一种能够强烈实现策略/提供商模式的方式对其进行设计。因此，该解决方案公开了许多接口并包含这些接口的默认实现，这些接口可以通过 DI 类型方法进行替换。

当主机应用程序使用许多这样的接口时，它期望处理可能发生的某些异常，例如 IDataRetriever 接口有一个方法 SomeDataType GetData(int timeout); 和主机可以处理一些自定义异常，例如 DataRetrievalTimeoutException 或 NetworkConnectionException。

我的问题是，标记接口类的最佳方法是什么，以便当开发人员实现它时，他们会知道应该抛出某些异常并由主机处理？

目前，我刚刚将异常 xml 标记添加到方法 xml 注释中 - 这是否足够？

Answer 1

XML 标记（以及您想要编写的任何其他文档）基本上是目前在“vanilla”.NET 中最接近的标记。

您可能需要查看代码契约，它可以让您使用契约注释您的界面，其中可以包括异常、先决条件ETC。

Answer 2

您不能在界面中。你可以在基类中。

public interface IFoo
{    
  /// <summary>
  /// Lol
  /// </summary>
  /// <exception cref="FubarException">Thrown when <paramref name="lol"> 
  /// is <c>null</c></exception>
  /// <remarks>Implementors, pretty please throw FE on lol 
  /// being null kthx</remarks>
  void Bar(object lol);
}

与

public abstract BaseFoo
{    
  /// <summary>
  /// Lol
  /// </summary>
  /// <exception cref="FubarException">Thrown when <paramref name="lol"> 
  /// is <c>null</c></exception>
  public void Bar(object lol)
  {
    if(lol == null)
      throw new FubarException();
    InnerBar(lol);
  }

  /// <summary>
  /// Handles execution of <see cref="Bar" />.
  /// </summary>
  /// <remarks><paramref name="lol"> is guaranteed non-<c>null</c>.</remarks>
  protected abstract void InnerBar(object lol);
}

Answer 3

我建议在接口中定义异常类，并指定不从这些异常派生的任何异常都不应被允许逃逸，除非 CPU 着火或存在其他此类严重情况（即使如此，有一个显式定义的 IWoozle.SystemCorruptionException ，这样如果 Pokemon 处理程序只是捕获、记录并抛出异常，日志将反映出至少有人认为该异常很重要）。

我认为 Microsoft 建议避免定义自定义异常类型是不幸的，因为这意味着没有干净的方法来区分 IEnumerator.MoveNext() 是否抛出 InvalidOperationException因为底层集合在枚举期间发生了更改，或者 IEnumerator.MoveNext() 的内部处理是否遇到 InvalidOperationException 并简单地让它冒泡到调用方。相反，如果 IEnumerator.MoveNext() 在前一种情况下抛出 IEnumerator.InvalidatedEnumeratorException，则任何转义的 InvalidOperationException 都必须代表后一种情况。

Answer 4

这不应该由实现该接口的类决定吗？

例如，如果我采用您的接口并使用 GetData 方法实现我自己的类，我可以从任何地方“获取”数据。假设它是一个 Web 服务，那么可能抛出的异常类型可能与我从本地文件系统“获取”数据时抛出的异常类型不同。

因此，在我的实现中，我将实现（并记录）特定于实现的那些异常，以便使用该实现的任何代码都可以处理它们。如何处理这些异常可能非常具体于实现，假设我在 Web 应用程序而不是桌面应用程序中使用它们。

Answer 5

我认为提供此信息的最佳方法是在为每个接口提供的 XML 文档中。在那里，您可以指定该方法抛出什么异常，以便主机可以处理该错误。

Answer 6

如果您不能支持通用基类，另一种策略是扩展方法实现。

public static void ThisMethodShouldThrow(this Iinterface obj)
{
     if(obj.ConditionToThrowIsMet) throw new...
}

这样做的好处是允许您不需要继承链。