C#壓縮庫SharpZipLib的應用

   SharpZipLib是一個開源的C#壓縮解壓庫，應用非常廣泛。就像用ADO.NET操作數據庫要打開連接、執行命令、關閉連接等多個步驟一樣，用SharpZipLib進行壓縮和解壓也需要多個步驟。除了初學者會用原始的方法做一步一步完成，實際開發的時候都會進行更易用的封裝。這里分享我對SharpZipLib的封裝，支持對文件和字節進行壓縮和解壓操作，支持多個文件和文件夾壓縮，支持設置備注和密碼。（文章源網址：http://www.cnblogs.com/conexpress/p/SharpZipClass.html）

    SharpZipLib的官方地址是：http://icsharpcode.github.io/SharpZipLib/，實際使用可以通過NuGet獲取，在NuGet的地址是：http://www.nuget.org/packages/SharpZipLib/

 

在Visual Studio中可以通過NuGet程序包管理控制台輸入命令PM> Install-Package SharpZipLib或者用NuGet管理界面搜索並安裝。

我把使用SharpZipLib的方法卸載一個類里面，作為靜態方法調用，免去創建類的麻煩。其中核心壓縮和解壓文件的方法代碼如下：

        /// <summary>
        /// 壓縮多個文件/文件夾
        /// </summary>
        /// <param name="sourceList">源文件/文件夾路徑列表</param>
        /// <param name="zipFilePath">壓縮文件路徑</param>
        /// <param name="comment">注釋信息</param>
        /// <param name="password">壓縮密碼</param>
        /// <param name="compressionLevel">壓縮等級，范圍從0到9，可選，默認為6</param>
        /// <returns></returns>
        public static bool CompressFile(IEnumerable<string> sourceList, string zipFilePath,
             string comment = null, string password = null, int compressionLevel = 6)
        {
            bool result = false;

            try
            {
                //檢測目標文件所屬的文件夾是否存在，如果不存在則建立
                string zipFileDirectory = Path.GetDirectoryName(zipFilePath);
                if (!Directory.Exists(zipFileDirectory))
                {
                    Directory.CreateDirectory(zipFileDirectory);
                }

                Dictionary<string, string> dictionaryList = PrepareFileSystementities(sourceList);

                using (ZipOutputStream zipStream = new ZipOutputStream(File.Create(zipFilePath)))
                {
                    zipStream.Password = password;//設置密碼
                    zipStream.SetComment(comment);//添加注釋
                    zipStream.SetLevel(CheckCompressionLevel(compressionLevel));//設置壓縮等級

                    foreach (string key in dictionaryList.Keys)//從字典取文件添加到壓縮文件
                    {
                        if (File.Exists(key))//判斷是文件還是文件夾
                        {
                            FileInfo fileItem = new FileInfo(key);

                            using (FileStream readStream = fileItem.Open(FileMode.Open,
                                FileAccess.Read, FileShare.Read))
                            {
                                ZipEntry zipEntry = new ZipEntry(dictionaryList[key]);
                                zipEntry.DateTime = fileItem.LastWriteTime;
                                zipEntry.Size = readStream.Length;
                                zipStream.PutNextEntry(zipEntry);
                                int readLength = 0;
                                byte[] buffer = new byte[BufferSize];

                                do
                                {
                                    readLength = readStream.Read(buffer, 0, BufferSize);
                                    zipStream.Write(buffer, 0, readLength);
                                } while (readLength == BufferSize);

                                readStream.Close();
                            }
                        }
                        else//對文件夾的處理
                        {
                            ZipEntry zipEntry = new ZipEntry(dictionaryList[key] + "/");
                            zipStream.PutNextEntry(zipEntry);
                        }
                    }

                    zipStream.Flush();
                    zipStream.Finish();
                    zipStream.Close();
                }

                result = true;
            }
            catch (System.Exception ex)
            {
                throw new Exception("壓縮文件失敗", ex);
            }

            return result;
        }

        /// <summary>
        /// 解壓文件到指定文件夾
        /// </summary>
        /// <param name="sourceFile">壓縮文件</param>
        /// <param name="destinationDirectory">目標文件夾，如果為空則解壓到當前文件夾下</param>
        /// <param name="password">密碼</param>
        /// <returns></returns>
        public static bool DecomparessFile(string sourceFile, string destinationDirectory = null, string password = null)
        {
            bool result = false;

            if (!File.Exists(sourceFile))
            {
                throw new FileNotFoundException("要解壓的文件不存在", sourceFile);
            }

            if (string.IsNullOrWhiteSpace(destinationDirectory))
            {
                destinationDirectory = Path.GetDirectoryName(sourceFile);
            }

            try
            {
                if (!Directory.Exists(destinationDirectory))
                {
                    Directory.CreateDirectory(destinationDirectory);
                }

                using (ZipInputStream zipStream = new ZipInputStream(File.Open(sourceFile, FileMode.Open,
                    FileAccess.Read, FileShare.Read)))
                {
                    zipStream.Password = password;
                    ZipEntry zipEntry = zipStream.GetNextEntry();

                    while (zipEntry != null)
                    {
                        if (zipEntry.IsDirectory)//如果是文件夾則創建
                        {
                            Directory.CreateDirectory(Path.Combine(destinationDirectory,
                                Path.GetDirectoryName(zipEntry.Name)));
                        }
                        else
                        {
                            string fileName = Path.GetFileName(zipEntry.Name);
                            if (!string.IsNullOrEmpty(fileName) && fileName.Trim().Length > 0)
                            {
                                FileInfo fileItem = new FileInfo(Path.Combine(destinationDirectory, zipEntry.Name));
                                using (FileStream writeStream = fileItem.Create())
                                {
                                    byte[] buffer = new byte[BufferSize];
                                    int readLength = 0;

                                    do
                                    {
                                        readLength = zipStream.Read(buffer, 0, BufferSize);
                                        writeStream.Write(buffer, 0, readLength);
                                    } while (readLength == BufferSize);

                                    writeStream.Flush();
                                    writeStream.Close();
                                }
                                fileItem.LastWriteTime = zipEntry.DateTime;
                            }
                        }
                        zipEntry = zipStream.GetNextEntry();//獲取下一個文件
                    }

                    zipStream.Close();
                }
                result = true;
            }
            catch (System.Exception ex)
            {
                throw new Exception("文件解壓發生錯誤", ex);
            }

            return result;
        }

