C#創(chuàng)建壓縮文件的實(shí)現(xiàn)代碼
在程序中對(duì)文件進(jìn)行壓縮解壓縮是很重要的功能,不僅能減小文件的體積,還能對(duì)文件起到保護(hù)作用。如果是生成用戶可以下載的文件,還可以極大的減少網(wǎng)絡(luò)流量并提升下載速度。最近在一個(gè) C# 項(xiàng)目中用到了創(chuàng)建壓縮文件的功能,在此和同學(xué)們分享一下使用心得。
SharpZipLib 庫(kù)
既然是很重要的用能,那么如果每個(gè)人在使用的時(shí)候都去用基本的 API 去實(shí)現(xiàn)一遍顯然不符合效率至上的生產(chǎn)要求。作為比較有經(jīng)驗(yàn)的開發(fā)人員相信您一定會(huì)在第一時(shí)間去搜尋一款功能豐富,口碑良好的開源類庫(kù)來完成相關(guān)的工作。在 .NET 平臺(tái)上,要操作壓縮文件的話您的第一選擇一定是 SharpZipLib。SharpZipLib 是一個(gè)開源的基于 .NET 平臺(tái)的壓縮、解壓縮類庫(kù)。特點(diǎn)是經(jīng)過長(zhǎng)期的開發(fā)和使用現(xiàn)在已經(jīng)變得非常的穩(wěn)定,可以放心的應(yīng)用到產(chǎn)品中。下面我們就通過實(shí)例來介紹如何使用它在 C# 代碼中創(chuàng)建壓縮文件,以及一些常見問題的處理方法。SharpZipLib 的下載請(qǐng)?jiān)L問這里。編譯也很簡(jiǎn)單,用 VisualStudio 打開直接編譯就能成功。如果您想全面的掌握 SharpZipLib 的使用方法,建議您直接去讀 SharpZipLib 的文檔,本文僅介紹基本的用法和一些使用心得。
基本壓縮操作
SharpZipLib 支持 Zip,Gzip,Tar,BZip2 等主流的壓縮格式。本文以 zip 格式做介紹,其它格式的用法也都差不太多。對(duì)于 zip 壓縮格式,創(chuàng)建壓縮文件時(shí)用到的類型主要為 ZipOutputStream 和 ZipEntry。下面通過幾個(gè)典型的用例來介紹它們的用法。
讀取硬盤上的文件并加入壓縮包
這可能是最簡(jiǎn)單也最常見的用法了,直接上代碼:
//生成的壓縮文件為test.zip using (FileStream fsOut = File.Create("test.zip")) { //ZipOutputStream類的構(gòu)造函數(shù)需要一個(gè)流,文件流、內(nèi)存流都可以,壓縮后的內(nèi)容會(huì)寫入到這個(gè)流中。 using (ZipOutputStream zipStream = new ZipOutputStream(fsOut)) { //準(zhǔn)備把G盤根目錄下的vcredist_x86.exe文件添加到壓縮包中。 string fileName = @"G:\vcredist_x86.exe"; FileInfo fi = new FileInfo(fileName); //entryName就是壓縮包中文件的名稱。 string entryName = "vcredist_x86.exe"; //ZipEntry類代表了一個(gè)壓縮包中的一個(gè)項(xiàng),可以是一個(gè)文件,也可以是一個(gè)目錄。 ZipEntry newEntry = new ZipEntry(entryName); newEntry.DateTime = fi.LastWriteTime; newEntry.Size = fi.Length; //把壓縮項(xiàng)的信息添加到ZipOutputStream中。 zipStream.PutNextEntry(newEntry); byte[] buffer = new byte[4096]; //把需要壓縮文件以文件流的方式復(fù)制到ZipOutputStream中。 using (FileStream streamReader = File.OpenRead(fileName)) { StreamUtils.Copy(streamReader, zipStream, buffer); } zipStream.CloseEntry(); //添加多個(gè)文件 //如果要壓縮一個(gè)文件夾,就是通過遍歷添加文件夾下所有的文件 string fileName2 = @"G:\share\web.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(); //使用流操作時(shí)一定要設(shè)置IsStreamOwner為false。否則很容易發(fā)生在文件流關(guān)閉后的異常。 zipStream.IsStreamOwner = false; zipStream.Finish(); zipStream.Close(); } }
代碼并不復(fù)雜且添加了詳細(xì)的注釋,因此不再贅言。此時(shí)已經(jīng)完成了把文件加入壓縮包的功能,壓縮包中的內(nèi)容如下:
注意,web.dll 文件在 share 文件夾中。
把內(nèi)存中的數(shù)據(jù)添加到壓縮包
有時(shí)我們要壓縮的對(duì)象并不是磁盤上的文件,而是內(nèi)存中的數(shù)據(jù)。比如數(shù)據(jù)庫(kù)查詢操作的結(jié)果中有一些字符串,希望把這些字符串寫入到壓縮包中的文本文件中。當(dāng)然可以先把這些字符串保存到磁盤上的文件中,然后再通過前面例子中的方法寫入壓縮包,這也可以完成任務(wù),卻不是高效的方法。首先磁盤 IO 很慢也很昂貴,另外在一些 web 應(yīng)用環(huán)境中你是沒有權(quán)限寫文件的。這就要求我們直接把數(shù)據(jù)寫入到壓縮包中:
//我們有一個(gè)字符串,希望直接寫入到壓縮包中的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數(shù)組。 zipStream.Write(string1, 0, string1.Length); zipStream.CloseEntry(); zipStream.IsStreamOwner = false; zipStream.Finish(); zipStream.Close(); } }
這次我們把內(nèi)存中的一個(gè)字符串直接寫入了壓縮包中得 City.csv 文件??瓷先ミ€不錯(cuò),至少代碼看上去還算清爽。接下來看看我們還能干些什么?
把壓縮包保存在內(nèi)存中
上面的例子中我們提到,有時(shí)是沒有權(quán)限寫文件的,那還怎么創(chuàng)建壓縮文件呀?太矛盾了!其實(shí)現(xiàn)實(shí)中還真有這樣的用例。比如你有一個(gè)網(wǎng)站,當(dāng)用戶點(diǎn)擊下載按鈕時(shí),你需要把數(shù)據(jù)保存到壓縮文件中然后返回給用戶。整個(gè)過程中你是寫不了文件的,只能通過操作內(nèi)存來實(shí)現(xiàn):
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; //壓縮后的數(shù)據(jù)被保存到了byte[]數(shù)組中。 result = ms.ToArray(); } }
現(xiàn)在 byte 數(shù)組 result 中就是壓縮包的數(shù)據(jù)。如果希望通過 HttpResponse 返回給用戶,就可以通過調(diào)用 HttpResponse 的 BinaryWrite 方法實(shí)現(xiàn),只要把 result 作為參數(shù)即可。
中文文件名的問題
在愉快的完成了創(chuàng)建壓縮文件的任務(wù)后該打開壓縮包看看我們生成的文件了!我們把前面的例子稍微改動(dòng)一下:
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; ... } }
運(yùn)行上面代碼生成 test1.zip,在資源管理器中打開 test1.zip。What?哪里出錯(cuò)了?為什么壓縮包中什么都沒有!
其實(shí)這是一個(gè)很典型的問題,當(dāng)然也很容易解決!出問題的原因是因?yàn)槲业牟僮飨到y(tǒng)是英文版的,并且我沒有告訴 ZipEntry 怎么處理中文文件名”城市.csv”。原因找到了,那我們就明明白白的告訴 ZipEntry 怎么處理文本:
entry.IsUnicodeText = true;
再試一次,城市 .csv 文件終于出現(xiàn)在了壓縮包中。好了,既然搞定了中文文件名,那么日文文件名呀,xxx 文文件名呀都不在話下了…
總結(jié)
文件的壓縮與解壓縮本身是件比較復(fù)雜的事情,如果我們重復(fù)造輪子,可能實(shí)現(xiàn)這個(gè)功能的工作量會(huì)超過我們項(xiàng)目本身(筆者本次實(shí)現(xiàn)的只是一個(gè)很小的項(xiàng)目)。通過使用 SharpZipLib 類庫(kù),筆者不僅愉快的完成了任務(wù),還不用擔(dān)心壓縮文件的實(shí)現(xiàn)有bug(如果有也是SharpZipLib背鍋啊)。言歸正傳,我們通過幾個(gè)典型的用例介紹了使用 C# 和 SharpZipLib 創(chuàng)建壓縮文件的主要方式。并且分享了常見的文件名問題的處理方法,希望對(duì)朋友們有所幫助。
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
C#中數(shù)據(jù)的傳遞以及ToolStripProgressBar
本文主要介紹了C#的數(shù)據(jù)傳遞方法以及ToolStripProgressBar進(jìn)度條的使用。希望對(duì)大家有所幫助,話不多說,請(qǐng)看下面代碼2016-11-11C#簡(jiǎn)單實(shí)現(xiàn)發(fā)送socket字符串
這篇文章主要為大家詳細(xì)介紹了C#簡(jiǎn)單實(shí)現(xiàn)socket字符串發(fā)送,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2018-09-09C#8.0 中開啟默認(rèn)接口實(shí)現(xiàn)方法
這篇文章主要介紹了C#8.0 中開啟默認(rèn)接口實(shí)現(xiàn)方法,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧的相關(guān)資料2019-05-05使用C#編寫簡(jiǎn)單的圖形化的可發(fā)送附件的郵件客戶端程序
這篇文章主要介紹了使用C#編寫一個(gè)圖形化的可發(fā)送附件的郵件客戶端程序的方法,文中的示例同樣是基于支持smtp協(xié)議的郵件服務(wù)器,需要的朋友可以參考下2016-02-02