从方法返回一次性对象时的CA2000

Question

我有一个工厂方法，可以构建实现IDisposable对象。 最终，调用者可以管理创建对象的生命周期。 这种设计引发了一堆CA2000错误 。 在我的设计中是否存在根本不正确的东西，是否需要重构，还是仅仅对静态代码分析警告过于兴奋？

工厂方法

public static DisposableType BuildTheDisposableType(string param1, int param2)
{
    var theDisposable = new DisposableType();

    // Do some work to setup theDisposable

    return theDisposable
}

来电者

using(var dt = FactoryClass.BuildTheDisposableType("data", 4))
{
   // use dt
}    

Answer 1

您应该将它存储到本地变量，并在try-catch-rethrow块中包装初始化，以防出现任何异常：

public MyDisposable CreateDisposable()
{
    var myDisposable = new MyDisposable();
    try
    {
        // Additional initialization here which may throw exceptions.
        ThrowException();
    }
    catch
    {
        // If an exception occurred, then this is the last chance to
        // dispose before the object goes out of scope.
        myDisposable.Dispose();
        throw;
    }
    return myDisposable;
}

当不调用Dispose时，尽量不要让一次性对象容易受到异常的影响

PS：有人先前提到过最终处理 - 这显然是错误的 - 在非异常路径中你不想调用Dispose

Answer 2

我建议您在每个单独的工厂方法上抑制CA2000警告，或者可能在包含它们的整个类上抑制CA2000警告（但仅当它是该类的唯一函数时）。

我进一步建议你包括一个理由：

[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Reliability",
    "CA2000:Dispose objects before losing scope",
    Justification = "This is a factory method. Caller must dispose")]

Answer 3

您收到错误是因为一次性对象的创建者没有管理它。 但是，设计没有任何根本性的错误。 你只是依靠消费者利用using 。 例如，与当前的ADO对象没有太大的不同。

Answer 4

另一种方法是将工厂方法更改为“配置”方法，并将创建一次性对象的责任放在客户端上。 例：

public void SetupDisosableThing(IDisposable foo)
{
 foo.Bar = "baz";
}

void Main()
{
  using (var x = new Thing())
  {
   SetupDisposableThing(x);
  }
}