org.apache.commons.compress

ArchiveEntry

表示存档中的一个条目

ArchiveStreamProvider

创建归档 ArchiveInputStreams 和 ArchiveOutputStreams。

createArchiveInputStream

ArchiveInputStream createArchiveInputStream(String name, InputStream in, String encoding) throws ArchiveException
通过归档名称和输入流创建一个归档输入流

Parameters：
name - 归档名称，例如 ar, arj，zip，tar，jar，cpio，dump，7z
in - 输入流
enconding - 编码名称，默认为 null

createArchiveOutputStream

ArchiveOutputStream createArchiveOutputStream(String name, OutputStream out, String encoding) throws ArchiveException

通过归档名称和输出流创建一个归档输出流

Parameters：
name - 归档名称，例如 ar，zip，tar，jar，cpio
out - 输出流
enconding - 编码名称，默认为 null

EntryStreamOffsets

提供关于 ArchiveEntry 流偏移量的信息

ArchiveInputStream

ArchiveInputStream 必须重写 InputStream.read(byte[], int, int) 或者 read() 方法，以便从流中读取每个条目中的数据末尾以及文件末尾生成的 EOF 。

getNextEntry()用于重置输入流，以便从下一个条目中读取数据。

输入流类还必须实现一个带有签名的方法：

public static boolean matches(byte[] signature, int length)

ArchiveStreamFactory 使用它从流的前几个字节中自动检测归档类型。

ArchiveOutputStream

ArchiveOutputStream 需要重写 OutputStream.write(byte[], int, int) 以提升性能。还应该重写 OutputStream.close()。使用 ArchiveOutputStreams 时的正常调用顺序是：

1. 创建 ArchiveOutputStream 对象
2. 可选择写入 SFX 标头（仅限 Zip）
3. 根据需要重复：
   1. putArchiveEntry(ArchiveEntry) （写入条目标题）
   2. OutputStream.write(byte[]) （写入条目数据）
   3. closeArchiveEntry() （关闭条目）
4. finish() （结束添加条目）
5. 可选地写入附加数据，只要格式支持此操作

• OutputStream.close()

ArchiveStreamFactory

通过名称或 InputStream 的第一个字节创建 Archive[In|Out]putStreams 的工厂类。如果需要别的实现类，需要继承 ArchiveStreamFactory 并重写适当的方法（当然还要从 super 调用它们的实现）。

压缩 ZIP 文件：

// 打开或创建文件，返回一个用于向文件写入bytes的输入流 
final OutputStream out = Files.newOutputStream(output.toPath());
 ArchiveOutputStream os = new ArchiveStreamFactory().createArchiveOutputStream(ArchiveStreamFactory.ZIP, out);
 os.putArchiveEntry(new ZipArchiveEntry("testdata/test1.xml"));
 IOUtils.copy(Files.newInputStream(file1.toPath()), os);
 os.closeArchiveEntry();
 os.putArchiveEntry(new ZipArchiveEntry("testdata/test2.xml"));
 IOUtils.copy(Files.newInputStream(file2.toPath()), os);
 os.closeArchiveEntry();
 os.close();

解压缩 ZIP 文件：

// 打开一个文件，返回一个输出流用来读取文件 
 final InputStream is = Files.newInputStream(input.toPath());
 ArchiveInputStream in = new ArchiveStreamFactory().createArchiveInputStream(ArchiveStreamFactory.ZIP, is);
 ZipArchiveEntry entry = (ZipArchiveEntry)in.getNextEntry();
 OutputStream out = Files.newOutputStream(dir.toPath().resolve(entry.getName()));
 IOUtils.copy(in, out);
 out.close();
 in.close();

该类是不可变的，前提是不使用已废弃的方法 ~~setEntryEncoding~~
这个类是线程安全的，即使使用了已弃用的方法~~setEntryEncoding~~

Fields

Methods

createArchiveInputStream

public ArchiveInputStream createArchiveInputStream(String archiverName, InputStream in) throws ArchiveException

根据归档名称和给定的输入流创建一个归档输入流

Parameters：
archiverName - the archive name, i.e. “ar”, “arj”, “zip”, “tar”, “jar”, “cpio”, “dump” or “7z”
in - the input stream

createArchiveOutputStream

public ArchiveOutputStream createArchiveOutputStream(String archiverName, OutputStream out) throws ArchiveException

根据归档名称和给定的输出流创建一个归档输出流

Parameters：
archiverName - the archive name, i.e. “ar”, “zip”, “tar”, “jar” or “cpio”
out - the output stream

Lister

列出归档文件内容的简单命令行应用程序。

归档的名称必须作为命令行参数给出。

可选的第二个参数定义归档类型，以防格式无法识别。

org.apache.commons.compress.archivers.zip

CharsetAccessor

添加一个接口以允许访问与 NioZipEncoding 关联的字符集，而无需将新方法添加到 ZipEncoding。

这避免了引入潜在的破坏性更改，或使 NioZipEncoding 成为公共类。

ExtraFieldParsingBehavior

解析 zip 额外字段的控制细节

fill

ZipExtraField fill(ZipExtraField field, byte[] data, int off, int len, boolean local) throws ZipException

填写单个额外字段的额外字段数据

ExtraFieldUtils.fillExtraField(org.apache.commons.compress.archivers.zip.ZipExtraField, byte[], int, int, boolean) 是一个很好的默认实现。

