每日一库之实战项目推荐：rosedb

如果你对 Go 开发 K-V 数据库感兴趣，可以看看该项目。本文是项目作者投稿，来源项目的 README。项目地址：https://github.com/roseduan/rosedb

rosedb 是一个简单、内嵌的 k-v 数据库，使用 Golang 实现，支持多种数据结构，包含 String、List、Hash、Set、Sorted Set，接口名称风格和 Redis 类似，如果你对 Redis 比较熟悉，那么使用起来会毫无违和感。

为什么会做这个项目

大概半年前（2020 年中），我刚开始学习 Go 语言，由于之前有 Java 语言的经验，加上 Go 的基本语法较简单，上手还是很快，但是学完基础的语法知识之后，就不知道下一步应该做什么了。

一个偶然的机会，我在网上看到了一篇介绍数据库模型的文章，文章很简单，理解起来也很容易，加上我对于数据库还是比较感兴趣的，因此想着可以自己实现一个，造个轮子来玩玩，借此巩固自己的一些基础知识。

因此这个项目也是学习并巩固 Go 相关知识的不错的素材，通过实践这个项目，你至少可以学到：

• Golang 大多数基础语法，以及一些高级特性比如 goroutine、chan、mutex
• 数据结构及算法相关知识，链表，哈希表，跳表等
• 操作系统的一些知识，特别是对文件系统，内存映射相关

由于个人能力有限，因此欢迎大家提 Issue 和 Pr，一起完善这个项目。

介绍

一个 rosedb 实例，其实就是系统上的一个文件夹，在这个文件夹中，除了一些配置外，最主要的便是数据文件。一个实例中，只会存在一个活跃的数据文件进行写操作，如果这个文件的大小达到了设置的上限，那么这个文件会被关闭，然后创建一个新的活跃文件。

其余的文件，我称之为已归档文件，这些文件都是已经被关闭，不能在上面进行写操作，但是可以进行读操作。

所以整个数据库实例就是当前活跃文件、已归档文件、其他配置的一个集合：

在每一个文件中，写数据的操作只会追加到文件的末尾，这保证了写操作不会进行额外的磁盘寻址。写入的数据是以一个个被称为 Entry 的结构组织起来的，Entry 的主要数据结构如下：

因此一个数据文件可以看做是多个 Entry 的集合：

当写入数据时，如果是 String 类型，为了支持 string 类型的 key 前缀扫描和范围扫描，我将 key 存放到了跳表中，如果是其他类型的数据，则直接存放至对应的数据结构中。然后将 key、value 等信息，封装成 Entry 持久化到数据文件中。

如果是删除操作，那么也会被封装成一个 Entry，标记其是一个删除操作，然后持久化到数据文件中，这样的话就会带来一个问题，数据文件中可能会存在大量的冗余数据，造成不必要的磁盘空间浪费。为了解决这个问题，我写了一个 reclaim 方法，你可以将其理解为对数据文件进行重新整理，使其变得更加的紧凑。

reclaim 方法的执行流程也比较的简单，首先建立一个临时的文件夹，用于存放临时数据文件。然后遍历整个数据库实例中的所有已归档文件，依次遍历数据文件中的每个 Entry，将有效的 Entry 写到新的临时数据文件中，最后将临时文件拷贝为新的数据文件，原数据文件则删除。

这样便使得数据文件的内容更加紧凑，并且去除了无用的 Entry，避免占据额外的磁盘空间。

使用

命令行操作

切换目录到 rosedb/cmd/server

运行 server 目录下的 main.go

打开一个新的窗口，切换目录到 rosedb/cmd/cli

运行目录下的 main.go

内嵌使用

在项目中 import 我的项目：

import "github.com/roseduan/rosedb"

然后打开数据库并执行相应的操作：

package main

import (
 "github.com/roseduan/rosedb"
 "log"
)

func main() {
 config := rosedb.DefaultConfig()
 db, err := rosedb.Open(config)
 
 if err != nil {
  log.Fatal(err)
 }
 
  // 别忘记关闭数据库哦！
 defer db.Close()
 
 //...
}

支持的命令

String

• Set
• SetNx
• Get
• GetSet
• Append
• StrLen
• StrExists
• StrRem
• PrefixScan
• RangeScan
• Expire
• Persist
• TTL

List

• LPush
• RPush
• LPop
• RPop
• LIndex
• LRem
• LInsert
• LSet
• LTrim
• LRange
• LLen

Hash

• HSet
• HSetNx
• HGet
• HGetAll
• HDel
• HExists
• HLen
• HKeys
• HValues

Set

• SAdd
• SPop
• SIsMember
• SRandMember
• SRem
• SMove
• SCard
• SMembers
• SUnion
• SDiff

Zset

• ZAdd
• ZScore
• ZCard
• ZRank
• ZRevRank
• ZIncrBy
• ZRange
• ZRevRange
• ZRem
• ZGetByRank
• ZRevGetByRank
• ZScoreRange
• ZRevScoreRange