Greplin Bloom Filter 技术文档

1. 安装指南

1.1 环境准备

在安装和使用 Greplin Bloom Filter 之前，请确保您的系统已经安装了以下工具：

• Maven：用于构建和管理 Java 项目。

1.2 安装步骤

1. 打开终端或命令行工具。
2. 克隆项目代码库：

   git clone https://github.com/Greplin/greplin-bloom-filter.git
   

3. 进入项目目录：

   cd greplin-bloom-filter
   

4. 使用 Maven 安装项目：

   mvn install
   

2. 项目的使用说明

2.1 创建 Bloom Filter

您可以通过以下代码创建一个 Bloom Filter 实例：

final File onDiskFile = new File("/tmp/greplin-bloom-filter.bin");
final int expectedItems = 10000;
final double desiredFalsePositiveRate = 0.000001;

BloomFilter bloomFilter = new BloomFilter.NewBuilder(onDiskFile, expectedItems, desiredFalsePositiveRate)
    .force(true) // 强制覆盖已有文件
    .build();

2.2 添加和查询元素

您可以向 Bloom Filter 中添加元素，并检查元素是否存在：

final byte[] exampleItemA = "Hello World!".getBytes(Charset.forName("UTF-8"));
final byte[] exampleItemB = "Goodbye Cruel world".getBytes(Charset.forName("UTF-8"));

bloomFilter.add(exampleItemA);
bloomFilter.add(exampleItemB);

System.out.println(bloomFilter.contains(exampleItemA)); // true
System.out.println(bloomFilter.contains(exampleItemB)); // true

2.3 删除元素

如果使用的是计数桶（counting buckets），您可以删除元素：

bloomFilter.remove(exampleItemB);
System.out.println(bloomFilter.contains(exampleItemB)); // false

2.4 关闭和重新打开 Bloom Filter

您可以关闭 Bloom Filter 并从磁盘文件中重新打开它：

bloomFilter.close();
bloomFilter = null;

bloomFilter = new BloomFilter.OpenBuilder(onDiskFile).build();
System.out.println(bloomFilter.contains(exampleItemA)); // true

3. 项目API使用文档

3.1 BloomFilter 类

• NewBuilder(File file, int expectedItems, double falsePositiveRate): 创建一个新的 Bloom Filter 构建器。
  • file: 磁盘文件路径，如果为 null，则 Bloom Filter 仅在内存中。
  • expectedItems: 预计存储的元素数量。
  • falsePositiveRate: 期望的误报率。
• OpenBuilder(File file): 从磁盘文件中打开一个已有的 Bloom Filter。
• add(byte[] item): 向 Bloom Filter 中添加元素。
• contains(byte[] item): 检查元素是否存在于 Bloom Filter 中。
• remove(byte[] item): 从 Bloom Filter 中删除元素（仅在计数桶模式下有效）。
• close(): 关闭 Bloom Filter 并释放资源。

3.2 构建器选项

• force(boolean force): 强制覆盖已有文件。
• bitsPerBucket(int bitsPerBucket): 设置每个桶的位数（默认为 8）。

4. 项目安装方式

4.1 使用 Maven 安装

通过 Maven 安装项目是最常见的方式。您只需在项目根目录下运行以下命令：

mvn install

4.2 手动编译

如果您不使用 Maven，也可以手动编译项目：

1. 进入项目目录。
2. 使用 javac 编译 Java 文件：

   javac -d target src/main/java/com/greplin/*.java
   

3. 将编译后的类文件打包成 JAR 文件：

   jar cf greplin-bloom-filter.jar -C target .
   

通过以上步骤，您可以成功安装并使用 Greplin Bloom Filter 项目。