Parameters：
field - 需要取填充的额外字段
data - 额外字段数据数组
off - 距离开始位置的偏移量
len - 字段数据的长度
local - 额外的字段数据是否来自本地文件头。 如果为 false，那么数据是中央目录标题额外数据的一部分

return：
填充的字段。 通常这与字段相同，但它也可以是替换的额外字段。 不得为空。

UnixStat

Unix 系统的 stat.h 文件中的常量

UnparseableExtraFieldBehavior

处理不遵循带有两字节 key 和两字节长度的额外字段的推荐模式的额外字段数据。

onUnparseableExtraField

ZipExtraField onUnparseableExtraField(byte[] data, int off, int len, boolean local, int claimedLength) throws ZipException

决定如何处理不遵循推荐模式的额外字段数据

Parameters：
data - 额外字段数据的数组
off - 偏移到不可解析数据开始的数据中
len - 不可解析数据的长度
local - 额外字段数据是否来自本地文件头。 如果为 false，那么数据是中央目录标题额外数据的一部分
claimLength - 第三个和第四个字节声明的额外字段的长度，如果它确实遵循推荐的模式

Return：
如果应忽略数据或额外字段实现表示了该数据，则为 null

ZipArchiveEntryPredicate

用于测试 #ZipArchiveEntry 是否与条件匹配的谓词。 可能支持继承 java.util.function.Predicate

ZipArchiveEntryRequestSupplier

提供 ZipArchiveEntryRequest。实现类需要支持线程切换。 虽然一个实例不会被多个线程同时访问，但它将由与创建它的线程不同的线程调用。

ZipEncoding

对 ZIP 文件名进行优雅编码的编码器接口。主要有两种实现，一种使用 java.nio 字符集，另一种处理简单的 8 位字符集，因为 java-1.4 在 java.nio 中不支持 Cp437。

定义自己的编码层的主要原因来自 String.getBytes 的问题，它将未知字符编码为 ASCII 引号 (‘?’)。 引号在某些操作系统（如 Windows）上根据定义是无效的文件名，这会导致 ZIP 条目被忽略。

所有的实现类都应该以可重入的方式实现这个接口。

encode

ByteBuffer encode(String name) throws IOException

将文件名或注释编码为适合将其存储到序列化 zip 条目的字节数组。CP437 的示例（在伪符号中，右侧是 C 样式符号）：

encode("?_for_Dollar.txt") = "%U20AC_for_Dollar.txt"
encode("Ölfässer.txt") = "\231lf\204sser.txt"

Parameters：
name - 文件名或 ZIP 注释。

Return：
带有包含编码名称的后备数组的字节缓冲区。 无法映射的字符或格式错误的字符序列被映射到以 %Uxxxx 格式编码的 utf-16 字序列。 假设字节缓冲区位于编码结果的开头，字节缓冲区有一个后备数组，字节缓冲区的限制指向编码结果的末尾。

ZipExtraField

额外字段数据的通用格式

额外字段通常在每个文件中出现两次，一次在本地文件数据中，一次在中央目录中。 通常它们是相同的，但它们不必相同。 java.util.zip.ZipOutputStream 只会在两个地方使用本地文件数据。

Fields

Methods

AbstractUnicodeExtraField

ZipExtraField的直接子类。Unicode 额外信息额外字段的通用基类。

AsiExtraField

public class AsiExtraField extends Object
    implements ZipExtraField, UnixStat, Cloneable

添加 Unix 文件权限和 UID/GID 字段以及符号链接处理。

此类使用以下格式的 ASi 额外字段：

           Value         Size            Description
           -----         ----            -----------
   (Unix3) 0x756e        Short           tag for this extra block type
           TSize         Short           total data size for this block
           CRC           Long            CRC-32 of the remaining data
           Mode          Short           file permissions
           SizDev        Long            symlink'd size OR major/minor dev num
           UID           Short           user ID
           GID           Short           group ID
           (var.)        variable        symbolic link file name

取自 ftp://ftp.uu.net/pub/archiving/zip/doc/ 上的 appnote.iz (Info-ZIP note, 981119)

Short 是两个字节，Long 是大端字节序的四个字节，目前不支持设备号。

这个类不是线程安全的。由于该类所基于的文档根本没有提及文件名的字符编码，因此假定它使用当前平台的默认编码。

ExtraFieldUtils

ZipExtraField 相关方法

GeneralPurposeBit

ZIP 本地文件和中央目录头中“通用位”字段的解析器/编码器

JarMarker

public final class JarMarker extends Object
    implements ZipExtraField

如果将此额外字段添加为归档的第一个额外字段，则 Solaris 会将其视为可执行 jar 文件。

ParallelScatterZipCreator

通过使用多个 ThreadLocal ScatterZipOutputStream 实例并行创建一个 zip。

请注意，在 1.18 之前，此类通常不保证写入输出文件的内容的顺序。 需要按特定顺序（清单、目录）出现的事情必须由此类的客户端处理，通常是在调用此类上的 writeTo 之前将这些事情写入 ZipArchiveOutputStream。

客户端可以提供一个 ExecutorService，但出于内存模型一致性的原因，这将在完成之前被此类关闭。

PKWareExtraHeader

public abstract class PKWareExtraHeader extends Object
    implements ZipExtraField

所有 PKWare 强加密额外头部的基类。这个基类充当一个标记，因此如果您对 PKWare 强加密的元数据不感兴趣，您可以忽略所有扩展该类的额外字段。

