Pack200.Packer

概述

软件包

类

使用

树

已过时

索引

帮助

Java^TM 2 Platform
Standard Ed. 5.0

上一个类 下一个类

框架 无框架

摘要：嵌套 | 字段 | 构造方法 | 方法

详细信息：字段 | 构造方法 | 方法

java.util.jar
接口 Pack200.Packer

正在封闭类：: Pack200

public static interface Pack200.Packer

打包器引擎把各种转换应用到输入 JAR 文件，从而可以通过压缩器（如 gzip 或 zip）高度压缩打包流。可使用 Pack200.newPacker() 获得该引擎的实例。高度压缩是通过使用 JSR 200 规范中描述的大量技术来实现的。一些技术包括排序、重排序和常量池的共处。

根据下面所述的打包引擎属性，将打包引擎初始化为初始状态。可以通过获取引擎属性（使用 properties()）并在映射上存储已修改属性来操作该初始状态。资源文件根本不做任何改动即可通过。类文件将不会包含相同的字节，因为解包器可以随意改变次要类文件的特性，比如常量池的顺序。但是类文件在语义上将是相同的，这在下面网址的《Java Virtual Machine Specification》中作了规定：http://java.sun.com/docs/books/vmspec/html/ClassFile.doc.html。

默认情况下，打包器不改变 JAR 元素的顺序。而且不改变每个 JAR 元素的修改时间和压缩提示。任何其他 ZIP 存档信息（如给出 Unix 文件权限的额外属性）将会丢失。

注意，打包和解包 JAR 通常将修改 JAR 中类文件的字节内容。这意味着打包和解包通常将使依赖于 JAR 元素字节图像的任何数字签名无效。为了签名并打包 JAR，您必须首先打包和解包 JAR 来“规范化”它，然后计算解包后 JAR 元素上签名，最后重新打包签名的 JAR。打包步骤应该准确地使用相同的选项，可能还需要把段范围设置为 "-1"，以防止在类文件大小有所改变时段边界的意外变化。

（其工作原理如下：打包器对任何类文件结构的任何重新排序是幂等的，因此，第二次打包不会改变第一次打包所生成的顺序。而且，JSR 200 规范保证解包器可为存档元素的任何给定传输顺序生成指定的字节图像。）

字段摘要
`static String`	`CLASS_ATTRIBUTE_PFX` 当与类属性名称连在一起时，使用 JSR 200 规范中指定的布局语言指出该属性的格式。
`static String`	`CODE_ATTRIBUTE_PFX` 当与代码属性名称连在一起时，指出该属性的格式。
`static String`	`DEFLATE_HINT` 如果将此属性设置为 `TRUE` 或 `FALSE`，则打包器将在输出存档中设置相应的压缩提示，并且不传输存档元素的单个压缩提示。
`static String`	`EFFORT` 如果将此属性设置为单个十进制数字，则打包器将在压缩存档时使用指定压缩级别。
`static String`	`ERROR` 字符串 "error"，某些属性的可能值。
`static String`	`FALSE` 字符串 "false"，某些属性的可能值。
`static String`	`FIELD_ATTRIBUTE_PFX` 当与字段属性名称连在一起时，指出该属性的格式。
`static String`	`KEEP` 字符串 "keep"，某些属性的可能值。
`static String`	`KEEP_FILE_ORDER` 如果将此属性设置为 `TRUE`，则打包器将按它们在源存档中的原始顺序传输所有元素。
`static String`	`LATEST` 字符串 "latest"，某些属性的可能值。
`static String`	`METHOD_ATTRIBUTE_PFX` 当与方法属性名称连在一起时，指出该属性的格式。
`static String`	`MODIFICATION_TIME` 如果将此属性设置为特殊的字符串 `LATEST`，则打包器将尝试在原始存档中的所有可用条目中确定最后修改时间，或者确定每个段中所有可用条目的最后修改时间。
`static String`	`PASS` 字符串 "pass"，某些属性的可能值。
`static String`	`PASS_FILE_PFX` 指出文件应该按字节传递（无压缩）。
`static String`	`PROGRESS` 解包器的百分比进度，由解包器定期更新。
`static String`	`SEGMENT_LIMIT` 此属性是一个数字，给出了每个存档段的估计目标大小 N（以字节为单位）。
`static String`	`STRIP` 字符串 "strip"，某些属性的可能值。
`static String`	`TRUE` 字符串 "true"，某些属性的可能值。
`static String`	`UNKNOWN_ATTRIBUTE` 指出遇到包含有未知属性的类文件时所采取的行动。

