微信号:programmer_club

介绍:程序员第一自媒体,与你探讨码农人生路上遇到的各类泛技术话题,定期为你推荐码农人生思考、感悟以及启迪!

C# 创建压缩文件

2017-05-11 22:11 sparkdev

作者: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))

    {

        //准备把G盘根目录下的vcredist_x86.exe文件添加到压缩包中。

        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:\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();

        //使用流操作时一定要设置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”

小编拉你进粉丝微信群

不是在文章评论里回复

 
程序员之家 更多文章 10+年程序员总结的20+条经验教训 这 10 句话千万不要让程序猿听到! 如何成为一名更优秀的程序员? 为什么算法这么难? 如何做好项目管理任务分配?
猜您喜欢 世界这么大,你为什么不去走走 【译文】PostgreSQL9.5 给开发人员带来了什么? 使用PostgreSQL进行Redis的后台权限管理 NDK SO 库开发与使用中的 ABI 构架选择 CAP的相对论