算法 ID - 来自以下范围的加密算法的整数标识符：

• 0x6601 - DES
• 0x6602 - RC2 (version needed to extract < 5.2)
• 0x6603 - 3DES 168
• 0x6609 - 3DES 112
• 0x660E - AES 128
• 0x660F - AES 192
• 0x6610 - AES 256
• 0x6702 - RC2 (version needed to extract >= 5.2)
• 0x6720 - Blowfish
• 0x6721 - Twofish
• 0x6801 - RC4
• 0xFFFF - Unknown algorithm

哈希算法 - 哈希算法的整数标识符，来自以下范围：

• 0x0000 - none
• 0x0001 - CRC32
• 0x8003 - MD5
• 0x8004 - SHA1
• 0x8007 - RIPEMD160
• 0x800C - SHA256
• 0x800D - SHA384
• 0x800E - SHA512

ResourceAlignmentExtraField

public abstract class PKWareExtraHeader extends Object
    implements ZipExtraField

一个额外的字段，其唯一目的是对齐和填充本地文件头，以便条目的数据从某个位置开始。

读取填充字段时，填充的填充内容将被忽略且不保留。

这使 Commons Compress 能够创建类似于 Android 的 zipalign 命令行工具的“对齐”归档。

ScatterStatistics

提供有关分散压缩运行的信息。

ScatterZipOutputStream

一个 zip 输出流，针对 zip 文件的多线程分散/聚集构造进行了优化。此类使用的条目的内部数据格式对此类完全私有，并且不属于任何公共 api。

可以继承此类以支持不同类型的后备存储，默认实现仅支持基于文件的后备。

线程安全：这个类支持多线程。 但是“writeTo”方法必须由最初创建 ZipArchiveEntry 的线程调用。

StreamCompressor

封装了 Deflater 和 crc 计算器，处理多种类型的输出流。 目前 ZipEntry.DEFLATED 和 ZipEntry.STORED 是唯一支持的压缩方法。

UnicodeCommentExtraField

public class UnicodeCommentExtraField extends AbstractUnicodeExtraField

Info-ZIP Unicode 注释额外字段 (0x6375)：存储中央目录头部中存储的文件注释的 UTF-8 版本。

非线程安全类，父类也是非线程安全类。

UnicodePathExtraField

public class UnicodePathExtraField
extends AbstractUnicodeExtraField

Info-ZIP Unicode 路径额外字段 (0x6375)：存储本地文件头部和中央目录头部中存储的文件名称字段的 UTF-8 版本。

非线程安全类，父类也是非线程安全类。

UnparseableExtraFieldData

public final class UnparseableExtraFieldData extends Object
    implements ZipExtraField

不符合推荐的 header-tag + size + data 格式的额外字段数据的包装器。

header-id 是人为的（在 APPNOTE.TXT 中未列为已知 ID）。 由于除了满足 ZipExtraField 约束外，它不会在任何地方使用，因此无论如何都无关紧要。

X000A_NTFS

public class X000A_NTFS extends Object
    implements ZipExtraField

NTFS 额外字段被认为存储各种属性，但实际上只存储时间戳。

 4.5.5 -NTFS Extra Field (0x000a):
       下面是NTFS属性 “extra” 块的布局。（注：此时Mtime、Atime
        和 Ctime 值可以在任何 WIN32 系统上使用。）
       Note: all fields stored in Intel low-byte/high-byte order.
       注意：所有字段以 Intel 低字节/高字节顺序存储
         Value      Size       Description
         -----      ----       -----------
 (NTFS)  0x000a     2 bytes    Tag for this "extra" block type
         TSize      2 bytes    Size of the total "extra" block
         Reserved   4 bytes    Reserved for future use
         Tag1       2 bytes    NTFS attribute tag value #1
         Size1      2 bytes    Size of attribute #1, in bytes
         (var)      Size1      Attribute #1 data
          .
          .
          .
          TagN       2 bytes    NTFS attribute tag value #N
          SizeN      2 bytes    Size of attribute #N, in bytes
          (var)      SizeN      Attribute #N data
        对于 NTFS，Tag1 到 TagN 的值如下：
        （目前只为 NTFS 定义了一组属性）
          Tag        Size       Description
          -----      ----       -----------
          0x0001     2 bytes    Tag for attribute #1
          Size1      2 bytes    Size of attribute #1, in bytes
          Mtime      8 bytes    File last modification time
          Atime      8 bytes    File last access time
          Ctime      8 bytes    File creation time

X0014_X509Certificates

public class X0014_X509Certificates extends PKWareExtraHeader

PKCS#7 存储 X.509 证书 (0x0014)。

该字段必须包含有关每个可能签名的证书文件的信息。 当 ZIP 文件启用中央目录加密功能时，此记录将出现在归档额外数据记录中，否则它将出现在第一个中央目录记录中，并且在任何其他记录中将被忽略。

注意：所有字段以 Intel 低字节/高字节顺序存储。

         Value     Size     Description
         -----     ----     -----------
 (Store) 0x0014    2 bytes  Tag for this "extra" block type
         TSize     2 bytes  Size of the store data
         TData     TSize    Data about the store

X0015_CertificateIdForFile

public class X0015_CertificateIdForFile extends PKWareExtraHeader

单个文件 (0x0015) 的 X.509 证书 ID 和签名。

