此代码的正确 IDisposable 实现

Question

我有以下代码

public static byte[] Compress(byte[] CompressMe)
{
    using (MemoryStream ms = new MemoryStream())
    {
        using (GZipStream gz = new GZipStream(ms, CompressionMode.Compress,true))
        {
            gz.Write(CompressMe, 0, CompressMe.Length);
            ms.Position = 0;
            byte[] Result = new byte[ms.Length];
            ms.Read(Result, 0, (int)ms.Length);
            return Result;
        }
    }
}

这工作正常，但是当我对其运行代码分析时，它会显示以下消息

CA2202 : Microsoft.Usage : Object 'ms' can be disposed more than once in 
method 'Compression.Compress(byte[])'. To avoid generating a 
System.ObjectDisposedException you should not call Dispose more than one 
time on an object.

就我而言，当 GZipStream 被处置时，它会使底层流（毫秒）保持打开状态，因为到构造函数的最后一个参数（leaveOpen=true）。

如果我稍微改变我的代码..删除 MemoryStream 周围的“using”块并将“leaveOpen”参数更改为 false..

public static byte[] Compress(byte[] CompressMe)
{
    MemoryStream ms = new MemoryStream();
    using (GZipStream gz = new GZipStream(ms, CompressionMode.Compress, false))
    {
        gz.Write(CompressMe, 0, CompressMe.Length);
        ms.Position = 0;
        byte[] Result = new byte[ms.Length];
        ms.Read(Result, 0, (int)ms.Length);
        return Result;
    }
}

然后就会出现..

CA2000 : Microsoft.Reliability : In method 'Compression.Compress(byte[])',
object 'ms' is not disposed along all exception paths. Call 
System.IDisposable.Dispose on object 'ms' before all references to 
it are out of scope.

我无法获胜..（除非我错过了一些明显的东西）我尝试过各种事情，比如在块周围放置一个 try/finally ，以及在那里处置 MemoryStream，但它要么说我要处置它两次，要么根本不处置！

Answer 1

除了处理问题之外，您的代码也被破坏了。您应该在读回数据之前关闭 zip 流。

另外，MemoryStream 上已经有一个 ToArray() 方法，无需自己实现。

using (MemoryStream ms = new MemoryStream())
{
    using (GZipStream gz = new GZipStream(ms, CompressionMode.Compress,true))
    {
        gz.Write(CompressMe, 0, CompressMe.Length);
    }
    return ms.ToArray();
}

我只是抑制警告，因为它是误报。代码分析是为您服务的，而不是相反。

Answer 2

来自 MSDN 中的此页面

Stream stream = null;

try
{
    stream = new FileStream("file.txt", FileMode.OpenOrCreate);
    using (StreamWriter writer = new StreamWriter(stream))
    {
        stream = null;
        // Use the writer object...
    }
}
finally
{
    if(stream != null)
        stream.Dispose();
}

这是一次尝试...终于您的解决方案中缺少导致第二条消息的信息。

如果：

GZipStream gz = new GZipStream(ms, CompressionMode.Compress, false)

失败，则不会处理该流。

Answer 3

实际上，在内存流上有效地调用两次 dispose 不会导致任何问题，在 MemoryStream 类中以及在 Microsoft 的测试中对此进行编码很容易。因此，如果您不想抑制该规则，另一种选择是将您的方法分成两部分：

    public static byte[] Compress(byte[] CompressMe)
    {
        using (MemoryStream ms = new MemoryStream())
        {
            return Compress(CompressMe, ms);
        }
    }

    public static byte[] Compress(byte[] CompressMe, MemoryStream ms)
    {
        using (GZipStream gz = new GZipStream(ms, CompressionMode.Compress, true))
        {
            gz.Write(CompressMe, 0, CompressMe.Length);
            ms.Position = 0;
            byte[] Result = new byte[ms.Length];
            ms.Read(Result, 0, (int)ms.Length);
            return Result;
        }
    }

Answer 4

这有时是运行代码分析的问题，有时你根本无法获胜，你必须选择两害相权取其轻。

在这种情况下，我相信正确的实施是第二个例子。为什么？根据.NET Reflector，GZipStream.Dispose()的实现将处理GZipStream 拥有 MemoryStream 为您提供MemoryStream。

下面是 GZipStream 类的相关部分：

public GZipStream(Stream stream, CompressionMode mode, bool leaveOpen)
{
    this.deflateStream = new DeflateStream(stream, mode, leaveOpen, true);
}

protected override void Dispose(bool disposing)
{
    try
    {
        if (disposing && (this.deflateStream != null))
        {
            this.deflateStream.Close();
        }
        this.deflateStream = null;
    }
    finally
    {
        base.Dispose(disposing);
    }
}

由于您不想完全禁用该规则，因此您可以仅使用 CodeAnalysis.SupressMessage 属性来抑制此方法。

[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Reliability ", "CA2000:?", Justification = "MemoryStream will be disposed by the GZipStream.")]

注意：您需要填写完整的规则名称（即 CA2000:?），因为我从您发布的错误消息中不知道它是什么。

HTH，

编辑：

@CodeInChaos：

更深入地了解实现 DeflateStream.Dispose 我相信它仍然会为您处理 MemoryStream，而不管 leftOpen 选项如何，因为它调用 base。 Dispose()。

编辑 忽略上面关于 DeflateStream.Dispose 的内容。我正在查看 Reflector 中的错误实现。详情请参阅评论。

Answer 5

你必须走老路：

public static byte[] Compress(byte[] CompressMe)
{
    MemoryStream ms = null;
    GZipStream gz = null;
    try
    {
        ms = new MemoryStream();
        gz = new GZipStream(ms, CompressionMode.Compress, true);
        gz.Write(CompressMe, 0, CompressMe.Length);
        gz.Flush();
        return ms.ToArray();
    }
    finally
    {
        if (gz != null)
        {
            gz.Dispose();
        }
        else if (ms != null)
        {
            ms.Dispose();
        }
    }
}

我知道这看起来很糟糕，但这是平息警告的唯一方法。

就我个人而言，我不喜欢编写这样的代码，因此只需在 Dispose 调用应该是幂等的基础上抑制多个 dispose 警告（在适用的情况下）（在本例中就是如此）。