用 Java 实现一个可用的布隆过滤器(Bloom Filter)

原文地址:https://www.inlighting.org/archives/java-implement-bloom-filter/

布隆过滤器可以使用极少的空间来判断一个元素是否存在某一个集合中,本文不具体讨论布隆过滤器的原理,而是探讨如何实现一个可用的布隆过滤器。

实现源代码:https://github.com/Smith-Cruise/java-bloom-filter

本文代码提取自 Apache ORC 项目。

基本概念

这里附带一些链接,适合不了解布隆过滤器的人阅读。

误算率 False Positive

使用布隆过滤器时要注意:一个元素经过计算不存在时,那它一定不存在该集合中。但是如果一个元素经过计算存在时,它并不一定存在该集合中,所以其产生了一定的误算率。

所以设计一个可用的布隆过滤器,必须要确保它的误算率低。

这里我们令布隆过滤器 hasn 函数个数为 k,有 m 个 bits,期望插入数字个数为 n,误算率为 FPP

最佳 hash 函数数量计算公式
k=\frac{m}{n}ln2,k\geq 0
k 为此值能够确保误算率最低。

最佳 bits 个数计算公式
m=-\frac{n \cdot ln{FPP}}{(ln2)^2}

想知道上面两个公式如何推导的,可以参考:https://en.wikipedia.org/wiki/Bloom_filter#Optimal_number_of_hash_functions

这里我们假设希望误算率维持在 5%,预期会有 100 个元素插入。
m=-\frac{100 \cdot ln{0.05}}{(ln2)^2} \approx 640

k=\frac{640}{100}ln2 \approx 4

故该布隆过滤器的大小应有 640 个 bits 和 4 个 hash 函数。

Hash 函数设计

一个好的 Hash 函数就是要降低碰撞率,这里我们使用 Murmur Hash 3 作为 Hash 函数,它计算速度快,而且经过广泛的测试。

Hash 函数的实现已经附带在源码中了。

Bitset

Java 作为一门高级语言,没有直接提供传统的 bit 操作。但是我们可以参考官方的 Bitset 源码实现,自己设计一个 Bitset。之所以不使用官方的 Bitset,是因为其过为复杂,没有必要。

我们使用 long 数组来存放每一个 bit。在 Java 中,一个 long 占用 64 个 bit,这样可以一次性多存点。

序列化

我们生成的布隆过滤器肯定要支持持久化到磁盘中,这里我们使用 protobuf 来作为序列化框架。序列化的 proto 文件代码如下:

message BloomFilter {
  required uint32 numHashFunctions = 1;
  repeated fixed64 bitset = 2;
}

我们只要保存 hash 函数的个数和 bitset 即可。bitset 使用 fixed64 类型是因为 long 占用 64 个 bit,bitset 使用 repeated 修饰是因为其为一个 long 数组。

源码食用方法

首先系统安装完成 protoc,用于编译 protobuf 文件。

在源码目录执行命令 protoc --java_out=src/main/java src/main/resources/BloomFilter.proto

测试代码如下,先生成一个布隆过滤器,填充值后序列化到磁盘中名为 bloom_filter 文件。然后读取文件,检测某个值是否添加过:

package org.inlighting;

import org.inlighting.proto.BloomFilterProtos;

import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.nio.charset.StandardCharsets;

public class Test {

    private static final String STORE_PATH = "bloom_filter";

    public static void main(String[] args) throws IOException {

        // Serialize to bloom_filter to disk.
        {
            BloomFilter bloomFilter = new BloomFilter(10, 0.05);
            System.out.println(bloomFilter.toString());
            bloomFilter.addString("Hello World");
            bloomFilter.addLong(2L);
            bloomFilter.addLong(1);
            bloomFilter.add("ni".getBytes(StandardCharsets.UTF_8));
            BloomFilterProtos.BloomFilter.Builder builder = BloomFilterProtos.BloomFilter.newBuilder();
            BloomFilterIO.serialize(builder, bloomFilter);
            builder.build().writeTo(new FileOutputStream(STORE_PATH));
        }


        // read from bloom_filter
        {
            BloomFilterProtos.BloomFilter bloomFilterProtos =
                    BloomFilterProtos.BloomFilter.parseFrom(new FileInputStream(STORE_PATH));
            BloomFilter bloomFilter =  BloomFilterIO.deserialize(bloomFilterProtos);
            System.out.println(bloomFilter.testString("Hello World")); // true
            System.out.println(bloomFilter.testLong(2)); // true
            System.out.println(bloomFilter.testLong(2L)); // true
            System.out.println(bloomFilter.testLong(1)); // true
            System.out.println(bloomFilter.testLong(1L)); // true
            System.out.println(bloomFilter.test("ni".getBytes(StandardCharsets.UTF_8))); // true
            System.out.println(bloomFilter.test("hao".getBytes(StandardCharsets.UTF_8))); // false
            System.out.println(bloomFilter.testString("hello world")); // false
            System.out.println(bloomFilter.testLong(3)); // false
        }
    }
}

输出结果:

numBits: 64, numHashFunctions: 4
true
true
true
true
true
true
false
false
false

生成的 BloomFilter 占用空间 11B,比较理想。

后序看有没有必要把这个封装成一个 jar 包上传到 Maven 中央仓库供调用。

结尾附带一个 Bloom Filter 计算器,可以在线计算需要的 hash 函数的个数和空间:https://krisives.github.io/bloom-calculator/

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,271评论 5 466
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,725评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,252评论 0 328
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,634评论 1 270
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,549评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 47,985评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,471评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,128评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,257评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,233评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,235评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,940评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,528评论 3 302
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,623评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,858评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,245评论 2 344
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,790评论 2 339

推荐阅读更多精彩内容