此字段包含有关 PKCS#7 存储中的哪个证书用于签署特定文件的信息。 它还包含签名数据。 此字段可以出现多次，但每个证书只能出现一次。

注意：所有字段以 Intel 低字节/高字节顺序存储。

         Value     Size     Description
         -----     ----     -----------
 (CID)   0x0015    2 bytes  Tag for this "extra" block type
         TSize     2 bytes  Size of data that follows
         RCount    4 bytes  Number of recipients. (inferred)
         HashAlg   2 bytes  Hash algorithm identifier. (inferred)
         TData     TSize    Signature Data

X0016_CertificateIdForCentralDirectory

public class X0016_CertificateIdForCentralDirectory extends PKWareExtraHeader

中央目录 (0x0016) 的 X.509 证书 ID 和签名。

此字段包含有关 PKCS#7 存储中的哪个证书用于签署中央目录结构的信息。 当 ZIP 文件启用中央目录加密功能时，该记录将出现在存档额外数据记录中，否则将出现在第一条中央目录记录中。

注意：所有字段以 Intel 低字节/高字节顺序存储。

         Value     Size     Description
         -----     ----     -----------
 (CDID)  0x0016    2 bytes  Tag for this "extra" block type
         TSize     2 bytes  Size of data that follows
         RCount    4 bytes  Number of recipients. (inferred)
         HashAlg   2 bytes  Hash algorithm identifier. (inferred)
         TData     TSize    Data

X0017_StrongEncryptionHeader

public class X0017_StrongEncryptionHeader extends PKWareExtraHeader

强加密头部 (0x0017)。

基于证书的加密：

 Value     Size     Description
 -----     ----     -----------
 0x0017    2 bytes  Tag for this "extra" block type
 TSize     2 bytes  Size of data that follows
 Format    2 bytes  Format definition for this record
 AlgID     2 bytes  Encryption algorithm identifier
 Bitlen    2 bytes  Bit length of encryption key (32-448 bits)
 Flags     2 bytes  Processing flags
 RCount    4 bytes  Number of recipients.
 HashAlg   2 bytes  Hash algorithm identifier
 HSize     2 bytes  Hash size
 SRList    (var)    Simple list of recipients hashed public keys

Flags

• 0x0007 - 保留供将来使用
• 0x000F - 保留供将来使用
• 0x0100 - 表示使用了非 OAEP 密钥包装。 如果设置了此字段，则需要提取的版本必须至少为 61。这意味着使用 ErdData 生成主会话密钥时不使用 OAEP 密钥包装
• 0x4000 - ErdData 必须使用 3DES-168 解密，否则使用用于加密文件内容的相同算法
• 0x8000 - 保留供将来使用

RCount
定义了预期接收者的数量，其公钥用于加密。 这标识SRList 中的元素数量。

HSize
定义了散列公钥的大小。

SRList
这是散列的可变长度列表每个预期收件人的公钥。 每个此列表中的元素是 HSize。 总规模SRList 使用 RCount * HSize 确定。

仅在中心标头中基于密码的额外字段 0x0017。

Value     Size     Description
 -----     ----     -----------
 0x0017    2 bytes  Tag for this "extra" block type
 TSize     2 bytes  Size of data that follows
 Format    2 bytes  Format definition for this record
 AlgID     2 bytes  Encryption algorithm identifier
 Bitlen    2 bytes  Bit length of encryption key (32-448 bits)
 Flags     2 bytes  Processing flags
 (more?)

Format
此记录的数据格式标识符。 此时唯一允许的值是整数值 2。

压缩文件数据前基于密码的额外字段 0x0017。

Value     Size     Description
 -----     ----     -----------
 0x0017    2 bytes  Tag for this "extra" block type
 IVSize    2 bytes  Size of initialization vector (IV)
 IVData    IVSize   Initialization vector for this file
 Size      4 bytes  Size of remaining decryption header data
 Format    2 bytes  Format definition for this record
 AlgID     2 bytes  Encryption algorithm identifier
 Bitlen    2 bytes  Bit length of encryption key (32-448 bits)
 Flags     2 bytes  Processing flags
 ErdSize   2 bytes  Size of Encrypted Random Data
 ErdData   ErdSize  Encrypted Random Data
 Reserved1 4 bytes  Reserved certificate processing data
 Reserved2 (var)    Reserved for certificate processing data
 VSize     2 bytes  Size of password validation data
 VData     VSize-4  Password validation data
 VCRC32    4 bytes  Standard ZIP CRC32 of password validation data

IVData
IV 的大小应与算法块大小相匹配。IVData 可以是完全随机的数据。如果随机生成的数据大小与块大小不匹配它应该用零补充或截断。如果 IVSize 为 0，则 IV = CRC32 + 未压缩文件大小（作为 64 位 little-endian，无符号整数值）。

Format
此记录的数据格式标识符。唯一的此时允许的值为整数值 2。

ErdData
用来存储为加密每个文件而生成的文件会话key的随机数据的加密随机数。 SHA1 用于计算哈希数据派生密钥。文件会话密钥是从主服务器派生的从用户提供的密码生成的会话密钥。如果解密头中的 Flags 字段包含值 0x4000，则 ErdData 字段必须是使用 3DES 解密。如果未设置值 0x4000，那么 ErdData 字段必须使用 AlgId 解密。

Reserved1
为证书处理保留，如果值为零，则 Reserved2 数据不存在。看说明根据证书处理方法了解详情这个数据结构。

