# MaybeDB

**Repository Path**: dpwgc/maybe-db

## Basic Information

- **Project Name**: MaybeDB
- **Description**: 基于Golang整合Nacos的分布式k-v内存数据库。支持主从复制(一主多从/多主多从)。支持数据持久化。可插入string、int64、map、array类型的值。可使用等值查找、关键字检索和前缀检索方法搜索数据。可对数据设置过期时间，实时清除过期数据。
- **Primary Language**: Go
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-12-16
- **Last Updated**: 2022-01-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Go语言, Gin, 服务器应用, 数据库服务, Server

## README

# MaybeDB

## 基于Golang整合Nacos的分布式键值型内存数据库

`Golang` `Gin` `Nacos` `sync.Map`

***

### 集群实现功能

* 主从节点读写分离：主节点负责插入/删除数据，从节点负责查询数据。

* 高可用：支持一主多从集群部署或多主多从集群部署，单个主节点宕机重启后，可拉取其他健康的主节点的数据或从本地持久化文件中提取数据来进行数据恢复。

* 主节点之间数据同步：在任意一个主节点进行数据插入/删除操作，该操作都会扩散同步到其他主节点。

* 主从节点数据同步：从节点从Nacos上获取任意一个健康的主节点实例，向目标主节点实例发出同步请求，并将请求结果解析同步到本地。

### 单机实现功能

* 数据持久化与重启数据恢复

* 插入数据（value的类型：支持string、int64、map、int类型数组）

* 根据key查找数据

* 根据key中关键字获取数据列表

* 根据key的前缀获取数据列表

* 获取全部数据

* 统计数据总数

* 给数据设置过期时间

* 自动清除过期数据

* 删除数据

***

### 项目结构

##### clientConn 客户端连接

* set.go `存储数据相关操作`

* get.go `获取数据相关操作`

* del.go `删除数据相关`

* detail.go `获取数据详情相关操作`

##### config 配置类

* application.yaml `项目配置文件`

* config.go `项目配置文件加载`

##### middleware 中间件

* safeMiddleware.go `访问密钥验证`

##### router 路由

* router.go `路由配置`

##### server 服务层

* cluster `集群服务`

  * sync.go `主从节点数据同步`

  * master.go `主节点同步相关操作`

  * slave.go `从节点同步相关操作`

  * nacos.go `Nacos注册中心连接`

* database `数据库服务`

  * clear.go `清理过期数据`

  * data.go `内存数据存储`

  * log.go `本地日志记录`

* persistent `持久化服务`

  * fileRW.go `文件读写操作`

  * persData.go `数据持久化`

  * recovery.go `数据恢复`

##### utils 工具类

* httpUtil.go `http请求工具`

* jsonUtil.go `Json字符串转换工具`

##### main.go 主函数

***

### 打包方式

* 填写application.yaml内的配置。

* 运行项目：

```
（1）GoLand直接运行main.go(调试)
```

```
（2）打包成exe运行(windows部署)

  GoLand终端cd到项目根目录，执行go build main.go命令，生成main.exe文件
```

```
（3）打包成二进制文件运行(linux部署)

  cmd终端cd到项目根目录，依次执行下列命令：
  SET CGO_ENABLED=0
  SET GOOS=linux
  SET GOARCH=amd64
  go build main.go
  生成main文件
```

***

### 部署说明

##### 集群部署

* 在一台服务器上部署Nacos，添加命名空间(命名空间Id及命名空间名称设置为：maybe-db),填写各节点application.yaml配置文件中的Nacos配置信息。

* 采用一主多从/多主多从方式部署项目,主节点负责写入数据，从节点负责读取数据。

* application.yaml主从节点配置

```
# 主节点配置
isCluster: 1
isMaster: 1
```

```
# 从节点配置
isCluster: 1
isMaster: 0
```

* 将主从节点打包好，分别上传至服务器运行即可。

```
Windows
/maybe-db                 # 数据库节点所在文件根目录
    MaybeDB.exe           # 打包后的exe文件
    /config               # 配置目录
        application.yaml  # 配置文件
    /cache                # Nacos缓存目录
    /log                  # 日志目录
    data.csv              # 持久化文件
```

```
Linux
/maybe-db                 # 数据库节点所在文件根目录
    MaybeDB               # 打包后的二进制文件(程序后台执行:setsid ./main)
    /config               # 配置目录
        application.yaml  # 配置文件
    /cache                # Nacos缓存目录
    /log                  # 日志目录
    data.csv              # 持久化文件
```

##### 单机部署

* 无需部署Nacos，将application.yaml配置文件中的isCluster设置为0，直接打包部署到服务器。

```
# 是否以集群方式部署（1:是，0:否）
isCluster: 0
# 是否为主节点（1:是，0:否）
isMaster: 1
```

##### 数据持久化

* 集群模式下，只有主节点需要进行持久化操作，从节点会自动同步主节点数据，无需进行数据持久化/数据恢复

```
# 是否开启持久化（1:是，0:否）
isPersistent: 1
# 数据持久化操作的时间间隔（单位：秒）
persistentTime: 5
# 持久化文件保存路径
persistentPath: ./data.csv
```

```
# 数据恢复策略（0:不进行数据恢复，1:从本地持久化文件中获取数据，2:从集群其他健康的主节点获取数据）
recoveryStrategy: 2
```