1. 程式人生 > 實用技巧 >C# 壓縮、解壓資料夾或檔案(帶密碼)

C# 壓縮、解壓資料夾或檔案(帶密碼)

今天梳理一下專案中用到的壓縮、解壓資料夾或檔案的方法,發現因為需求不同,已經用了好幾個不同元件。今天就好好整理記錄下,別下次遇到需求又重頭開始了。

DotNetZip

DotNetZip是一個開源的免費類庫,主要提供了快速操作zip檔案的工具集,VB、C#任何.Net語言都可以通過它建立、解壓縮zip檔案。我使用該類庫最主要的目的還是因為它可以建立帶密碼保護的壓縮檔案

只有設定了zip.Password = "password"之後,被壓縮的檔案才會有密碼保護

/// <summary>
/// 壓縮檔案/資料夾
/// </summary>
/// <param name="filePath">需要壓縮的檔案/資料夾路徑</param>
/// <param name="zipPath">壓縮檔案路徑(zip字尾)</param>
/// <param name="password">密碼</param>
/// <param name="filterExtenList">需要過濾的檔案字尾名</param>
public static void CompressionFile(string filePath, string zipPath, string password = "", List<string> filterExtenList = null)
{
    try
    {
        using (ZipFile zip = new ZipFile(Encoding.UTF8))
        {
            if (!string.IsNullOrWhiteSpace(password))
            {
                zip.Password = password;
            }
            if (Directory.Exists(filePath))
            {
                if (filterExtenList == null)
                    zip.AddDirectory(filePath);
                else
                    AddDirectory(zip, filePath, filePath, filterExtenList);
            }
            else if (File.Exists(filePath))
            {
                zip.AddFile(filePath,"");
            }
            zip.Save(zipPath);
        }
    }
    catch (Exception ex)
    {
        throw ex;
    }
}

/// <summary>
/// 新增資料夾
/// </summary>
/// <param name="zip">ZipFile物件</param>
/// <param name="dirPath">需要壓縮的資料夾路徑</param>
/// <param name="rootPath">根目錄路徑</param>
/// <param name="filterExtenList">需要過濾的檔案字尾名</param>
public static void AddDirectory(ZipFile zip, string dirPath, string rootPath, List<string> filterExtenList)
{
    var files = Directory.GetFiles(dirPath);
    for (int i = 0; i < files.Length; i++)
    {
        //如果Contains不支援第二個引數,就用.ToLower()
        if (filterExtenList == null || (filterExtenList != null && !filterExtenList.Any(d => Path.GetExtension(files[i]).Contains(d, StringComparison.OrdinalIgnoreCase))))
        {
            //獲取相對路徑作為zip檔案中目錄路徑
            zip.AddFile(files[i], Path.GetRelativePath(rootPath, dirPath));
            
	    //如果沒有Path.GetRelativePath方法,可以用下面程式碼替換
            //string relativePath = Path.GetFullPath(dirPath).Replace(Path.GetFullPath(rootPath), "");
            //zip.AddFile(files[i], relativePath);
        }
    }
    var dirs = Directory.GetDirectories(dirPath);
    for (int i = 0; i < dirs.Length; i++)
    {
        AddDirectory(zip, dirs[i], rootPath, filterExtenList);
    }
}

SharpCompress

SharpCompress是用到現在,感覺功能最強大的壓縮、解壓開源外掛。它支援處理zip、rar、7z等多種格式的壓縮檔案,使用方式也很簡單。當然,最讓我難受的是建立壓縮檔案的時候沒法設定密碼~所以才有了上面DotnetZip的程式碼。

SharpCompress版本不同,設定ArchiveEncoding的方式也不同,預設設定了UTF8防止解壓亂碼。
通過設定ArchiveType切換生成不同格式壓縮檔案

/// <summary>
/// 壓縮檔案/資料夾
/// </summary>
/// <param name="filePath">需要壓縮的檔案/資料夾路徑</param>
/// <param name="zipPath">壓縮檔案路徑(zip字尾)</param>
/// <param name="filterExtenList">需要過濾的檔案字尾名</param>
public static void CompressionFile(string filePath, string zipPath, List<string> filterExtenList = null)
{
    try
    {
        using (var zip = File.Create(zipPath))
        {
            var option = new WriterOptions(CompressionType.Deflate)
            {
                ArchiveEncoding = new SharpCompress.Common.ArchiveEncoding()
                {
                    Default = Encoding.UTF8
                }
            };
            using (var zipWriter = WriterFactory.Open(zip, ArchiveType.Zip, option))
            {
                if (Directory.Exists(filePath))
                {
                    //新增資料夾
                    zipWriter.WriteAll(filePath, "*",
                        (path) => filterExtenList == null ? true : !filterExtenList.Any(d => Path.GetExtension(path).Contains(d, StringComparison.OrdinalIgnoreCase)), SearchOption.AllDirectories);
                }
                else if (File.Exists(filePath))
                {
                    zipWriter.Write(Path.GetFileName(filePath), filePath);
                }
            }
        }
    }
    catch (Exception ex)
    {
        throw ex;
    }
}
/// <summary>
/// 解壓檔案
/// </summary>
/// <param name="zipPath">壓縮檔案路徑</param>
/// <param name="dirPath">解壓到資料夾路徑</param>
/// <param name="password">密碼</param>
public static void DeCompressionFile(string zipPath, string dirPath, string password = "")
{
    if (!File.Exists(zipPath))
    {
        throw new ArgumentNullException("zipPath壓縮檔案不存在");
    }
    Directory.CreateDirectory(dirPath);
    try
    {
        using (Stream stream = File.OpenRead(zipPath))
        {
            var option = new ReaderOptions()
            {
                ArchiveEncoding = new SharpCompress.Common.ArchiveEncoding()
                {
                    Default = Encoding.UTF8
                }
            };
            if (!string.IsNullOrWhiteSpace(password))
            {
                option.Password = password;
            }

            var reader = ReaderFactory.Open(stream, option);
            while (reader.MoveToNextEntry())
            {
                if (reader.Entry.IsDirectory)
                {
                    Directory.CreateDirectory(Path.Combine(dirPath, reader.Entry.Key));
                }
                else
                {
                     //建立父級目錄,防止Entry檔案,解壓時由於目錄不存在報異常
                     var file = Path.Combine(dirPath, reader.Entry.Key);
                     Directory.CreateDirectory(Path.GetDirectoryName(file));
                     reader.WriteEntryToFile(file);
                }
            }
        }
    }
    catch (Exception ex)
    {
        throw ex;
    }
}

總結

相似的外掛還有SharpZipLib(支援更多的壓縮格式)、SevenZipSharp(專注處理7z格式壓縮檔案)等,它們也都有各自的優缺點。但總的來說,上面的兩個元件已經滿足日常工作中的大部分需求,遇到相同問題的朋友可以參考下~