Reserved2
如果存在，Reserved2 数据结构的大小通过跳过该字段的前 4 个字节来定位并使用接下来的 2 个字节作为剩余大小。看证书处理方法下的解释有关此数据结构的详细信息。

VSize
这个大小值将始终包括 4 个字节VCRC32 数据将大于 4 个字节

VData
用于密码验证的随机数据。这个数据是 VSize长度和 VSize 必须是加密的倍数块大小。 VCRC32 是 VData 的校验和值。VData 和 VCRC32 被加密存储并启动文件的加密数据流。

Reserved1 - 证书解密标头 Reserved1 数据：

Value     Size     Description
 -----     ----     -----------
 RCount    4 bytes  Number of recipients.

RCount - 定义了其公钥用于加密的预期收件人的数量。 这定义了下面定义的 REList 字段中的元素数量。

Reserved2 - 证书解密头 Reserved2 数据结构：

Value     Size     Description
 -----     ----     -----------
 HashAlg   2 bytes  Hash algorithm identifier
 HSize     2 bytes  Hash size
 REList    (var)    List of recipient data elements
 HashAlg - This defines the hash algorithm used to calculate
           the public key hash of each public key used
           for encryption. This field currently supports
           only the following value for SHA-1
               0x8004 - SHA1
 HSize -   This defines the size of a hashed public key
           defined in REHData.
 REList -  This is a variable length of list of recipient data.
           Each element in this list consists of a Recipient
           Element data structure as follows:

收件人元素 (REList) 数据结构：

Value     Size     Description
 -----     ----     -----------
 RESize    2 bytes  Size of REHData + REKData
 REHData   HSize    Hash of recipients public key
 REKData   (var)    Simple key blob
 RESize -  This defines the size of an individual REList
           element.  This value is the combined size of the
           REHData field + REKData field.  REHData is defined by
           HSize.  REKData is variable and can be calculated
           for each REList element using RESize and HSize.
 REHData - Hashed public key for this recipient.
 REKData - Simple Key Blob.  The format of this data structure
           is identical to that defined in the Microsoft
           CryptoAPI and generated using the CryptExportKey()
           function.  The version of the Simple Key Blob
           supported at this time is 0x02 as defined by
           Microsoft.
     For more details see https://msdn.microsoft.com/en-us/library/aa920051.aspx

Flags - 处理解密所需的标志

• 0x0001 - 需要密码才能解密
• 0x0002 - 仅证书
• 0x0003 - 解密需要密码或证书
• 0x0007 - 保留供将来使用
• 0x000F - 保留供将来使用
• 0x0100 - 表示使用了非 OAEP 密钥包装。 如果设置了此字段，则提取所需的版本必须至少为 61。这意味着使用 ErdData 生成主会话密钥时不使用 OAEP 密钥包装
• 0x4000 - ErdData 必须使用 3DES-168 解密，否则使用用于加密文件内容的相同算法
• 0x8000 - 保留供将来使用 | Modifier and Type | Method and Description | | —- | —- | | PKWareExtraHeader.EncryptionAlgorithm | getEncryptionAlgorithm()
  获取加密算法 | | PKWareExtraHeader.HashAlgorithm | getHashAlgorithm()
  获取HASH算法 | | long | getRecordCount()
  获取记录数量 | | void | parseCentralDirectoryFormat(byte[] data, int offset, int length)
  解析中央目录格式 | | void | parseFileFormat(byte[] data, int offset, int length)
  解析文件头部格式 | | void | parseFromCentralDirectoryData(byte[] data, int offset, int length)
  从此数组中填充数据，就好像它在中央目录数据中一样 | | void | parseFromLocalFileData(byte[] data, int offset, int length)
  从此数组中填充数据，就好像它在本地文件数据中一样。 |

X0019_EncryptionRecipientCertificateList

public class X0019_EncryptionRecipientCertificateList
extends PKWareExtraHeader

PKCS#7 加密收件人证书列表 (0x0019)。

该字段可以包含有关加密处理中使用的每个证书的信息，并且可以用于识别允许解密加密文件的人。 此字段应仅出现在存档额外数据记录中。 此字段不是必需的，仅用于通过保留公共加密密钥数据来帮助存档修改。 个人安全要求可能会要求省略这些数据以阻止信息泄露。

注意：所有字段以 Intel 低字节/高字节顺序存储

          Value     Size     Description
          -----     ----     -----------
 (CStore) 0x0019    2 bytes  Tag for this "extra" block type
          TSize     2 bytes  Size of the store data
          Version   2 bytes  Format version number - must 0x0001 at this time
          CStore    (var)    PKCS#7 data blob

X5455_ExtendedTimestamp

public class X5455_ExtendedTimestamp
extends Object
implements ZipExtraField, Cloneable, Serializable

一个额外的字段，用于存储 zip 条目的附加文件和目录时间戳数据。每个 zip 条目最多可以包含三个时间戳（修改、访问、创建*）。时间戳存储为 32 位有符号整数，表示自 UNIX 纪元（1970 年 1 月 1 日，UTC）以来的秒数。该字段改进了 zip 的默认时间戳粒度，因为它允许存储额外的时间戳，此外，时间戳使用每秒粒度存储（zip 的默认行为只能将时间戳存储到最接近的偶数秒）。

不幸的是，32（有符号）位只能存储 2037 年之前的日期，因此这个额外的字段最终将被淘汰。在它持续的时候享受它！

