无敌的leveldb,可打包进应用的kv数据库

在研究区块链的过程中,无意得知indexedDB的底层是基于leveldb的,瞬间被谷歌大神们的神通吓跪了。在通读了对leveldb的解释文章之后,发现这类文章根本不适合我这类并不需要对leveldb底层了解太多的读者。对于我们前端开发而言,更多要了解的是它怎么用。然而网上对怎么用反而介绍对少,对它底层的实现介绍的反而很多。可能是它的底层实现真的太出众了,所以大家都趋之若鹜,而它的api实在是少的可怜,如果不要什么特别的需求,三个api就够了:put, get, del。为了让前端开发者也有机会使用它,我专门写这篇文章来对它的使用进行介绍。

leveldb简介

LevelDB是Google传奇工程师Jeff Dean和Sanjay Ghemawat开源的KV存储引擎(而非SQL),它和我介绍过的indexedDB一样,是一种非关系型数据库。然而,它比indexedDB底层的多,indexedDB有三层概念:database->store->objects的概念,而leveldb只有一层,即objects,也即key-value。相当于一个库就是一堆key-value,而由于它的一个库是对应一个文件目录,所以它其实也没有库的概念。而最令人喜爱的是,它不需要依赖任何服务,和sqlite一样,它完全只依赖文件系统,它与redis完全不同,redis是完全依赖内存,并且需要起一个服务,而leveldb是依赖文件系统,内存只是它的一个写操作的中转站,而且它不需要起服务,可以直接打包进应用里面,作为一个应用的内部数据存储引擎。因此,在应用领域,就有了sqlite和leveldb这两个非常不错的选择。

node项目中使用leveldb

由于leveldb是依赖于文件系统,因此,你的程序需要对系统有读写权限,所以我们只能在node中使用leveldb。而如果你的js代码是运行在browser内,那应该使用indexeddb作为代替,毕竟indexeddb底层也是依赖leveldb。

在node项目中非常容易使用leveldb,通过npm安装:

npm install --save level

然后在代码中这样:

import level from "level";
const db = level(__dirname + "/data");
// 写入数据
db.put("key", "value").then(...)
// 读取数据
db.get("key").then(value => {...})
// 删除数据
db.del("key").then(...)

非常简单,而且可以直接使用promise。

但是和indexedDB相比,它还没有事务,所以要确保数据的顺序操作,必须自己在程序中严格控制代码的位置,以及做各种校验。不过你也不用太担心,它有一套日志系统,当你的一个读写操作失败时,它能通过日志系统对你的数据进行复原,不会导致你的数据被破坏。

为leveldb创建索引

很遗憾,leveldb并没有提供索引功能,它只能通过key值进行查询。level这个package提供来createReadStream方法,在这个方法里面可以传入options来进行一些控制,但是代码并不直观。之所以没有提供索引,可能是发明者觉得就以leveldb的读取性能,完全可以全量查找,根本用不着建索引。但是这样给我们带来了不便,我们习惯用索引去检索一些非主键的字段。

说到这里,有一点:leveldb默认保存的不是js对象,而是字符串。如果要保存为对象,可以在level函数第二个参数加入{ valueEncoding: "json" }来让保存的js对象以json的形式读取,加上之后就像indexedDB一样,写入和读取都像是js的原始对象。

那么到底怎么给leveldb建索引呢?我们需要用到一个level-sublevel的package。这个package的作用是在当前数据库的section中建立一个subsection,这就有了indexeddb里面的store的味道,但是还是不同,store里面包含了index,所以其实store的概念和leveldb的库的概念基本同级。

我们建立一个subsection作为索引的存储位置,在这个section里面保存索引信息。在按索引检索时,先从这个section里面把某一个索引对应的全部值的主键找出来,然后通过这些主键,去主section里面把这些所有值找出来。由于leveldb的读写性能很高,所以基本不用担心这种分两步走的操作。

import level from "level";
import sublevel from "level-sublevel";
export default class LevelDB {
    constructor(options) {
        this.options = options;
        this.path = options.path;
        this.db = sublevel(level(this.path, { valueEncoding: "json" }));
    }
    async index(indexes) {
        this.indexdb = this.db.sublevel("index");
        db.pre(async (input) => {
            let value = input.value;
            let key = input.key;
            if (typeof value !== "object") {
                return;
            }
            for (let index of indexes) {
                if (typeof value[index] !== "undefined") {
                    let prevValue = await this.indexdb.get(index);
                    let newValue = prevValue ? prevValue.concat([key]) : [key];
                    await this.indexdb.put(index + ":" + value[index], newValue);
                }
            }
        });
    }
    put(key, value) {
        return this.db.put(key, value);
    }
    get(key) {
        return this.db.get(key);
    }
    del(key) {
        return this.db.del(key);
    }
    async query(index, value) {
        let results = [];
        let keys = await this.indexdb.get(index + ":" + value);
        if (keys.length) {
            for (let key of keys) {
                let res = await this.db.get(key);
                results.push(res);
            }
        }
        return results;
    }
}

上面是对整个功能的封装,用户可以拿这个类当作leveldb来用,在leveldb原始三个基础方法上多了index和query两个方法,主要就是针对索引来用的。

看下具体怎么用:

import LevelDB from "./leveldb.class.js";
let db = new LevelDB({ path: __dirname + "/data" });
await db.index([ "name", "age" ]);
await db.put("1001", { id: "1001", name: "lily", age: 10 });
await db.put("1002", { id: "1002", name: "lucy", age: 11 });
let results = await db.query("name", "lily");

需要注意的是,db.query的结果是一个数组,这个数组包含了所有key等于value的记录。

将leveldb作为你的应用数据存储引擎

在一些nodejs项目中,例如electron项目中,你不可能要求运行你的应用的客户机器上一定安装了mysql或者redis,而如果要安装这些服务,它们本身是项目之外的,你不能保证它们安装时的配置是你的应用想要的。而如果把数据存储引擎内置在项目里面,比如在项目中使用sqlite和leveldb,就不需要用户自己去安装其他的数据库,同时又能享受到这种数据存储的便捷。

一般而言,在你发布项目代码时,是不应该把数据库产生的具体文件也加入到git中的,用户拿到的,应该是一份干净的应用,只有他自己去运行之后,才会产生新的数据。但是在一些特殊情况下,你发布的每一个不同版本的初始数据可能不同,那就有可能直接将数据库文件也打包进你自己的应用中。甚至或者,你的应用本身就是需要这些初始数据来作为界面渲染的前提,比如一些安卓的应用,它们也内置来leveldb作为自己的数据存储引擎,它们一开始的时候,机会初始化好数据库,然后再由用户逐渐写入自己的新数据。

2018-03-12 1408

为价值买单

本文价值14.08RMB