Golang高性能嵌入式键值存储与数据结构插件库NutsDB的使用

什么是NutsDB?

NutsDB是一个用纯Go编写的简单、快速、可嵌入且持久化的键值存储库。它支持完全可序列化的事务和多种数据结构，如列表、集合、有序集合等。所有操作都在事务(Tx)内部进行。

架构图

快速开始

安装NutsDB

首先需要安装Go(1.18+版本)，然后运行go get:

go get -u github.com/nutsdb/nutsdb

打开数据库

要打开数据库，使用nutsdb.Open()函数并指定适当的选项。Dir、EntryIdxMode和SegmentSize选项必须由客户端指定。

package main

import (
    "log"

    "github.com/nutsdb/nutsdb"
)

func main() {
    // 打开位于/tmp/nutsdb目录中的数据库
    // 如果不存在将被创建
    db, err := nutsdb.Open(
        nutsdb.DefaultOptions,
        nutsdb.WithDir("/tmp/nutsdb"),
    )
    if err != nil {
        log.Fatal(err)
    }
    defer db.Close()

    ...
}

完整示例Demo

下面是一个完整的NutsDB使用示例，展示了基本的键值操作：

package main

import (
	"fmt"
	"log"

	"github.com/nutsdb/nutsdb"
)

func main() {
	// 打开数据库
	db, err := nutsdb.Open(
		nutsdb.DefaultOptions,
		nutsdb.WithDir("/tmp/nutsdb"), // 数据库目录
	)
	if err != nil {
		log.Fatal(err)
	}
	defer db.Close()

	// 创建bucket
	bucket := "bucket1"

	// 写入数据
	err = db.Update(func(tx *nutsdb.Tx) error {
		key := []byte("key1")
		value := []byte("value1")
		return tx.Put(bucket, key, value, 0) // 0表示永不过期
	})
	if err != nil {
		log.Fatal(err)
	}

	// 读取数据
	err = db.View(func(tx *nutsdb.Tx) error {
		key := []byte("key1")
		if entry, err := tx.Get(bucket, key); err != nil {
			return err
		} else {
			fmt.Printf("Got value: %s\n", string(entry.Value))
		}
		return nil
	})
	if err != nil {
		log.Fatal(err)
	}

	// 删除数据
	err = db.Update(func(tx *nutsdb.Tx) error {
		key := []byte("key1")
		return tx.Delete(bucket, key)
	})
	if err != nil {
		log.Fatal(err)
	}

	// 验证数据是否已删除
	err = db.View(func(tx *nutsdb.Tx) error {
		key := []byte("key1")
		if _, err := tx.Get(bucket, key); err != nil {
			if err == nutsdb.ErrKeyNotFound {
				fmt.Println("Key not found (as expected after deletion)")
				return nil
			}
			return err
		}
		return nil
	})
	if err != nil {
		log.Fatal(err)
	}
}

数据结构操作示例

列表(List)操作示例

func listExample(db *nutsdb.DB) {
	bucket := "listBucket"
	
	// 从列表左侧推入元素
	err := db.Update(func(tx *nutsdb.Tx) error {
		return tx.LPush(bucket, []byte("listKey"), []byte("value1"), []byte("value2"))
	})
	if err != nil {
		log.Fatal(err)
	}

	// 从列表右侧弹出元素
	err = db.Update(func(tx *nutsdb.Tx) error {
		if item, err := tx.RPop(bucket, []byte("listKey")); err != nil {
			return err
		} else {
			fmt.Printf("Popped value: %s\n", string(item))
		}
		return nil
	})
	if err != nil {
		log.Fatal(err)
	}
}

集合(Set)操作示例

func setExample(db *nutsdb.DB) {
	bucket := "setBucket"
	
	// 添加元素到集合
	err := db.Update(func(tx *nutsdb.Tx) error {
		return tx.SAdd(bucket, []byte("setKey"), []byte("member1"), []byte("member2"))
	})
	if err != nil {
		log.Fatal(err)
	}

	// 检查元素是否在集合中
	err = db.View(func(tx *nutsdb.Tx) error {
		if ok, err := tx.SIsMember(bucket, []byte("setKey"), []byte("member1")); err != nil {
			return err
		} else {
			fmt.Printf("Is member: %v\n", ok)
		}
		return nil
	})
	if err != nil {
		log.Fatal(err)
	}
}

有序集合(Sorted Set)操作示例

func sortedSetExample(db *nutsdb.DB) {
	bucket := "zsetBucket"
	
	// 添加元素到有序集合
	err := db.Update(func(tx *nutsdb.Tx) error {
		return tx.ZAdd(bucket, []byte("zsetKey"), 80, []byte("member1"))
	})
	if err != nil {
		log.Fatal(err)
	}

	// 获取元素分数
	err = db.View(func(tx *nutsdb.Tx) error {
		if score, err := tx.ZScore(bucket, []byte("zsetKey"), []byte("member1")); err != nil {
			return err
		} else {
			fmt.Printf("Score: %f\n", score)
		}
		return nil
	})
	if err != nil {
		log.Fatal(err)
	}
}

注意事项

1. 从v0.9.0开始，DefaultOptions中的defaultSegmentSize已从8MB调整为256MB。如果需要使用原来的默认值，需要手动更改为8MB。

2. 在nutsdb v1.0.0之后，由于底层数据存储协议的变化，旧版本的数据不兼容。在使用新版本前需要重写数据。

3. 当前版本的Bucket需要手动创建。