• modifyTime：文件/目录修改的最近时间（或文件/目录创建，如果条目自创建后未修改）
• accessTime：最近打开文件/目录的时间（例如，从磁盘读取）。许多人使用 NOATIME 挂载选项禁止他们的操作系统更新此值以优化磁盘行为，因此它并不总是可靠的。在这些情况下，它总是等于 modifyTime
• *createTime：现代 linux 文件系统（例如 ext2 和更新版本）似乎不会存储这样的值，因此通常在 zip 额外字段中完全省略它。也许其他 Unix 系统会跟踪这一点

我们使用 Info-Zip 源存档中给出的字段定义：zip-3.0.tar.gz/proginfo/extrafld.txt

Value         Size        Description
 -----         ----        -----------
 0x5455        Short       tag for this extra block type ("UT")
 TSize         Short       total data size for this block
 Flags         Byte        info bits
 (ModTime)     Long        time of last modification (UTC/GMT)
 (AcTime)      Long        time of last access (UTC/GMT)
 (CrTime)      Long        time of original creation (UTC/GMT)
 Central-header version:
 Value         Size        Description
 -----         ----        -----------
 0x5455        Short       tag for this extra block type ("UT")
 TSize         Short       total data size for this block
 Flags         Byte        info bits (refers to local header!)
 (ModTime)     Long        time of last modification (UTC/GMT)

X7875_NewUnix

public class X7875_NewUnix
extends Object
implements ZipExtraField, Cloneable, Serializable

存储给定 zip 条目的 UNIX UID/GID 数据（所有者和组所有权）的额外字段。 我们使用 Info-Zip 源存档中给出的字段定义：zip-3.0.tar.gz/proginfo/extrafld.txt

本地头部（local-header）版本：

Value         Size        Description
 -----         ----        -----------
 0x7875        Short       tag for this extra block type ("ux")
 TSize         Short       total data size for this block
 Version       1 byte      version of this extra field, currently 1
 UIDSize       1 byte      Size of UID field
 UID           Variable    UID for this entry (little endian)
 GIDSize       1 byte      Size of GID field
 GID           Variable    GID for this entry (little endian)

中心头部（central-header）版本：

 Value         Size        Description
 -----         ----        -----------
 0x7855        Short       tag for this extra block type ("Ux")
 TSize         Short       total data size for this block (0)

Zip64ExtendedInformationExtraField

public class Zip64ExtendedInformationExtraField
extends Object
implements ZipExtraField

保存使用 Zip64 功能的条目的大小和其他扩展信息。

目前 Commons Compress 不支持对中央目录进行加密，因此 APPNOTE.TXT 中关于屏蔽的注释不适用。

该实现依赖于从本地文件头读取的数据，并假设两个大小值始终存在。

ZipArchiveEntry

public class ZipArchiveEntry
extends ZipEntry
implements ArchiveEntry, EntryStreamOffsets

添加更好地处理额外字段并提供对内部和外部文件属性的访问的扩展。

额外的数据预计将遵循 APPNOTE.TXT 的建议：

• 额外的字节数组由一系列额外的字段组成
• 每个额外的字段都以一个两字节的标头 id 开头，后跟一个保存剩余数据长度的两字节序列。

任何无法通过上述规则解析的额外数据将被视为“不可解析”的额外数据，并由此类的方法进行不同的处理。 如果尝试读取或写入不符合建议的额外数据，则 Apache Commons Compress 1.1 之前的版本将引发异常。

这个类不是线程安全的

ZipArchiveEntryRequest

ZipArchiveEntry 的线程安全表示，用于将条目添加到并行存档。

createZipArchiveEntryRequest

public static ZipArchiveEntryRequest createZipArchiveEntryRequest(ZipArchiveEntry zipArchiveEntry, InputStreamSupplier payloadSupplier)
创建 ZipArchiveEntryRequest

Parameters:
zipArchiveEntry - 要使用的条目
payloadSupplier - 将添加到 zip 条目的有效负载

Returns:
The newly created request

ZipArchiveInputStream

public class ZipArchiveInputStream extends ArchiveInputStream
implements InputStreamStatistics

实现一个可以读取 Zip 档案的输入流。

从 Apache Commons Compress 开始，它透明地支持 Zip64 扩展，因此单个条目和存档大于 4 GB 或超过 65536 个条目。

从文件读取时首选 ZipFile 类，因为 ZipArchiveInputStream 受限于在返回条目之前无法读取中央目录标题。 特别是 ZipArchiveInputStream

• 可能会返回根本不属于中央目录的条目，不应将其视为存档的一部分
• 可能会返回多个具有相同名称的条目
• 不会返回内部或外部属性
• 可能会返回不完整的额外字段数据
• 如果存档使用数据描述符功能，则在到达下一个条目之前，可能会返回条目的未知大小和 CRC 值 | Modifier and Type | Method and Description | | —- | —- | | boolean | canReadEntryData(ArchiveEntry ae)
  此类是否能够读取给定条目 | | void | close() | | long | getCompressedCount() | | ArchiveEntry | getNextEntry()
  Returns the next Archive Entry in this Stream. | | ZipArchiveEntry | getNextZipEntry() | | long | getUncompressedCount() | | static boolean | matches(byte[] signature, int length)
  检查签名是否与 zip 文件的预期匹配 | | int | read(byte[] buffer, int offset, int length) | | long | skip(long value)
  跳过并丢弃此输入流中数据的值字节 |

