cn.hutool.core.compress

Class ZipWriter

java.lang.Object

cn.hutool.core.compress.ZipWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public class ZipWriter
extends Object
implements Closeable

Zip生成封装

Since:

5.7.8

Author:

looly

Constructor Summary

Constructors

Constructor and Description
ZipWriter(File zipFile, Charset charset) 构造
ZipWriter(OutputStream out, Charset charset) 构造
ZipWriter(ZipOutputStream out) 构造

Method Summary

Modifier and Type	Method and Description
ZipWriter	add(boolean withSrcDir, FileFilter filter, File... files) 对文件或文件目录进行压缩
ZipWriter	add(Resource... resources) 添加资源到压缩包，添加后关闭资源流
ZipWriter	add(String[] paths, InputStream[] ins) 对流中的数据加入到压缩文件 路径列表和流列表长度必须一致
ZipWriter	add(String path, InputStream in) 添加文件流到压缩包，添加后关闭输入文件流 如果输入流为null，则只创建空目录
void	close()
ZipOutputStream	getOut() 获取原始的ZipOutputStream
static ZipWriter	of(File zipFile, Charset charset) 创建ZipWriter
static ZipWriter	of(OutputStream out, Charset charset) 创建ZipWriter
ZipWriter	setComment(String comment) 设置注释
ZipWriter	setLevel(int level) 设置压缩级别，可选1~9，-1表示默认

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ZipWriter

public ZipWriter(File zipFile,
                 Charset charset)

构造

Parameters:

zipFile - 生成的Zip文件

charset - 编码

ZipWriter

public ZipWriter(OutputStream out,
                 Charset charset)

构造

Parameters:

out - ZipOutputStream

charset - 编码

ZipWriter

public ZipWriter(ZipOutputStream out)

构造

Parameters:

out - ZipOutputStream

Method Detail

of

public static ZipWriter of(File zipFile,
                           Charset charset)

创建ZipWriter

Parameters:

zipFile - 生成的Zip文件

charset - 编码

Returns:

ZipWriter

of

public static ZipWriter of(OutputStream out,
                           Charset charset)

创建ZipWriter

Parameters:

out - Zip输出的流，一般为输出文件流

charset - 编码

Returns:

ZipWriter

setLevel

public ZipWriter setLevel(int level)

设置压缩级别，可选1~9，-1表示默认

Parameters:

level - 压缩级别

Returns:

this

setComment

public ZipWriter setComment(String comment)

设置注释

Parameters:

comment - 注释

Returns:

this

getOut

public ZipOutputStream getOut()

获取原始的ZipOutputStream

Returns:

ZipOutputStream

add

public ZipWriter add(boolean withSrcDir,
                     FileFilter filter,
                     File... files)
              throws IORuntimeException

对文件或文件目录进行压缩

Parameters:

withSrcDir - 是否包含被打包目录，只针对压缩目录有效。若为false，则只压缩目录下的文件或目录，为true则将本目录也压缩

filter - 文件过滤器，通过实现此接口，自定义要过滤的文件（过滤掉哪些文件或文件夹不加入压缩），null表示不过滤

files - 要压缩的源文件或目录。如果压缩一个文件，则为该文件的全路径；如果压缩一个目录，则为该目录的顶层目录路径

Returns:

this

Throws:

IORuntimeException - IO异常

Since:

5.1.1

add

public ZipWriter add(Resource... resources)
              throws IORuntimeException

添加资源到压缩包，添加后关闭资源流

Parameters:

resources - 需要压缩的资源，资源的路径为Resource.getName()

Returns:

this

Throws:

IORuntimeException - IO异常

add

public ZipWriter add(String path,
                     InputStream in)
              throws IORuntimeException

添加文件流到压缩包，添加后关闭输入文件流
如果输入流为null，则只创建空目录

Parameters:

path - 压缩的路径, null和""表示根目录下

in - 需要压缩的输入流，使用完后自动关闭，null表示加入空目录

Returns:

this

Throws:

IORuntimeException - IO异常

add

public ZipWriter add(String[] paths,
                     InputStream[] ins)
              throws IORuntimeException

对流中的数据加入到压缩文件
路径列表和流列表长度必须一致

Parameters:

paths - 流数据在压缩文件中的路径或文件名

ins - 要压缩的源，添加完成后自动关闭流

Returns:

压缩文件

Throws:

IORuntimeException - IO异常

Since:

5.8.0

close

public void close()
           throws IORuntimeException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IORuntimeException