前言
在开发Android应用过程中,基本都会遇到需要压缩文件的需求,比如打包日志文件上传等功能,今天就来看看如何开发一个通用的工具类用于压缩文件或文件夹。
压缩文件
用java来压缩文件主要就是使用java.util.zip包下的类,首先就是要创建一个ZipOutputStream对象,如下
val fos = FileOutputStream(dist)
val zos = ZipOutputStream(fos)
这里dist是生成压缩包的文件路径,是File类型的。
然后需要新建一个条目,即ZipEntry对象,如下:
val entry = ZipEntry(String(src.name.toByteArray(Charsets.ISO_8859_1),Charset.forName("GB2312")))
ZipEntry的构造函数需要一个条目名称,这里src是要压缩的文件,所以条目名称就用这个文件的文件名,当然也可以自定义一个,但是一般都是用原文件名称即可。并且这个名称可以看到经过了转码,这是为了防止出现乱码的情况。
然后将这个条目添加到ZipOutputStream中
zos.putNextEntry(entry)
目前只是加入了一个条目,但是还没有写入内容,下面就需要写入内容,将文件内容读取出来写入即可,如下:
val buffer = ByteArray(1024)
val fis = FileInputStream(src)
var len = fis.read(buffer)
while (len > 0) {
zos.write(buffer, 0, len)
len = fis.read(buffer)
}
不要忘了关闭条目和流:
zos.flush()
zos.closeEntry()
fis.close()
zos.close()
这样压缩包就生成了
压缩多个文件
有时候需要将多个文件压缩到一个包下,整个过程与上面类似,只不过遍历文件循环添加条目和内容即可,这个过程就不详解了,直接看代码:
val fos = FileOutputStream(dist)
val zos = ZipOutputStream(fos)
for (file in files) {
val entry = ZipEntry(String(file.name.toByteArray(Charsets.ISO_8859_1),Charset.forName("GB2312")))
zos.putNextEntry(entry)
val buffer = ByteArray(1024)
val fis = FileInputStream(file)
var len = fis.read(buffer)
while (len > 0) {
zos.write(buffer, 0, len)
len = fis.read(buffer)
}
zos.flush()
zos.closeEntry()
fis.close()
}
zos.close()
对于每个文件都需要添加一个条目,然后写入内容,最后别忘了关闭条目。
压缩文件夹
文件夹比较复杂,因为涉及到目录层级,所以添加条目的时候也需要有层级,而且要跟原目录层级一样,这样解压出来才能还原目录。
比如前面压缩文件的时候,创建ZipEntry时传入的条目名称是“xxx.txt”,只是单一的文件名称。但是压缩文件夹的时候,就需要带上相对路径,比如要压缩的文件夹中有一个名字为“1”的文件夹,下面有一个“xxx.txt”文件,那么创建ZipEntry时传入的条目就应该是“1/xxx.txt”
除了创建ZipEntry不同,其他都一样,还是添加一个条目,写入对应内容,在循环添加其他的即可。但是因为文件夹中还可能有文件夹,所以需要通过递归的方式来处理。这里我们将添加条目写入内容这部分单独成一个方法,如下:
private fun addEntry(dirs: String, src: File, zos: ZipOutputStream){
if(src.isDirectory){
val files = src.listFiles()
if(files == null){
return
}
else {
for (file in files) {
addEntry("${dirs}${src.name}/", file, zos)
}
}
}
else{
val buffer = ByteArray(1024)
val fis = FileInputStream(src)
zos.putNextEntry(ZipEntry(String("${dirs}${src.name}".toByteArray(Charsets.ISO_8859_1), Charset.forName("GB2312"))))
var len = fis.read(buffer)
while (len > 0) {
zos.write(buffer, 0, len)
len = fis.read(buffer)
}
zos.flush()
zos.closeEntry()
fis.close()
}
}
该方法的第一个参数是当前要压缩文件的相对文件夹路径dirs,第二个参数就是要压缩的文件src,最后一个参数就是ZipOutputStream对象。
首先就是要判断文件是不是文件夹,如果是文件夹则遍历它下面的文件并递归调用该方法;如果是文件,则创建添加条目写入内容,这里创建ZipEntry的时候可以看到带上了相对文件夹路径dirs,这样压缩包中就有对应的目录层次。
这样当压缩一个文件或文件夹的时候,就可以用如下代码
val fos = FileOutputStream(dist)
val zos = ZipOutputStream(fos)
addEntry("", src, zos)
zos.close()
这样就可以将一个文件夹下的所有文件打包进压缩包里了。
空目录
上面的方法还有一个问题,当文件夹中有空目录的情况这个目录就无法打包进压缩包中,所以对于空目录我们需要单独处理一下。
对于空目录,我们只创建添加条目即可,不需要写入内容,所以在上面代码的if分支下改动如下:
val files = src.listFiles()
if(files == null){
return
}
else if(files.isEmpty()){
zos.putNextEntry(ZipEntry(String("${dirs}${src.name}/".toByteArray(Charsets.ISO_8859_1), Charset.forName("GB2312"))))
zos.flush()
zos.closeEntry()
}
else {
for (file in files) {
addEntry("${dirs}${src.name}/", file, zos)
}
}
可以看到增加了一个判断,如果文件夹下的文件列表是空的,则创建并添加一个条目即可。
注意这个条目的名称最后要添加“/”,否则会把这个空目录当成文件处理。
总结
这样我们就可以打包压缩文件或文件夹了,为了方便可以封装成一个工具类,方便以后使用。
我自己整理了一个工具类,大家有需要可以关注微信公众号“BennuCTech”,发送“ZipFile”获取完整代码。