ZipArchiveOutputStream

public class ZipArchiveOutputStream extends ArchiveOutputStream

java.util.zip.ZipOutputStream 的重新实现，它确实处理了这个包的扩展功能，特别是内部/外部文件属性和具有不同布局的本地文件数据和中央目录条目的额外字段。

当此类知道输出将发送到文件并且不应创建拆分存档时，该类将尝试使用 SeekableByteChannel。

如果无法使用 SeekableByteChannel，此实现将使用 Data Descriptor 来存储 DEFLATED 条目的大小和 CRC 信息，这意味着您不需要自己计算它们。不幸的是，这对于 STORED 方法是不可能的，在调用 putArchiveEntry(ArchiveEntry) 之前需要设置 CRC 和未压缩的大小信息。

从 Apache Commons Compress 1.3 开始，它透明地支持 Zip64 扩展，因此在大多数情况下，单个条目和档案大于 4 GB 或超过 65536 个条目，但通过 setUseZip64(org.apache.commons.compress.archivers.zip. Zip64 模式）。如果流无法使用 SeekableByteChannel 并且您尝试编写未知大小的 ZipArchiveEntry，则默认情况下将禁用 Zip64 扩展。

这个类不是线程安全的

ZipArchiveOutputStream.UnicodeExtraFieldPolicy

表示创建 Unicode 额外字段的可能策略的枚举

ZipEightByteInteger

表示具有 ZIP 文件小端字节顺序转换规则的八字节整数的工具类

ZipEncodingHelper

用于在 zip 文件中对文件名进行稳健编码的静态辅助函数

ZipFile

替换 java.util.ZipFile。

此类添加了对 UTF-8 以外的文件名编码的支持（这是处理由本地 zip 工具创建的 ZIP 文件所必需的，并且能够像在自解压档案中找到的那样跳过序言。此外，它返回 org.apache.commons.compress.archivers.zip.ZipArchiveEntry 的实例而不是 java.util.zip.ZipEntry。

该类并没有继承至 java.util.zip.ZipFile，因为无论如何它都必须重新实现所有方法。与 java.util.ZipFile 一样，它在后台使用 SeekableByteChannel 并支持压缩和未压缩条目。从 Apache Commons Compress 1.3 开始，它还透明地支持 Zip64 扩展，因此单个条目和存档大于 4 GB 或超过 65536 个条目。

方法签名模仿 java.util.zip.ZipFile 的方法签名，但有几个例外：

• 没有 getName 方法
• 条目已重命名为 getEntries
• getEntries 和 getEntry 返回 org.apache.commons.compress.archivers.zip.ZipArchiveEntry 实例
• close 允许抛出 IOException

Constructors

Methods

ZipLong

表示具有 ZIP 文件小端字节顺序转换规则的四字节整数的工具类

Fields

Methods

ZipShort

表示具有 ZIP 文件小端字节顺序转换规则的两字节整数的工具类

ZipSplitReadOnlySeekableByteChannel

public class ZipSplitReadOnlySeekableByteChannel extends MultiReadOnlySeekableByteChannel

MultiReadOnlySeekableByteChannel 知道拆分的 ZIP 存档应该是什么样子。

如果您想使用 ZipFile 读取拆分存档，则从存档的各个部分创建此类的实例。

ZipUtil

用于处理 DOS 和 Java 时间转换的工具类。

这个类是不可变的

PKWareExtraHeader.EncryptionAlgorithm

public static enum PKWareExtraHeader.EncryptionAlgorithm
extends Enum<PKWareExtraHeader.EncryptionAlgorithm>

PKWareExtraHeader.HashAlgorithm

public static enum PKWareExtraHeader.HashAlgorithm
extends Enum<PKWareExtraHeader.HashAlgorithm>

Zip64Mode

public enum Zip64Mode
extends Enum<Zip64Mode>

ZipArchiveEntry.CommentSource

public static enum ZipArchiveEntry.CommentSource
extends Enum<ZipArchiveEntry.CommentSource>

指示如何确定此条目的注释

ZipArchiveEntry.ExtraFieldParsingMode

public static enum ZipArchiveEntry.ExtraFieldParsingMode
extends Enum<ZipArchiveEntry.ExtraFieldParsingMode>
implements ExtraFieldParsingBehavior

如何尝试解析额外的字段。

配置以下行为：

• 如果额外的字段内容不遵循推荐的两字节 id 后跟两字节长度的模式，会发生什么？
• 如果 Commons Compress 普遍支持额外的字段，但其内容无法正确解析，会发生什么情况？ 例如，如果存档损坏、触发 Commons Compress 中的错误或额外字段使用 Commons Compress 不（尚）支持的版本，则可能会发生这种情况。 | Enum Constant and Description | | —- | | BEST_EFFORT
  尝试解析尽可能多的额外字段，并包装未知的额外字段以及无法在 UnrecognizedExtraField 中解析的受支持的额外字段 | | DRACONIC
  果无法解析任何已识别的额外字段或任何额外字段违反推荐模式，则抛出异常 | | ONLY_PARSEABLE_LENIENT
  Try to parse as many extra fields as possible and wrap unknown extra fields as well as supported extra fields that cannot be parsed in UnrecognizedExtraField. | | ONLY_PARSEABLE_STRICT
  尝试解析尽可能多的额外字段，并将未知的额外字段包装在 UnrecognizedExtraField 中 | | STRICT_FOR_KNOW_EXTRA_FIELDS
  尝试解析尽可能多的额外字段，并将未知的额外字段包装在 UnrecognizedExtraField 中 |

ZipArchiveEntry.NameSource

public static enum ZipArchiveEntry.NameSource
extends Enum<ZipArchiveEntry.NameSource>

指示如何确定此条目的名称

ZipMethod

public enum ZipMethod extends Enum<ZipMethod>

已知压缩方法列表 commons compress 目前不支持其中许多方法

org.apache.commons.compress.compressors

CompressorStreamProvider

创建 Compressor CompressorInputStreams 和 CompressorOutputStreams。

CompressorStreamFactory

public class CompressorStreamFactory extends Object
    implements CompressorStreamProvider

从名称创建 Compressor[In|Out]putStreams 的工厂。 要添加其他实现类，您应该继承 CompressorStreamFactory 并重写适当的方法（当然还要从 super 调用它们的实现）。

示例（压缩文件）：

 final OutputStream out = Files.newOutputStream(output.toPath());
 CompressorOutputStream cos = new CompressorStreamFactory()
         .createCompressorOutputStream(CompressorStreamFactory.BZIP2, out);
 IOUtils.copy(Files.newInputStream(input.toPath()), cos);
 cos.close();

示例（解压缩文件）：

final InputStream is = Files.newInputStream(input.toPath());
 CompressorInputStream in = new CompressorStreamFactory().createCompressorInputStream(CompressorStreamFactory.BZIP2,
         is);
 IOUtils.copy(in, Fi

这个类是不可变的
前提是不使用已弃用的方法 setDecompressConcatenated。

这个类是线程安全的
即使使用了已弃用的方法 setDecompressConcatenated

Fields

Methods

CompressorInputStream

CompressorOutputStream

FileNameUtil

压缩格式的文件名映射代码

org.apache.commons.compress.compressors.gzip

GzipCompressorInputStream

public class GzipCompressorInputStream
extends CompressorInputStream
implements InputStreamStatistics

解压缩 .gz 文件的输入流。支持解压缩连接的 .gz 文件，这在解压缩独立 .gz 文件时很重要。

GZIPInputStream 不解压缩连接的 .gz 文件：它在第一个成员之后停止并默默地忽略其余部分。它不会让读取位置指向下一个成员的开头，这使得解决缺乏连接支持的问题变得困难。

这个类没有使用 GZIPInputStream，而是有自己的 .gz 容器格式解码器。实际的解压缩是用 Inflater 完成的。

如果您使用带有一些 InputStream 的构造函数 GzipCompressorInputStream(in) 或 GzipCompressorInputStream(in, false)，那么一旦第一个内部成员被完全读取，read() 将返回 -1。如果有第二个 gzip 成员，则输入流将定位在第二个 gzip 成员的开头。

如果您使用带有一些 InputStream 的构造函数 GzipCompressorInputStream(in, true) ，那么一旦输入的流耗尽，read() 将返回 -1。从以这种方式构造的流中读取的数据将包含其中包含的所有 gzip 成员的连接数据。

也可以看看：
“https://tools.ietf.org/html/rfc1952”

GzipCompressorOutputStream

public class GzipCompressorOutputStream
extends CompressorOutputStream

使用 gzip 格式的压缩输出流。 此实现通过允许配置压缩级别和标头元数据（文件名、注释、修改时间、操作系统和额外标志）来改进标准 GZIPOutputStream 类。

也可以看看：GZIP File Format Specification

GzipParameters

GZIP 压缩器使用到的参数器

GzipUtils

GZIP 压缩格式工具代码

org.apache.commons.compress.compressors.gzip

ChangeSet

ChangeSet 收集并执行对存档的更改。 从多个线程中将删除更改放入此 ChangeSet 中可能会导致冲突。

这个类不是线程安全的

ChangeSetPerformer

对流执行 ChangeSet 操作。 这个类是线程安全的，可以多次使用。 它对 ChangeSet 的副本进行操作。 如果 ChangeSet 发生变化，则必须创建一个新的 Performer。

这个类是不可变的

这个类是线程安全的

ChangeSetResults

存储执行的 ChangeSet 操作的结果

org.apache.commons.compress.java.util.jar

Pack200.Packer

定义用于将 JAR 文件转换为 Pack200 格式的输出流的 API 的接口

Fields

Methods

Pack200.Unpacker

定义用于将 Pack200 格式的打包流转换为 JAR 文件的 API 的接口。

Fields

Methods

org.apache.commons.compress.parallel

InputStreamSupplier

提供输入流。 需要实现来支持线程切换。 虽然一个实例不会被多个线程同时访问，但它将由与创建它的线程不同的线程调用。

ScatterGatherBackingStore

在分散-收集方案中存储中间有效负载。 多个线程将其有效负载写入后备存储，随后可以将其反转为 InputStream 以用作收集阶段的输入。

关闭它是此类实例的分配器的责任。 关闭它应该清除所有分配的结构，最好删除文件。

ScatterGatherBackingStoreSupplier

FileBasedScatterGatherBackingStore

由文件支持的 ScatterGatherBackingStore

org.apache.commons.compress.utils

ArchiveUtils

BitInputStream

从 InputStream 中读取 bits

BoundedArchiveInputStream

NIO 支持的有界输入流，用于从中读取预定义的数据量。

该类是线程安全的。