C＃創建壓縮文件

作者：sparkdev

原文：cnblogs.com/sparkdev/p/6826948.html

在程序中對文件進行壓縮解壓縮是很重要的功能，不僅能減小文件的體積，還能對文件起到保護作用。如果是生成用戶可以下載的文件，還可以極大的減少網路流量並提升下載速度。最近在一個 C# 項目中用到了創建壓縮文件的功能，在此和同學們分享一下使用心得。

SharpZipLib 庫

既然是很重要的用能，那麼如果每個人在使用的時候都去用基本的 API 去實現一遍顯然不符合效率至上的生產要求。作為比較有經驗的開發人員相信您一定會在第一時間去搜尋一款功能豐富，口碑良好的開源類庫來完成相關的工作。在 .NET 平台上，要操作壓縮文件的話您的第一選擇一定是 SharpZipLib。

SharpZipLib 是一個開源的基於 .NET 平台的壓縮、解壓縮類庫。特點是經過長期的開發和使用現在已經變得非常的穩定，可以放心的應用到產品中。下面我們就通過實例來介紹如何使用它在 C# 代碼中創建壓縮文件，以及一些常見問題的處理方法。

SharpZipLib 的下載請訪問這裡。編譯也很簡單，用 VisualStudio 打開直接編譯就能成功。如果您想全面的掌握 SharpZipLib 的使用方法，建議您直接去讀 SharpZipLib 的文檔，本文僅介紹基本的用法和一些使用心得。

基本壓縮操作

SharpZipLib 支持 Zip，Gzip，Tar，BZip2 等主流的壓縮格式。本文以 zip 格式做介紹，其它格式的用法也都差不太多。對於 zip 壓縮格式，創建壓縮文件時用到的類型主要為 ZipOutputStream 和 ZipEntry。下面通過幾個典型的用例來介紹它們的用法。

讀取硬碟上的文件並加入壓縮包

這可能是最簡單也最常見的用法了，直接上代碼：

//生成的壓縮文件為test.zip

using (FileStream fsOut = File.Create("test.zip"))

{

//ZipOutputStream類的構造函數需要一個流，文件流、內存流都可以，壓縮後的內容會寫入到這個流中。

using (ZipOutputStream zipStream = new ZipOutputStream(fsOut))

{

string fileName = @"G:vcredist_x86.exe";

FileInfo fi = new FileInfo(fileName);

//entryName就是壓縮包中文件的名稱。

string entryName = "vcredist_x86.exe";

//ZipEntry類代表了一個壓縮包中的一個項，可以是一個文件，也可以是一個目錄。

ZipEntry newEntry = new ZipEntry(entryName);

newEntry.DateTime = fi.LastWriteTime;

newEntry.Size = fi.Length;

//把壓縮項的信息添加到ZipOutputStream中。

zipStream.PutNextEntry(newEntry);

byte[] buffer = new byte[4096];

//把需要壓縮文件以文件流的方式複製到ZipOutputStream中。

using (FileStream streamReader = File.OpenRead(fileName))

{

StreamUtils.Copy(streamReader, zipStream, buffer);

}

zipStream.CloseEntry();

//添加多個文件

//如果要壓縮一個文件夾，就是通過遍歷添加文件夾下所有的文件

string fileName2 = @"G:shareweb.dll";

FileInfo fi2 = new FileInfo(fileName2);

//文件在壓縮包中的路徑

string entryName2 = "share\web.dll";

ZipEntry newEntry2 = new ZipEntry(entryName2);

newEntry2.DateTime = fi2.LastWriteTime;

newEntry2.Size = fi2.Length;

zipStream.PutNextEntry(newEntry2);

byte[] buffer2 = new byte[4096];

using (FileStream streamReader = File.OpenRead(fileName2))

{

StreamUtils.Copy(streamReader, zipStream, buffer2);

}

zipStream.CloseEntry();

//使用流操作時一定要設置IsStreamOwner為false。否則很容易發生在文件流關閉後的異常。

zipStream.IsStreamOwner = false;

zipStream.Finish();

zipStream.Close();

}

}

代碼並不複雜且添加了詳細的注釋，因此不再贅言。此時已經完成了把文件加入壓縮包的功能，壓縮包中的內容如下：

注意，web.dll 文件在 share 文件夾中。

把內存中的數據添加到壓縮包

