cn.hutool.core.util

类 ZipUtil

java.lang.Object

cn.hutool.core.util.ZipUtil

public class ZipUtil
extends java.lang.Object

压缩工具类

作者:

Looly

构造器概要

构造器

构造器和说明
ZipUtil()

方法概要

方法

限定符和类型	方法和说明
static byte[]	gzip(byte[] buf) Gzip压缩处理
static byte[]	gzip(java.io.File file) Gzip压缩文件
static byte[]	gzip(java.io.InputStream in) Gzip压缩文件
static byte[]	gzip(java.io.InputStream in, int length) Gzip压缩文件
static byte[]	gzip(java.lang.String content, java.lang.String charset) Gzip压缩处理
static byte[]	unGzip(byte[] buf) Gzip解压处理
static java.lang.String	unGzip(byte[] buf, java.lang.String charset) Gzip解压缩处理
static byte[]	unGzip(java.io.InputStream in) Gzip解压处理
static byte[]	unGzip(java.io.InputStream in, int length) Gzip解压处理
static java.io.File	unzip(java.io.File zipFile) 解压到文件名相同的目录中，使用UTF-8编码
static java.io.File	unzip(java.io.File zipFile, java.nio.charset.Charset charset) 解压到文件名相同的目录中
static java.io.File	unzip(java.io.File zipFile, java.io.File outFile) 解压，默认使用UTF-8编码
static java.io.File	unzip(java.io.File zipFile, java.io.File outFile, java.nio.charset.Charset charset) 解压
static java.io.File	unzip(java.lang.String zipFilePath) 解压到文件名相同的目录中，默认编码UTF-8
static java.io.File	unzip(java.lang.String zipFilePath, java.nio.charset.Charset charset) 解压到文件名相同的目录中
static java.io.File	unzip(java.lang.String zipFilePath, java.lang.String outFileDir) 解压，默认UTF-8编码
static java.io.File	unzip(java.lang.String zipFilePath, java.lang.String outFileDir, java.nio.charset.Charset charset) 解压
static byte[]	unzipFileBytes(java.io.File zipFile, java.nio.charset.Charset charset, java.lang.String name) 从Zip文件中提取指定的文件为bytes
static byte[]	unzipFileBytes(java.io.File zipFile, java.lang.String name) 从Zip文件中提取指定的文件为bytes
static byte[]	unzipFileBytes(java.lang.String zipFilePath, java.nio.charset.Charset charset, java.lang.String name) 从Zip文件中提取指定的文件为bytes
static byte[]	unzipFileBytes(java.lang.String zipFilePath, java.lang.String name) 从Zip文件中提取指定的文件为bytes
static byte[]	unZlib(byte[] buf) 解压缩zlib
static java.lang.String	unZlib(byte[] buf, java.lang.String charset) Zlib解压缩处理
static java.io.File	zip(java.io.File srcFile) 打包到当前目录，使用默认编码UTF-8
static java.io.File	zip(java.io.File zipFile, boolean withSrcDir, java.io.File... srcFiles) 对文件或文件目录进行压缩 使用默认UTF-8编码
static java.io.File	zip(java.io.File srcFile, java.nio.charset.Charset charset) 打包到当前目录
static java.io.File	zip(java.io.File zipFile, java.nio.charset.Charset charset, boolean withSrcDir, java.io.File... srcFiles) 对文件或文件目录进行压缩
static java.io.File	zip(java.io.File zipFile, java.lang.String[] paths, java.io.InputStream[] ins) 对流中的数据加入到压缩文件 路径列表和流列表长度必须一致
static java.io.File	zip(java.io.File zipFile, java.lang.String[] paths, java.io.InputStream[] ins, java.nio.charset.Charset charset) 对流中的数据加入到压缩文件 路径列表和流列表长度必须一致
static java.io.File	zip(java.io.File zipFile, java.lang.String path, java.io.InputStream in) 对流中的数据加入到压缩文件 使用默认编码UTF-8
static java.io.File	zip(java.io.File zipFile, java.lang.String path, java.io.InputStream in, java.nio.charset.Charset charset) 对流中的数据加入到压缩文件
static java.io.File	zip(java.io.File zipFile, java.lang.String path, java.lang.String data) 对流中的数据加入到压缩文件，使用默认UTF-8编码
static java.io.File	zip(java.io.File zipFile, java.lang.String path, java.lang.String data, java.nio.charset.Charset charset) 对流中的数据加入到压缩文件
static java.io.File	zip(java.lang.String srcPath) 打包到当前目录，使用默认编码UTF-8
static java.io.File	zip(java.lang.String srcPath, java.nio.charset.Charset charset) 打包到当前目录
static java.io.File	zip(java.lang.String srcPath, java.lang.String zipPath) 对文件或文件目录进行压缩 不包含被打包目录
static java.io.File	zip(java.lang.String srcPath, java.lang.String zipPath, boolean withSrcDir) 对文件或文件目录进行压缩
static java.io.File	zip(java.lang.String srcPath, java.lang.String zipPath, java.nio.charset.Charset charset, boolean withSrcDir) 对文件或文件目录进行压缩
static byte[]	zlib(byte[] buf, int level) 打成Zlib压缩包
static byte[]	zlib(java.io.File file, int level) Zlib压缩文件
static byte[]	zlib(java.lang.String content, java.lang.String charset, int level) Zlib压缩处理

