代码分析友好的方式来处理对象

Question

作为 Visual Studio 2010（主要是 C# 4.0）开发标准的一部分，我们启用了代码分析。当我审查最近提交的新项目代码时，我看到大量

CA2000：Microsoft.Reliability：在方法“XYZ”中，对象“ABC”不是 沿着所有异常路径进行处理。调用 System.IDisposable.Dispose 对象“ABC”，然后对它的所有引用都超出范围。

警告。问题是，我所做的一切似乎都无法消除这些警告——而且我花了几个小时在网上搜索并尝试了一切可能的方法。

首先，让我明确一点，我并不是在谈论放置一个简单的 using 块来正确处理局部变量 - 这不是问题。就我而言，当对象由方法返回或分配给方法内的另一个对象时，就会出现这些警告。

下面是包含四个此类警告的代码示例：

public void MainMethod()
{
    var object1 = CreateFirstObject();    // Warning here
    var object2 = CreateSecondObject();   // Warning here

    SomeCollectionProperty.Add(object1);
    SomeCollectionProperty.Add(object2);
}

private SomeObject CreateFirstObject()
{
    var theObject = new SomeObject()      // Warning here
    {
        FirstProperty = "some value",
        // ...
    };

    return theObject;
}

private SomeOtherObject CreateSecondObject()
{
    var theObject = new SomeOtherObject() // Warning here
    {
        FirstProperty = "a different value",
        // ...
    };

    return theObject;
}

我已对出现警告的行进行了注释。

我已尝试按照 MSDN 文章（此处）中所述重构这两种 Create 方法，但出现警告仍然出现。

更新 我应该注意到 SomeObject 和 SomeOtherObject 都实现了 IDisposable。

另外，虽然对象初始值设定项可能是问题的一个组成部分，但请记住，初始值设定项与两个私有方法隔离，并且与 MainMethod 中的警告无关。

谁能告诉我如何正确实施这些方法来消除 CA2000 警告？

Answer 1

在这种情况下，CA2000 检测到的问题是，如果在将一次性实例传递出方法之前发生异常，则一次性实例可能会“孤立”。例如，CreateFirstObject 的“正确”实现将如下所示：

private SomeObject CreateFirstObject()
{
    var theObject = new SomeObject();
    try
    {
        theObject.FirstProperty = "some value";
    }
    catch
    {
        theObject.Dispose();
        throw;
    }

    return theObject;
}

---

鉴于您所描述的有关 MainMethod 所需行为的内容，其“正确”实现可能如下所示：

public void MainMethod()
{
    var object1 = CreateFirstObject();
    try
    {
        SomeCollectionProperty.Add(object1);

        var object2 = CreateSecondObject();
        try
        {
            SomeCollectionProperty.Add(object2);
        }
        catch
        {
            object2.Dispose();
            throw;
        }
    }
    catch
    {
        object1.Dispose();
        SomeCollectionProperty.Remove(object1); // Not supposed to throw if item does not exist in collection.

        throw;
    }
}

Answer 2

消除警告的一种方法是在代码中抑制它：

[SuppressMessage(
    "Microsoft.Reliability",
    "CA2000:DisposeObjectsBeforeLosingScope",
    Justification = "Factory method")]

但这并不是问题的真正解决方案。

此处描述了解决方案：如何所有权转移时摆脱 CA2000 警告？

在提到的链接中，基本上说明了将对象添加到实现的集合中ICollection，但我还没有测试过。

Answer 3

如果将 main 中返回的对象包装在 using 块中，或者实现finally 来处理这些对象，会发生什么？

SomeOtherObjects 是否需要实现 IDisposable？

Answer 4

需要的是实现类似于“using”块的模式，但在成功返回对象的情况下禁用对象的处置。 Nicole Calinoiu 提供的方法是合理的，尽管我更喜欢避免捕获只会冒泡的异常。考虑到 C# 语言的限制，我首选的代码表达是使用 InitializedSuccessively 标志，然后有一个“finally”块，负责在尚未调用 InitializedSuccessively 时进行处理。

如果一个类将包含许多 IDisposable 对象，并且一旦构造完成，这些对象的集合将被固定，那么定义一个 IDisposable 管理器类来保存 IDisposable 对象的列表可能会很有用。让类的构造函数接受 DisposableManager 对象作为参数，并将其构造的所有对象放入由此生成的列表中（对于您的类来说，拥有一个实例方法可能会有所帮助：

T regDisposable<T>RegDispose(T newThing) where T:IDisposable
{
  myDisposableManager.Add(newThing);
  return newThing;
}

要在 myDisposableManager 初始化之后使用它，简单地说：var someDisposableField = RegDispose(new someDisposableType());这样的模式将提供两大好处：

1. 主类在其 Dispose 实现中必须执行的所有操作都将完成。是 `if (myDisposableManager != null) myDisposableManager.Dispose();` 在构造函数中设置 IDisposable 对象的行为（使用 RegDispose）也将提供其清理。
2. 如果构造函数抛出异常，则调用主对象构造函数的代码可以调用它创建并传入的 DisposableManager 对象上的 Dispose 方法。这将确保及时清理部分创建的对象，否则这一切都将发生。但不可能。

在 vb 中，基类构造函数可以将构造函数参数公开为可供字段初始值设定项使用的字段。因此，我们可以在字段初始值设定项以及显式构造函数中很好地使用 RegDispose 模式。在 C# 中这是不可能的。可以使用 [threadstatic] 字段来达到此目的，但需要注意一些以确保设置的任何此类字段也会被取消设置。从线程池线程之类的内部调用构造函数可能会产生内存泄漏。此外，线程静态字段的访问效率几乎无法与普通字段一样高，而且我不知道 C# 中有什么方法可以避免必须多次重新获取线程静态字段——每个注册的 IDisposable 对象一次。

Answer 5

我们使用的模式大多数时候会清除警告，

DisposableObject retVal;
DisposableObject tempVal;

try{
  tempVal = new DisposableObject();
  tempVal.DoStuff();
  retVal = tempVal;
  tempVal = null;
} finally{
  if (tempVal != null) { tempVal.Dispose();} //could also be writtent tempVal?.Dispose();
}

return retVal;

不幸的是，仍然存在某些情况下警告不会消失，因此我们会在本地删除警告，并给出理由说一次性用品已被覆盖有图案。

微软文档。