壓縮方法CompressFile中sourceList是路徑數組，支持文件夾和文件的路徑。當遇到文件夾時會自動將下級文件和文件夾包含，並會檢測重復項。文件路徑處理的方法如下：

        /// <summary>
        /// 為壓縮准備文件系統對象
        /// </summary>
        /// <param name="sourceFileEntityPathList"></param>
        /// <returns></returns>
        private static Dictionary<string, string> PrepareFileSystementities(IEnumerable<string> sourceFileEntityPathList)
        {
            Dictionary<string, string> fileEntityDictionary = new Dictionary<string, string>();//文件字典
            string parentDirectoryPath = "";
            foreach (string fileEntityPath in sourceFileEntityPathList)
            {
                string path = fileEntityPath;
                //保證傳入的文件夾也被壓縮進文件
                if (path.EndsWith(@"\"))
                {
                    path = path.Remove(path.LastIndexOf(@"\"));
                }

                parentDirectoryPath = Path.GetDirectoryName(path) + @"\";

                if (parentDirectoryPath.EndsWith(@":\\"))//防止根目錄下把盤符壓入的錯誤
                {
                    parentDirectoryPath = parentDirectoryPath.Replace(@"\\", @"\");
                }

                //獲取目錄中所有的文件系統對象
                Dictionary<string, string> subDictionary = GetAllFileSystemEntities(path, parentDirectoryPath);

                //將文件系統對象添加到總的文件字典中
                foreach (string key in subDictionary.Keys)
                {
                    if (!fileEntityDictionary.ContainsKey(key))//檢測重復項
                    {
                        fileEntityDictionary.Add(key, subDictionary[key]);
                    }
                }
            }
            return fileEntityDictionary;
        }

        /// <summary>
        /// 獲取所有文件系統對象
        /// </summary>
        /// <param name="source">源路徑</param>
        /// <param name="topDirectory">頂級文件夾</param>
        /// <returns>字典中Key為完整路徑，Value為文件(夾)名稱</returns>
        private static Dictionary<string, string> GetAllFileSystemEntities(string source, string topDirectory)
        {
            Dictionary<string, string> entitiesDictionary = new Dictionary<string, string>();
            entitiesDictionary.Add(source, source.Replace(topDirectory, ""));

            if (Directory.Exists(source))
            {
                //一次性獲取下級所有目錄，避免遞歸
                string[] directories = Directory.GetDirectories(source, "*.*", SearchOption.AllDirectories);
                foreach (string directory in directories)
                {
                    entitiesDictionary.Add(directory, directory.Replace(topDirectory, ""));
                }

                string[] files = Directory.GetFiles(source, "*.*", SearchOption.AllDirectories);
                foreach (string file in files)
                {
                    entitiesDictionary.Add(file, file.Replace(topDirectory, ""));
                }
            }

            return entitiesDictionary;
        }

除了支持文件和文件夾壓縮解壓，還提供了對字節的壓縮解壓方法：

        /// <summary>
        /// 壓縮字節數組
        /// </summary>
        /// <param name="sourceBytes">源字節數組</param>
        /// <param name="compressionLevel">壓縮等級</param>
        /// <param name="password">密碼</param>
        /// <returns>壓縮后的字節數組</returns>
        public static byte[] CompressBytes(byte[] sourceBytes, string password = null, int compressionLevel = 6)
        {
            byte[] result = new byte[] { };

            if (sourceBytes.Length > 0)
            {
                try
                {
                    using (MemoryStream tempStream = new MemoryStream())
                    {
                        using (MemoryStream readStream = new MemoryStream(sourceBytes))
                        {
                            using (ZipOutputStream zipStream = new ZipOutputStream(tempStream))
                            {
                                zipStream.Password = password;//設置密碼
                                zipStream.SetLevel(CheckCompressionLevel(compressionLevel));//設置壓縮等級

                                ZipEntry zipEntry = new ZipEntry("ZipBytes");
                                zipEntry.DateTime = DateTime.Now;
                                zipEntry.Size = sourceBytes.Length;
                                zipStream.PutNextEntry(zipEntry);
                                int readLength = 0;
                                byte[] buffer = new byte[BufferSize];

                                do
                                {
                                    readLength = readStream.Read(buffer, 0, BufferSize);
                                    zipStream.Write(buffer, 0, readLength);
                                } while (readLength == BufferSize);

                                readStream.Close();
                                zipStream.Flush();
                                zipStream.Finish();
                                result = tempStream.ToArray();
                                zipStream.Close();
                            }
                        }
                    }
                }
                catch (System.Exception ex)
                {
                    throw new Exception("壓縮字節數組發生錯誤", ex);
                }
            }

            return result;
        }

        /// <summary>
        /// 解壓字節數組
        /// </summary>
        /// <param name="sourceBytes">源字節數組</param>
        /// <param name="password">密碼</param>
        /// <returns>解壓后的字節數組</returns>
        public static byte[] DecompressBytes(byte[] sourceBytes, string password = null)
        {
            byte[] result = new byte[] { };

            if (sourceBytes.Length > 0)
            {
                try
                {
                    using (MemoryStream tempStream = new MemoryStream(sourceBytes))
                    {
                        using (MemoryStream writeStream = new MemoryStream())
                        {
                            using (ZipInputStream zipStream = new ZipInputStream(tempStream))
                            {
                                zipStream.Password = password;
                                ZipEntry zipEntry = zipStream.GetNextEntry();

                                if (zipEntry != null)
                                {
                                    byte[] buffer = new byte[BufferSize];
                                    int readLength = 0;

                                    do
                                    {
                                        readLength = zipStream.Read(buffer, 0, BufferSize);
                                        writeStream.Write(buffer, 0, readLength);
                                    } while (readLength == BufferSize);

                                    writeStream.Flush();
                                    result = writeStream.ToArray();
                                    writeStream.Close();
                                }
                                zipStream.Close();
                            }
                        }
                    }
                }
                catch (System.Exception ex)
                {
                    throw new Exception("解壓字節數組發生錯誤", ex);
                }
            }
            return result;
        }

為了測試該類，我寫了一個WinForm程序，界面如下：

可以將文件和文件夾拖放到壓縮列表中，選中壓縮列表中的對象可以按Delete鍵進行刪除。文件解壓區域也可以將要解壓的文件拖放到文件路徑輸入文本框。實際測試可以正確壓縮和解壓，包括設置密碼，壓縮和解壓操作和WinRAR完全兼容。如果您在代碼中發現問題或有可以優化完善的地方，歡迎指出，謝謝！

程序源代碼下載：http://files.cnblogs.com/files/conexpress/SharpZipTest.zip

 

參考資料：

http://www.cnblogs.com/kissdodog/p/3525295.html

http://www.cnblogs.com/xuanye/archive/2011/10/19/2217211.html