在实现 IDisposable 的类上正确使用 Dispose 方法

Question

我今天正在处理一些使用 System.Net.Mail.MailMessage 类的代码，如下所示

public MailMessage CreateMessage(string fromAddress, string recipient)
{
    MailMessage message = new MailMessage(fromAddress, recipient);
    message.Subject = subject;
    message.Body = body;
    return message;
}

忽略此方法的琐碎性质，我收到编译器警告说

对象“消息”未一起处理 所有异常路径。称呼 对象上的 System.IDisposable.Dispose 'message' 在所有引用之前 超出范围。

这很有趣，因为编译器警告消息在超出范围之前不会被处理，但我假设返回对它的引用意味着虽然消息变量超出范围，但仍然是对底层对象，在这种情况下，我非常怀疑我是否想要处置它。

这让我有点困惑，因为警告消息的含义是您不应该归还一次性物品。情况确实如此还是这只是编译器警告发疯的情况？

Answer 1

此警告的含义是，如果该方法抛出异常（例如在 Subject setter 中），您可能会留下一个没有人引用的未处理的 MailMessage。

您应该通过以下方式来防止这种情况发生：

public MailMessage CreateMessage(string fromAddress, string recipient)
{
    MailMessage message = new MailMessage(fromAddress, recipient);
    try {
        message.Subject = subject;
        message.Body = body;
        return message;
    }
    catch {
        if (message != null) {
            message.Dispose();
        }
        throw;
    }
}

编译器没有任何措施阻止返回 IDisposable 实例:)

Answer 2

我见过的一种有时可能有用的模式是创建一个名为 DisposeWrapper的对象。它保存一个 T 类型的 IDisposable 对象，在构造函数中提供，并且支持两种方法：Keep 和 Dispose。调用 Dispose 而不调用 Keep 将会对包装的 IDisposable 调用 Dispose；调用 Keep 将阻止 Dispose 命中 IDisposable。

为了方便起见，拥有一个带有 DisposeWrapper通用工厂方法的静态非泛型 DisposeWrapper 类可能会很方便。允许编译器使用方法类型推断来推断包装类的类型。

因此，人们可以做类似的事情[我习惯了 vb 语法，而不是 c#，所以如果这不太正确，请道歉）：

{
  using(var wrapper = DisposeWrapper.Create(new SomeDisposableThing))
  {
    ... do some stuff with wrapper.Value;
    return wrapper.Keep();
  }
}

如果代码到达“returnwrapper.Keep();”，那么wrapper.Value将是已退回且未处理。如果代码退出Using语句而不调用wrapper.Keep，则wrapper.Value将被释放。

当编译器和工具坚持要求必须捕获代码在不清理 IDisposable 的情况下逃逸的所有可能方式时，有时会很烦人（特别是当 C# 中无法安全地使用具有 IDisposable 字段的字段初始值设定项时），但我认为包装 IDisposable 应该使编译器快乐的。

另一种模式是使用一个包含 IDisposable 列表的包装器，并使用通用方法在创建 IDisposable 时“注册”它们（该方法可以返回新的 IDisposable 作为其适当的类型）。这可能是在构造函数中使用的一个很好的模式；只需做一点工作，它也可以用于 vb.net 中的字段初始值设定项。