方法摘要
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` 为属性映射上的 PropertyChange 事件注册一个侦听器。
`void`	`pack(JarFile in, OutputStream out)` 接收 JarFile 并将其转换为 Pack200 存档。
`void`	`pack(JarInputStream in, OutputStream out)` 接收 JarInputStream 并将其转换成 Pack200 存档。
`SortedMap<String,String>`	`properties()` 获取此引擎属性的集合。
`void`	`removePropertyChangeListener(PropertyChangeListener listener)` 移除由 `addPropertyChangeListener(java.beans.PropertyChangeListener)` 所添加的 PropertyChange 事件侦听器。

字段详细信息

SEGMENT_LIMIT

static final String SEGMENT_LIMIT

此属性是一个数字，给出了每个存档段的估计目标大小 N（以字节为单位）。如果单个输入文件要求超过 N 字节，那么将给出它自己的存档段。

作为特殊情况，值 -1 将生成使用所有输入文件的单个大段，而值 0 将为每个类生成一个段。较大的存档段将带来较少的碎片和更好的压缩，但处理它们要求更多的内存。

每个段的大小是通过计算段中要传输的每个输入文件的大小，以及它的名称和其他要传输的属性的大小来估算的。

默认为 1000000（1 百万字节）。这允许在一个段中传输中等大小的输入 JAR 文件。它也限制了打包器和解包器的内存要求。

如果没有此限制，打包一个 10 Mb 的 JAR 通常要小 10%，但打包器可能要求较大的 Java 堆（大约是段范围的 10 倍）。

另请参见：: 常量字段值

KEEP_FILE_ORDER

static final String KEEP_FILE_ORDER

如果将此属性设置为 TRUE，则打包器将按它们在源存档中的原始顺序传输所有元素。

如果将其设置为 FALSE，则打包器可能重新排序元素，并且移除携带无用信息（针对 Java 应用程序来说）的 JAR 目录条目。（通常这支持更好的压缩。）

默认为 TRUE，这保存了输入信息，但可能不必要地增大了所传输的存档。

另请参见：: 常量字段值

EFFORT

static final String EFFORT

如果将此属性设置为单个十进制数字，则打包器将在压缩存档时使用指定压缩级别。1 级可能生成较大的尺寸但压缩速度较快，而 9 级将花费较长的时间，但可能生成更好的压缩。

特殊值 0 指示打包器直接复制原始的 JAR 文件（无压缩）。JSR 200 标准要求任何解包器将此特殊情况作为直接传输整个存档来理解。

默认为 5，花费适量的时间来生成合理的压缩。

另请参见：: 常量字段值

DEFLATE_HINT

static final String DEFLATE_HINT

如果将此属性设置为 TRUE 或 FALSE，则打包器将在输出存档中设置相应的压缩提示，并且不传输存档元素的单个压缩提示。

如果将此属性设置为特殊字符串 KEEP，则打包器将尝试确定输入存档中每个可用元素的单个压缩提示，并单独传输此提示。

默认为 KEEP，这保存了输入信息，但可能不必要地增大了所传输的存档。

这取决于解包器实现在提示上采取的行动，以便合适地压缩得到的未打包 jar 的元素。

ZIP 或 JAR 元素的压缩提示指出元素是压缩的还是直接存储的。

另请参见：: 常量字段值

MODIFICATION_TIME

static final String MODIFICATION_TIME

如果将此属性设置为特殊的字符串 LATEST，则打包器将尝试在原始存档中的所有可用条目中确定最后修改时间，或者确定每个段中所有可用条目的最后修改时间。此单值将作为段的一部分传输，并应用到每个段 (SEGMENT_LIMIT) 的所有条目。

这或多或少可以减少存档的传输大小，其代价是将所有已安装文件设置为单一日期。

如果将此属性设置为特殊字符串 KEEP，则打包器传输每个输入元素的单独修改时间。

默认为 KEEP，这保存了输入信息，但可能不必要地增大了所传输的存档。

这取决于解包器实现所采取的行动，以便合适地设置其输出文件中每个元素的修改时间。

另请参见：: SEGMENT_LIMIT, 常量字段值

PASS_FILE_PFX

static final String PASS_FILE_PFX

指出文件应该按字节传递（无压缩）。通过指定追加有不同字符串的其他属性，以生成具有公共前缀的属性系列，可以指定多个文件。

除了用 JAR 文件分隔符 '/' 替代系统文件分隔符以外，无任何路径名转换。

得到的文件名必须正好匹配其在 JAR 文件中出现的字符串。

如果属性值是一个目录名称，那么还将传递该目录下的所有文件。

示例：


     Map p = packer.properties();
     p.put(PASS_FILE_PFX+0, "mutants/Rogue.class");
     p.put(PASS_FILE_PFX+1, "mutants/Wolverine.class");
     p.put(PASS_FILE_PFX+2, "mutants/Storm.class");
     # Pass all files in an entire directory hierarchy:
     p.put(PASS_FILE_PFX+3, "police/");

另请参见：: 常量字段值

UNKNOWN_ATTRIBUTE

static final String UNKNOWN_ATTRIBUTE

指出遇到包含有未知属性的类文件时所采取的行动。可能值为字符串 ERROR、STRIP 和 PASS。

字符串 ERROR 意味着整体打包操作将失败，并有一个合适的解释。字符串 STRIP 意味着该属性将被删除。字符串 PASS 意味着整个类文件将在无压缩下通过（就像它是一个资源文件一样），并有合适的警告。这是此属性的默认值。

示例：


     Map p = pack200.getProperties();
     p.put(UNKNOWN_ATTRIBUTE, ERROR);
     p.put(UNKNOWN_ATTRIBUTE, STRIP);
     p.put(UNKNOWN_ATTRIBUTE, PASS);

另请参见：: 常量字段值

CLASS_ATTRIBUTE_PFX

static final String CLASS_ATTRIBUTE_PFX

当与类属性名称连在一起时，使用 JSR 200 规范中指定的布局语言指出该属性的格式。

例如，此选项的效果内置于：pack.class.attribute.SourceFile=RUH。

还允许特殊字符串 ERROR、STRIP 和 PASS，与 UNKNOWN_ATTRIBUTE 具有相同的含义。这提供了一种方式，让用户可以请求按位拒绝、清除或传递特定的属性（不进行类压缩）。

下面的代码可用于支持 JCOV 属性：


     Map p = packer.properties();
     p.put(CODE_ATTRIBUTE_PFX+"CoverageTable",       "NH[PHHII]");
     p.put(CODE_ATTRIBUTE_PFX+"CharacterRangeTable", "NH[PHPOHIIH]");
     p.put(CLASS_ATTRIBUTE_PFX+"SourceID",           "RUH");
     p.put(CLASS_ATTRIBUTE_PFX+"CompilationID",      "RUH");

下面的代码可用于清除调试属性：


     Map p = packer.properties();
     p.put(CODE_ATTRIBUTE_PFX+"LineNumberTable",    STRIP);
     p.put(CODE_ATTRIBUTE_PFX+"LocalVariableTable", STRIP);
     p.put(CLASS_ATTRIBUTE_PFX+"SourceFile",        STRIP);

另请参见：: 常量字段值

FIELD_ATTRIBUTE_PFX

static final String FIELD_ATTRIBUTE_PFX

当与字段属性名称连在一起时，指出该属性的格式。例如，此选项的效果内置于：pack.field.attribute.Deprecated=。还允许特殊字符串 ERROR、STRIP 和 PASS。

另请参见：: CLASS_ATTRIBUTE_PFX, 常量字段值

METHOD_ATTRIBUTE_PFX

static final String METHOD_ATTRIBUTE_PFX

当与方法属性名称连在一起时，指出该属性的格式。例如，此选项的效果内置于：pack.method.attribute.Exceptions=NH[RCH]。还允许特殊字符串 ERROR、STRIP 和 PASS。

另请参见：: CLASS_ATTRIBUTE_PFX, 常量字段值

CODE_ATTRIBUTE_PFX

static final String CODE_ATTRIBUTE_PFX

当与代码属性名称连在一起时，指出该属性的格式。例如，此选项的效果内置于：pack.code.attribute.LocalVariableTable=NH[PHOHRUHRSHH]。还允许特殊字符串 ERROR、STRIP 和 PASS。

另请参见：: CLASS_ATTRIBUTE_PFX, 常量字段值

PROGRESS

static final String PROGRESS

解包器的百分比进度，由解包器定期更新。值 0 - 100 是正常的，-1 指示停止。用 PropertyChangeListener 观察此属性。

至少，解包器必须在打包操作开始时把进度设置为 0，在结束时把进度设置为 100。

另请参见：: addPropertyChangeListener(java.beans.PropertyChangeListener), 常量字段值

KEEP

static final String KEEP

字符串 "keep"，某些属性的可能值。

另请参见：: DEFLATE_HINT, MODIFICATION_TIME, 常量字段值

PASS

static final String PASS

字符串 "pass"，某些属性的可能值。

另请参见：: UNKNOWN_ATTRIBUTE, CLASS_ATTRIBUTE_PFX, FIELD_ATTRIBUTE_PFX, METHOD_ATTRIBUTE_PFX, CODE_ATTRIBUTE_PFX, 常量字段值

STRIP

static final String STRIP

字符串 "strip"，某些属性的可能值。

另请参见：: UNKNOWN_ATTRIBUTE, CLASS_ATTRIBUTE_PFX, FIELD_ATTRIBUTE_PFX, METHOD_ATTRIBUTE_PFX, CODE_ATTRIBUTE_PFX, 常量字段值

ERROR

static final String ERROR

字符串 "error"，某些属性的可能值。

另请参见：: UNKNOWN_ATTRIBUTE, CLASS_ATTRIBUTE_PFX, FIELD_ATTRIBUTE_PFX, METHOD_ATTRIBUTE_PFX, CODE_ATTRIBUTE_PFX, 常量字段值

TRUE

static final String TRUE

字符串 "true"，某些属性的可能值。

另请参见：: KEEP_FILE_ORDER, DEFLATE_HINT, 常量字段值

FALSE

static final String FALSE

字符串 "false"，某些属性的可能值。

另请参见：: KEEP_FILE_ORDER, DEFLATE_HINT, 常量字段值

LATEST

static final String LATEST

字符串 "latest"，某些属性的可能值。

另请参见：: MODIFICATION_TIME, 常量字段值

方法详细信息

properties

SortedMap<String,String> properties()

获取此引擎属性的集合。此集合是“实时视图”，所以更改其内容可立即影响 Packer 引擎，并且在映射中可立即见到引擎中的变化（如进度指示）。

属性映射可能包含指定和默认属性的预定义实现。鼓励用户在修改已存在的属性前阅读该信息，并完全理解其含意。

特定实现的属性是用与实现者相关的包名称作前缀的，以 com. 或类似前缀开头。以 pack. 和 unpack. 开头的所有属性名称保留给此 API 使用。

未知属性可以用未指定的错误忽略或拒绝，并且无效的条目可能导致抛出未指定的错误。

返回的映射实现了所有可选的 SortedMap 操作。

返回：: 属性键字符串到属性值的有序关联。

pack

void pack(JarFile in,
          OutputStream out)
          throws IOException

接收 JarFile 并将其转换为 Pack200 存档。

关闭其输入，但并不关闭其输出。（Pack200 存档是可追加的。）

参数：: in - 一个 JarFile; out - 一个 OutputStream
抛出：: IOException - 如果遇到错误

pack

void pack(JarInputStream in,
          OutputStream out)
          throws IOException

接收 JarInputStream 并将其转换成 Pack200 存档。

关闭其输入，但并不关闭其输出。（Pack200 存档是可追加的。）

对于 JAR 清单文件及其包含的目录，修改时间和压缩提示属性是不可用的。

参数：: in - 一个 JarInputStream; out - 一个 OutputStream
抛出：: IOException - 如果遇到错误
另请参见：: MODIFICATION_TIME, DEFLATE_HINT

addPropertyChangeListener

void addPropertyChangeListener(PropertyChangeListener listener)

为属性映射上的 PropertyChange 事件注册一个侦听器。通常应用程序使用它来更新进度条。

参数：: listener - 更改属性时要调用的对象。
另请参见：: properties(), PROGRESS

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener listener)

移除由 addPropertyChangeListener(java.beans.PropertyChangeListener) 所添加的 PropertyChange 事件侦听器。

参数：: listener - 要移除的 PropertyChange 侦听器。
另请参见：: addPropertyChangeListener(java.beans.PropertyChangeListener)

概述