从类继承的方法 java.lang.Object

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

构造器详细资料

ZipUtil

public ZipUtil()

方法详细资料

zip

public static java.io.File zip(java.lang.String srcPath)
                        throws UtilException

打包到当前目录，使用默认编码UTF-8

参数:

srcPath - 源文件路径

返回:

打包好的压缩文件

抛出:

UtilException - IO异常

zip

public static java.io.File zip(java.lang.String srcPath,
               java.nio.charset.Charset charset)
                        throws UtilException

打包到当前目录

参数:

srcPath - 源文件路径

charset - 编码

返回:

打包好的压缩文件

抛出:

UtilException - IO异常

zip

public static java.io.File zip(java.io.File srcFile)
                        throws UtilException

打包到当前目录，使用默认编码UTF-8

参数:

srcFile - 源文件或目录

返回:

打包好的压缩文件

抛出:

UtilException - IO异常

zip

public static java.io.File zip(java.io.File srcFile,
               java.nio.charset.Charset charset)
                        throws UtilException

打包到当前目录

参数:

srcFile - 源文件或目录

charset - 编码

返回:

打包好的压缩文件

抛出:

UtilException - IO异常

zip

public static java.io.File zip(java.lang.String srcPath,
               java.lang.String zipPath)
                        throws UtilException

对文件或文件目录进行压缩
不包含被打包目录

参数:

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

zipPath - 压缩文件保存的路径，包括文件名。注意：zipPath不能是srcPath路径下的子文件夹

返回:

压缩好的Zip文件

抛出:

UtilException - IO异常

zip

public static java.io.File zip(java.lang.String srcPath,
               java.lang.String zipPath,
               boolean withSrcDir)
                        throws UtilException

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

参数:

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

zipPath - 压缩文件保存的路径，包括文件名。注意：zipPath不能是srcPath路径下的子文件夹

withSrcDir - 是否包含被打包目录

返回:

压缩文件

抛出:

UtilException - IO异常

zip

public static java.io.File zip(java.lang.String srcPath,
               java.lang.String zipPath,
               java.nio.charset.Charset charset,
               boolean withSrcDir)
                        throws UtilException

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

参数:

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

zipPath - 压缩文件保存的路径，包括文件名。注意：zipPath不能是srcPath路径下的子文件夹

charset - 编码

withSrcDir - 是否包含被打包目录

返回:

压缩文件

抛出:

UtilException - IO异常

zip

public static java.io.File zip(java.io.File zipFile,
               boolean withSrcDir,
               java.io.File... srcFiles)
                        throws UtilException

对文件或文件目录进行压缩
使用默认UTF-8编码

参数:

zipFile - 生成的Zip文件，包括文件名。注意：zipPath不能是srcPath路径下的子文件夹

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

srcFiles - 要压缩的源文件或目录。

返回:

压缩文件

抛出:

UtilException - IO异常

zip

public static java.io.File zip(java.io.File zipFile,
               java.nio.charset.Charset charset,
               boolean withSrcDir,
               java.io.File... srcFiles)
                        throws UtilException

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

参数:

zipFile - 生成的Zip文件，包括文件名。注意：zipPath不能是srcPath路径下的子文件夹

charset - 编码

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

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

返回:

压缩文件

抛出:

UtilException - IO异常

zip

public static java.io.File zip(java.io.File zipFile,
               java.lang.String path,
               java.lang.String data)
                        throws UtilException

对流中的数据加入到压缩文件，使用默认UTF-8编码

参数:

zipFile - 生成的Zip文件，包括文件名。注意：zipPath不能是srcPath路径下的子文件夹

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

data - 要压缩的数据

返回:

压缩文件

抛出:

UtilException - IO异常

从以下版本开始:

3.0.6

zip

public static java.io.File zip(java.io.File zipFile,
               java.lang.String path,
               java.lang.String data,
               java.nio.charset.Charset charset)
                        throws UtilException

对流中的数据加入到压缩文件

参数:

zipFile - 生成的Zip文件，包括文件名。注意：zipPath不能是srcPath路径下的子文件夹

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

data - 要压缩的数据