有時我們要壓縮的對象並不是磁碟上的文件，而是內存中的數據。比如資料庫查詢操作的結果中有一些字元串，希望把這些字元串寫入到壓縮包中的文本文件中。當然可以先把這些字元串保存到磁碟上的文件中，然後再通過前面例子中的方法寫入壓縮包，這也可以完成任務，卻不是高效的方法。首先磁碟 IO 很慢也很昂貴，另外在一些 web 應用環境中你是沒有許可權寫文件的。這就要求我們直接把數據寫入到壓縮包中：

//我們有一個字元串，希望直接寫入到壓縮包中的City.csv文件中。

byte[] string1 = Encoding.UTF8.GetBytes("Washington,ShangHai,TianJin,DongJing");

using (FileStream fsOut = File.Create("test1.zip"))

{

using (ZipOutputStream zipStream = new ZipOutputStream(fsOut))

{

ZipEntry entry = new ZipEntry("City.csv");

entry.DateTime = DateTime.Now;

zipStream.PutNextEntry(entry);

//Write方法和前面用的StreamUtils.Copy方法差不多，不過這裡操作的是byte數組。

zipStream.Write(string1, 0, string1.Length);

zipStream.CloseEntry();

zipStream.IsStreamOwner = false;

zipStream.Finish();

zipStream.Close();

}

}

這次我們把內存中的一個字元串直接寫入了壓縮包中得 City.csv 文件。看上去還不錯，至少代碼看上去還算清爽。接下來看看我們還能幹些什麼？

把壓縮包保存在內存中

上面的例子中我們提到，有時是沒有許可權寫文件的，那還怎麼創建壓縮文件呀？太矛盾了！其實現實中還真有這樣的用例。比如你有一個網站，當用戶點擊下載按鈕時，你需要把數據保存到壓縮文件中然後返回給用戶。整個過程中你是寫不了文件的，只能通過操作內存來實現：

byte[] string1 = Encoding.UTF8.GetBytes("Washington,ShangHai,TianJin,DongJing");

byte[] result = null;

using (MemoryStream ms = new MemoryStream())

{

using (ZipOutputStream zipStream = new ZipOutputStream(ms))

{

ZipEntry entry = new ZipEntry("City.csv");

entry.DateTime = DateTime.Now;

zipStream.PutNextEntry(entry);

zipStream.Write(string1, 0, string1.Length);

zipStream.CloseEntry();

zipStream.IsStreamOwner = false;

zipStream.Finish();

zipStream.Close();

ms.Position = 0;

//壓縮後的數據被保存到了byte[]數組中。

result = ms.ToArray();

}

}

現在 byte 數組 result 中就是壓縮包的數據。如果希望通過 HttpResponse 返回給用戶，就可以通過調用 HttpResponse 的 BinaryWrite 方法實現，只要把 result 作為參數即可。

中文文件名的問題

在愉快的完成了創建壓縮文件的任務後該打開壓縮包看看我們生成的文件了！我們把前面的例子稍微改動一下：

byte[] string1 = Encoding.UTF8.GetBytes("Washington,ShangHai,TianJin,DongJing");

using (FileStream fsOut = File.Create("test1.zip"))

{

using (ZipOutputStream zipStream = new ZipOutputStream(fsOut))

{

//文件名變成了中文

ZipEntry entry = new ZipEntry("城市.csv");

entry.DateTime = DateTime.Now;

...

}

}

運行上面代碼生成 test1.zip，在資源管理器中打開 test1.zip。What？哪裡出錯了？為什麼壓縮包中什麼都沒有！

其實這是一個很典型的問題，當然也很容易解決！出問題的原因是因為我的操作系統是英文版的，並且我沒有告訴 ZipEntry 怎麼處理中文文件名」城市.csv」。原因找到了，那我們就明明白白的告訴 ZipEntry 怎麼處理文本：

entry.IsUnicodeText = true;

再試一次，城市 .csv 文件終於出現在了壓縮包中。好了，既然搞定了中文文件名，那麼日文文件名呀，xxx 文文件名呀都不在話下了…

總結

文件的壓縮與解壓縮本身是件比較複雜的事情，如果我們重複造輪子，可能實現這個功能的工作量會超過我們項目本身(筆者本次實現的只是一個很小的項目)。通過使用 SharpZipLib 類庫，筆者不僅愉快的完成了任務，還不用擔心壓縮文件的實現有bug(如果有也是SharpZipLib背鍋啊)。言歸正傳，我們通過幾個典型的用例介紹了使用 C# 和 SharpZipLib 創建壓縮文件的主要方式。並且分享了常見的文件名問題的處理方法，希望對朋友們有所幫助。

在微信公眾號內回複數字「1」

小編拉你進粉絲微信群

不是在文章評論里回復

喜歡這篇文章嗎？立刻分享出去讓更多人知道吧！