LZF Compressor 技术文档

1. 安装指南

1.1 环境要求

• JDK 6 或更高版本（1.0.4 及以下版本需要 JDK 6，1.1 及以上版本需要 JDK 8）
• 无外部依赖

1.2 Maven 依赖

在 pom.xml 文件中添加以下依赖：

<dependency>
  <groupId>com.ning</groupId>
  <artifactId>compress-lzf</artifactId>
  <version>1.1.2</version>
</dependency>

1.3 JPMS 模块

从 1.1 版本开始，module-info.class 已包含在项目中，模块名为 com.ning.compress.lzf，因此需要在模块中添加以下内容：

requires com.ning.compress.lzf;

2. 项目使用说明

2.1 压缩与解压缩

LZF Compressor 提供了两种方式进行压缩和解压缩：

2.1.1 流式操作

通过流式操作进行压缩和解压缩：

InputStream in = new LZFInputStream(new FileInputStream("data.lzf"));
OutputStream out = new LZFOutputStream(new FileOutputStream("results.lzf"));
InputStream compIn = new LZFCompressingInputStream(new FileInputStream("stuff.txt"));

2.1.2 块操作

通过块操作进行压缩和解压缩：

byte[] compressed = LZFEncoder.encode(uncompressedData);
byte[] uncompressed = LZFDecoder.decode(compressedData);

2.2 命令行工具

LZF Compressor 还提供了命令行工具，可以通过以下命令使用：

java -jar compress-lzf-1.1.2.jar

该命令将显示压缩（-c）或解压缩（-d）文件所需的参数。

3. 项目 API 使用文档

3.1 压缩 API

3.1.1 LZFEncoder.encode(byte[] data)

• 功能: 对输入的字节数组进行压缩。
• 参数: data - 需要压缩的字节数组。
• 返回值: 压缩后的字节数组。

3.1.2 LZFOutputStream

• 功能: 提供流式压缩输出。
• 使用示例:

OutputStream out = new LZFOutputStream(new FileOutputStream("results.lzf"));
out.write(data);
out.close();

3.2 解压缩 API

3.2.1 LZFDecoder.decode(byte[] data)

• 功能: 对输入的字节数组进行解压缩。
• 参数: data - 需要解压缩的字节数组。
• 返回值: 解压缩后的字节数组。

3.2.2 LZFInputStream

• 功能: 提供流式解压缩输入。
• 使用示例:

InputStream in = new LZFInputStream(new FileInputStream("data.lzf"));
byte[] buffer = new byte[1024];
int len;
while ((len = in.read(buffer)) != -1) {
    // 处理解压缩后的数据
}
in.close();

4. 项目安装方式

4.1 通过 Maven 安装

在项目的 pom.xml 文件中添加以下依赖：

<dependency>
  <groupId>com.ning</groupId>
  <artifactId>compress-lzf</artifactId>
  <version>1.1.2</version>
</dependency>

4.2 通过 JPMS 模块安装

在模块中添加以下内容：

requires com.ning.compress.lzf;

4.3 命令行工具安装

下载 compress-lzf-1.1.2.jar 文件，并通过以下命令使用：

java -jar compress-lzf-1.1.2.jar

该命令将显示压缩或解压缩文件所需的参数。