charset - 编码

返回:

压缩文件

抛出:

UtilException - IO异常

从以下版本开始:

3.2.2

zip

public static java.io.File zip(java.io.File zipFile,
               java.lang.String path,
               java.io.InputStream in)
                        throws UtilException

对流中的数据加入到压缩文件
使用默认编码UTF-8

参数:

zipFile - 生成的Zip文件，包括文件名。注意：zipPath不能是srcPath路径下的子文件夹

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

in - 要压缩的源

返回:

压缩文件

抛出:

UtilException - IO异常

从以下版本开始:

3.0.6

zip

public static java.io.File zip(java.io.File zipFile,
               java.lang.String path,
               java.io.InputStream in,
               java.nio.charset.Charset charset)
                        throws UtilException

对流中的数据加入到压缩文件

参数:

zipFile - 生成的Zip文件，包括文件名。注意：zipPath不能是srcPath路径下的子文件夹

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

in - 要压缩的源

charset - 编码

返回:

压缩文件

抛出:

UtilException - IO异常

从以下版本开始:

3.2.2

zip

public static java.io.File zip(java.io.File zipFile,
               java.lang.String[] paths,
               java.io.InputStream[] ins)
                        throws UtilException

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

参数:

zipFile - 生成的Zip文件，包括文件名。注意：zipPath不能是srcPath路径下的子文件夹

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

ins - 要压缩的源

返回:

压缩文件

抛出:

UtilException - IO异常

从以下版本开始:

3.0.9

zip

public static java.io.File zip(java.io.File zipFile,
               java.lang.String[] paths,
               java.io.InputStream[] ins,
               java.nio.charset.Charset charset)
                        throws UtilException

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

参数:

zipFile - 生成的Zip文件，包括文件名。注意：zipPath不能是srcPath路径下的子文件夹

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

ins - 要压缩的源

charset - 编码

返回:

压缩文件

抛出:

UtilException - IO异常

从以下版本开始:

3.0.9

unzip

public static java.io.File unzip(java.lang.String zipFilePath)
                          throws UtilException

解压到文件名相同的目录中，默认编码UTF-8

参数:

zipFilePath - 压缩文件路径

返回:

解压的目录

抛出:

UtilException - IO异常

unzip

public static java.io.File unzip(java.lang.String zipFilePath,
                 java.nio.charset.Charset charset)
                          throws UtilException

解压到文件名相同的目录中

参数:

zipFilePath - 压缩文件路径

charset - 编码

返回:

解压的目录

抛出:

UtilException - IO异常

从以下版本开始:

3.2.2

unzip

public static java.io.File unzip(java.io.File zipFile)
                          throws UtilException

解压到文件名相同的目录中，使用UTF-8编码

参数:

zipFile - 压缩文件

返回:

解压的目录

抛出:

UtilException - IO异常

从以下版本开始:

3.2.2

unzip

public static java.io.File unzip(java.io.File zipFile,
                 java.nio.charset.Charset charset)
                          throws UtilException

解压到文件名相同的目录中

参数:

zipFile - 压缩文件

charset - 编码

返回:

解压的目录

抛出:

UtilException - IO异常

从以下版本开始:

3.2.2

unzip

public static java.io.File unzip(java.lang.String zipFilePath,
                 java.lang.String outFileDir)
                          throws UtilException

解压，默认UTF-8编码

参数:

zipFilePath - 压缩文件的路径

outFileDir - 解压到的目录

返回:

解压的目录

抛出:

UtilException - IO异常

unzip

public static java.io.File unzip(java.lang.String zipFilePath,
                 java.lang.String outFileDir,
                 java.nio.charset.Charset charset)
                          throws UtilException

解压

参数:

zipFilePath - 压缩文件的路径

outFileDir - 解压到的目录

charset - 编码

返回:

解压的目录

抛出:

UtilException - IO异常

unzip

public static java.io.File unzip(java.io.File zipFile,
                 java.io.File outFile)
                          throws UtilException

解压，默认使用UTF-8编码

参数:

zipFile - zip文件

outFile - 解压到的目录

返回:

解压的目录

抛出:

UtilException - IO异常

unzip

public static java.io.File unzip(java.io.File zipFile,
                 java.io.File outFile,
                 java.nio.charset.Charset charset)
                          throws UtilException

解压

参数:

zipFile - zip文件

outFile - 解压到的目录

charset - 编码

返回:

解压的目录

抛出:

UtilException - IO异常

从以下版本开始:

3.2.2

unzipFileBytes

public static byte[] unzipFileBytes(java.lang.String zipFilePath,
                    java.lang.String name)

从Zip文件中提取指定的文件为bytes

参数:

zipFilePath - Zip文件

name - 文件名，如果存在于子文件夹中，此文件名必须包含目录名，例如images/aaa.txt

