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

时间:2013-12-06 20:08:48

标签: c# code-analysis idisposable ca2000

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

工厂方法

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
}    

4 个答案:

答案 0 :(得分:16)

您应该将它存储到局部变量,并在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

答案 1 :(得分:10)

我建议您在每个单独的工厂方法上抑制CA2000警告,或者在包含它们的整个类上禁止CA2000警告(但仅当这是该类的唯一功能时)。

我进一步建议您加入理由:

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

答案 2 :(得分:2)

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

答案 3 :(得分:0)

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

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

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