正确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布置，它留下底层的流（MS）开放，由于构造函数（leaveOpen = TRUE）的最后一个参数。

如果我稍微改变我的代码..去掉周围的MemoryStream的“使用”块，改变“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 /终于各地块，并在那里将MemoryStream的处置，但也不说，我处置它两次，或根本不！

Answer 1

也就是说有时运行CodeAnalysis这个问题，你有时你根本无法赢得，你必须选择不幸中之大幸™。

在这种情况下，我认为正确的实施是第二个例子。为什么？据.NET Reflector的GZipStream.Dispose()实施将处置的MemoryStream你作为GZipStream拥有的的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我相信它仍然会为你不管处置leaveOpen选项的MemoryStream的，因为它会调用base.Dispose()。

编辑忽略上述约DeflateStream.Dispose。我在Reflector中查看错误的实现。详情请参阅评论。

Answer 2

从this page in the 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

你必须去老同学：

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(); 
     } 
    } 
} 

看起来可怕，我知道，不过是为了安抚警告的唯一途径。

就个人而言，我不喜欢写这样的代码，所以只是抑制多重处置是处置呼叫应幂等的（并且是在这种情况下）的基础上，警告（如适用）。

Answer 4

从处置问题

除此之外，你的代码也被打破。在读回数据之前，您应该关闭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 5

实际上，在内存流中有效地调用两次处理不会导致任何问题，在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; 
     } 
    }