返回:

文件内容bytes

从以下版本开始:

4.1.8

unzipFileBytes

public static byte[] unzipFileBytes(java.lang.String zipFilePath,
                    java.nio.charset.Charset charset,
                    java.lang.String name)

从Zip文件中提取指定的文件为bytes

参数:

zipFilePath - Zip文件

charset - 编码

name - 文件名，如果存在于子文件夹中，此文件名必须包含目录名，例如images/aaa.txt

返回:

文件内容bytes

从以下版本开始:

4.1.8

unzipFileBytes

public static byte[] unzipFileBytes(java.io.File zipFile,
                    java.lang.String name)

从Zip文件中提取指定的文件为bytes

参数:

zipFile - Zip文件

name - 文件名，如果存在于子文件夹中，此文件名必须包含目录名，例如images/aaa.txt

返回:

文件内容bytes

从以下版本开始:

4.1.8

unzipFileBytes

public static byte[] unzipFileBytes(java.io.File zipFile,
                    java.nio.charset.Charset charset,
                    java.lang.String name)

从Zip文件中提取指定的文件为bytes

参数:

zipFile - Zip文件

charset - 编码

name - 文件名，如果存在于子文件夹中，此文件名必须包含目录名，例如images/aaa.txt

返回:

文件内容bytes

从以下版本开始:

4.1.8

gzip

public static byte[] gzip(java.lang.String content,
          java.lang.String charset)
                   throws UtilException

Gzip压缩处理

参数:

content - 被压缩的字符串

charset - 编码

返回:

压缩后的字节流

抛出:

UtilException - IO异常

gzip

public static byte[] gzip(byte[] buf)
                   throws UtilException

Gzip压缩处理

参数:

buf - 被压缩的字节流

返回:

压缩后的字节流

抛出:

UtilException - IO异常

gzip

public static byte[] gzip(java.io.File file)
                   throws UtilException

Gzip压缩文件

参数:

file - 被压缩的文件

返回:

压缩后的字节流

抛出:

UtilException - IO异常

gzip

public static byte[] gzip(java.io.InputStream in)
                   throws UtilException

Gzip压缩文件

参数:

in - 被压缩的流

返回:

压缩后的字节流

抛出:

UtilException - IO异常

从以下版本开始:

4.1.18

gzip

public static byte[] gzip(java.io.InputStream in,
          int length)
                   throws UtilException

Gzip压缩文件

参数:

in - 被压缩的流

length - 预估长度

返回:

压缩后的字节流

抛出:

UtilException - IO异常

从以下版本开始:

4.1.18

unGzip

public static java.lang.String unGzip(byte[] buf,
                      java.lang.String charset)
                               throws UtilException

Gzip解压缩处理

参数:

buf - 压缩过的字节流

charset - 编码

返回:

解压后的字符串

抛出:

UtilException - IO异常

unGzip

public static byte[] unGzip(byte[] buf)
                     throws UtilException

Gzip解压处理

参数:

buf - buf

返回:

bytes

抛出:

UtilException - IO异常

unGzip

public static byte[] unGzip(java.io.InputStream in)
                     throws UtilException

Gzip解压处理

参数:

in - Gzip数据

返回:

解压后的数据

抛出:

UtilException - IO异常

unGzip

public static byte[] unGzip(java.io.InputStream in,
            int length)
                     throws UtilException

Gzip解压处理

参数:

in - Gzip数据

length - 估算长度，如果无法确定请传入32

返回:

解压后的数据

抛出:

UtilException - IO异常

从以下版本开始:

4.1.18

zlib

public static byte[] zlib(java.lang.String content,
          java.lang.String charset,
          int level)

Zlib压缩处理

参数:

content - 被压缩的字符串

charset - 编码

level - 压缩级别，1~9

返回:

压缩后的字节流

从以下版本开始:

4.1.4

zlib

public static byte[] zlib(java.io.File file,
          int level)

Zlib压缩文件

参数:

file - 被压缩的文件

level - 压缩级别

返回:

压缩后的字节流

从以下版本开始:

4.1.4

zlib

public static byte[] zlib(byte[] buf,
          int level)

打成Zlib压缩包

参数:

buf - 数据

level - 压缩级别，0~9

返回:

压缩后的bytes

从以下版本开始:

4.1.4

unZlib

public static java.lang.String unZlib(byte[] buf,
                      java.lang.String charset)

Zlib解压缩处理

参数:

buf - 压缩过的字节流

charset - 编码

返回:

解压后的字符串

从以下版本开始:

4.1.4

unZlib

public static byte[] unZlib(byte[] buf)

解压缩zlib

参数:

buf - 数据

返回:

解压后的bytes

从以下版本开始:

4.1.4