2.3.1（项目）kv存储——框架梳理(待定)

🕗 发布于 2025-01-19 06:00 网络 服务器 运维

一、过一遍代码路线：

（1）底层网络框架；（2）业务层的协议设计(发什么数据，以及收什么数据)；（3）业务层的引擎设计；

1. 底层网络框架：

目的：通过定义函数建立网络层和业务层的联系，并从原有已以网络框架为主改造后以业务框架为main函数，确保此后网络层隔离和透明（以reactor.c为例）。

要求：reactor.c(手写)、ntyco协程(看懂)、io_uring(看懂)。

做法：用做reactor的做法来做kvstore的网络框架

核心：是设置自定义的结构体，明确什么事件执行什么回调函数。while(1){}循环里，（a）EPOLLIN事件执行recv_callback，EPOLLOUT事件执行send_callback。（b）EPOLLIN事件包含sockfd和clientfd，分别执行accept函数和recv/send函数，可以通过recv_callback的index加以区分。

要点：

知识点（1）：通过宏定义开启或关闭不同的功能，由此方便新功能编写。

#define ENABLE_KVSTORE        1

#if    ENABLE_KVSTORE
kvs_request(&connect_list[fd]);
#endif


#if    ENABLE_KVSTORE
kvs_response(&connect_list[fd]);
#endif

知识点（2）：(1) 协议处理 → 放到kvstore.c；（2）main入口函数 → 放到网络框架(reactor.c)里面？还是放到kvstore.c里面?

答：如果把main入口函数放到网络框架(reactor.c)就表明主要程序由网络框架实现，按照这个逻辑kvstore.c只是其中的一个业务，而流程不应该这样。所以main要放到kvstore.c里面，以保证网络层被完全的隔离。对于一个服务而言，我们要最终封装成：网络层仅需要传输端口(port)和协议的接口(kvs_protocol)这两个端口过去，

知识点（3）：网络框架(reactor.c)里如何与kvstore.c连接：

（a）定义kvs_request和kvs_response；

（b）send_cb和recv_cb分别设置kvs_request和kvs_response；

（c）send_cb里的kvs_request使用kvs_handler处理数据 ←

kvs_handler通过“static msg_handler kvs_handler” 定义类型，在网络框架(reactor.c)主函数里被handler赋值←

handler作为网络框架(reactor.c)主函数里其中一个输入参数，被msg_handler结构体赋值 ←

结构体msg_handler在网络框架(reactor.c)被定义，包含*msg、length、*response，同时也在kvstore.h文件里。←

作为在网络框架(reactor.c)主函数输入参数的handler，在kvstore.c里被定义为kvs_protocal。网络框架(reactor.c)的命令行 “static msg_handler kvs_handler” 为了 “kvs_handler = handler”。←

网络层的编译命令

此处的代码：

server.h(基本没变化)

#ifndef __SERVER_H__
#define __SERVER_H__

#define BUFFER_LENGTH128

#define ENABLE_KVSTORE              1


typedef int  (*RCALLBACK)(int fd);



struct conn {
int       fd;

char    rbuffer[BUFFER_LENGTH];
int       rlength;
char    wbuffer[BUFFER_LENGTH];
int       wlength;

RCALLBACK  send_callback;
RCALLBACK  recv_callback;
};


#if ENABLE_KVSTORE
int kvs_request(struct conn *c);
int kvs_response(struct conn *c);
#endif




#endif

kvs_reactor.c

#include <stdio.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <arpa/inet.h>
#include <string.h>
#include <errno.h>
#include <sys/epoll.h>
#include <unistd.h>
#include <sys/time.h>
#include "server.h"



//#define BUFFER_LENGTH       1024
#define CONNECT_SIZE           1048576
#define PORT_SIZE                   1



#define TIME_SUB_MS(tv1, tv2)  ((tv1.tv_sec - tv2.tv_sec) * 1000 + (tv1.tv_usec - tv2.tv_usec) / 1000)


#if ENABLE_KVSTORE

typedef int (*msg_handler)(char *msg, int length, char *response);
static msg_handler kvs_handler;

int kvs_request(struct conn *c){

//printf("recv %d: %s\n", c->rlength ,c->rbuffer);

c->wlength = kvs_handler(c->rbuffer, c->rlength, c->wbuffer);

}

#endif


int kvs_response(struct conn *c){


}


//typedef int  (*RCALLBACK)(int fd);

int accept_cb(int fd);
int recv_cb(int fd);
int send_cb(int fd);

int epfd = 0;

struct timeval begin;

/*
struct conn {
int       fd;

char    rbuffer[BUFFER_LENGTH];
int       rlength;
char    wbuffer[BUFFER_LENGTH];
int       wlength;

RCALLBACK  send_callback;
RCALLBACK  recv_callback;
};
*/

struct conn connect_list[CONNECT_SIZE] = {0};



int set_event(int fd, int event, int flag){

if (flag == 1){ // non-zero add
struct epoll_event ev;
ev.data.fd = fd;
ev.events = event;
epoll_ctl(epfd, EPOLL_CTL_ADD, fd, &ev);
} else {           // zero MOD
struct epoll_event ev;
ev.data.fd = fd;
ev.events = event;
epoll_ctl(epfd, EPOLL_CTL_MOD, fd, &ev);
}

}

int event_register(int fd, int event){

if (fd < 0){
return -1;
}

connect_list[fd].fd = fd;
connect_list[fd].recv_callback = recv_cb;
connect_list[fd].send_callback = send_cb;

memset(connect_list[fd].rbuffer, 0, BUFFER_LENGTH);
connect_list[fd].rlength = 0;
memset(connect_list[fd].wbuffer, 0, BUFFER_LENGTH);
connect_list[fd].wlength = 0;

set_event(fd, EPOLLIN, 1);

}


int accept_cb(int fd){

struct sockaddr_in clientaddr;
socklen_t len = sizeof(clientaddr);
int clientfd = accept(fd, (struct sockaddr*)&clientaddr, &len);

if (clientfd < 0){
printf("accept error:  %d, %s\n", errno, strerror(errno));
return -1;
}

event_register(clientfd, EPOLLIN);

if((clientfd % 1000) == 0){
struct timeval current;
gettimeofday(&current, NULL);
int time_used = TIME_SUB_MS(current, begin);
memcpy(&begin, &current, sizeof(struct timeval));

printf("Accept clientfd : %d, time_used: %d\n", clientfd, time_used);
}


return 0;
}

int recv_cb(int fd){
int count = recv(fd, connect_list[fd].rbuffer, BUFFER_LENGTH, 0);
if (count ==0){
printf("client disconnect: %d\n", fd);
close(fd);
epoll_ctl(epfd, EPOLL_CTL_DEL, fd, NULL);  // unfinished
return 0;
}

connect_list[fd].rlength = count;


//printf("rbuffer: %s, recv: %d\n", connect_list[fd].rbuffer, count);

# if 0 //echo
connect_list[fd].wlength = connect_list[fd].rlength;
memcpy(connect_list[fd].wbuffer, connect_list[fd].rbuffer, connect_list[fd].wlength);
#endif

#if    ENABLE_KVSTORE
kvs_request(&connect_list[fd]);
#endif

set_event(fd, EPOLLOUT, 0);

return count;
}

int send_cb(int fd){

#if    ENABLE_KVSTORE
kvs_response(&connect_list[fd]);
#endif


int count = 0;
count = send(fd, connect_list[fd].wbuffer, connect_list[fd].wlength, 0);
//printf("wbuffer: %s, send: %d\n", connect_list[fd].wbuffer, count);

set_event(fd, EPOLLIN, 0);
return count;

}


int r_init_server(unsigned short port){
int sockfd = socket(AF_INET, SOCK_STREAM, 0);
struct sockaddr_in servaddr;
servaddr.sin_family = AF_INET;
servaddr.sin_addr.s_addr= htonl(INADDR_ANY);  // uint32_t
servaddr.sin_port = htons(port);

if (-1 == bind(sockfd, (struct sockaddr*)&servaddr, sizeof(struct sockaddr))) {
printf("bind failed: %s\n", strerror(errno));
}

listen(sockfd, 10);
//printf("listen finished: %d\n", sockfd);

return sockfd;
}


int reactor_start(unsigned short port, msg_handler handler){

epfd = epoll_create(1);
//unsigned short port = 2000;

kvs_handler =  handler;

int i = 0;
for (i = 0; i < PORT_SIZE; i ++){

int sockfd = r_init_server(port + i);
connect_list[sockfd].fd =  sockfd;
connect_list[sockfd].recv_callback = accept_cb;
printf("sockfd: %d\n", sockfd);
set_event(sockfd, EPOLLIN, 1);
}

gettimeofday(&begin, NULL);

while(1){
struct epoll_event events[1024] = {0};
int nready = epoll_wait(epfd, events, 1024, -1);
//printf("epoll_wait is %d\n", nready);
int i = 0;
for (i = 0; i < nready; i ++){
int connfd = events[i].data.fd;
if (events[i].events & EPOLLIN){
connect_list[connfd].recv_callback(connfd);
}
if (events[i].events & EPOLLOUT){
connect_list[connfd].send_callback(connfd);
}
}
}

return 0;
}

kvstore.c

#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include "kvstore.h"


/*
* msg: request message
* length: length of request message
* response:  need to seed
*@return: length of response
*/


int kvs_protocal(char *msg, int length, char *response){
printf("recv %d: %s\n", length, msg);
memcpy(response, msg, length);
return strlen(response);
}





int main(int argc, char *argv[]){ //  input parameters

if (argc != 2) return -1;
// ./program Hello World: Number of arguments is 3

int port = atoi(argv[1]);

#if   (NETWORK_SELECT  ==  NETWORK_REACTOR)
reactor_start(port, kvs_protocal);
#elif

#endif


}

kvstore.h

#ifndef   __KV_STORE_H__
#define  __KV_STORE_H__


#define NETWORK_REACTOR     0

#define NETWORK_SELECT        NETWORK_REACTOR



typedef int (*msg_handler)(char *msg, int length, char *response);

extern int reactor_start(unsigned short port, msg_handler handler);


const char *command[] = {
"SET", "GET", "DEL", "MOD", "EXIST"
};

const char *response[] = {

};

#endif

2. 业务层的协议设计：

目的：在前面已经建立tcp公共协议连接的基础上，建立发什么数据和接收什么数据的私有协议 / 自定义协议 / 发数据的格式。

具体做法：对于网络部分已经实现了数据的接收和发送，所以接下来我们要在收数据的地方修改，在原有reactor.c的基础上，

（1）新建kvstore.c定义有关业务联系的函数(接收request和输出response)；

（2）新建kvstore.h为函数(接收request和输出response)定义函数具体的协议、具体response。

具体5个response格式：

command(命令)
SET         Key     Value

GET         Key

DEL         Key

MOD         Key     Value
  
EXIST       Key

（3）在上一部分网络已经封装基础上，以kvstore.c里的自定义kvs_protocol函数(也就是对应网络框架(reactor.c) 的主函数第2个输入参数)为入口函数，进行具体的协议解析功能(也就是定义接收和发送的数据规则含义，如下2种模式)。

SET Key Value
Get Key

要点：

知识点（1）：针对tcp的分包和粘包，问题1是什么是分包和粘包，问题2是怎么解决这个问题？

答1：由于send(fd, buffer, length, 0)的次数和recv(fd, buffer, length, 0)可能不一致，可能send()多次发送recv一次性都接收了(这就是粘包)，所以要区分出每次的数据(分包解数据)。

答2：分包的时候需要和对方约定好格式，同时tcp连接满足假设(1) recv()先接收的数据就是对方先发送的数据，保证了接收数据的顺序；(2) 数据在传输过程中不会发生丢包情况，保证了数据必达性。

方式1. send()在发包时就确定约定的长度，比如接收2次就可以接收完整的数据包，第一次接收2字节作为标志，第二次再接收数据包。

SEND:
[15]SET Key Value\r\n   // 15表示15个字符

第一次：接收开头的2个字符，同时通过这2个字符的值得知后面还要接收15字符
short length = 0;
recv(fd, &length, 2, 0);
第二次：接收剩余数据15个字符
recv(fd, buffer, length, 0);

方式2. 仿照Redis，先确定有多少(N)个token后就先发送字符N，具体发送格式如下：

Refis → SET Key Value
发送顺序如下
3\r\n     // 3表示“SET Key Value”一共是3个token(单词)
3\r\n     // 3表示第一个token(单词)“SET"是3个字符的长度
SET\r\n   // 发送一个token，“SET"
3\r\n     // 3表示第二个token(单词)“Key"也是3个字符的长度
Key\r\n   // 发送一个token，“Key"
5\r\n     // 5表示第三个token(单词)“Value"也是5个字符的长度
Value\r\n   // 发送一个token，“Value"

伪代码如下，最终要读(1+2*3)=7次

自行实现readline()函数，要求每一行读到"\r\n"就停止

count = atoi(buffer);
for (i = 0; i < count; i ++){
    readline(fd, tokenlen);
    readline(fd, token);
}

3. 业务层的引擎设计

数据结构用红黑树、希哈、数组、链表(手写)

二、备注：

(1) “const char *command[] ={};” 什么意思？以及为什么是const以及为什么*?

答：const: 确保字符串内容不能被修改。*: 表示指针，每个数组元素都指向一个字符串。

(2) 定义函数不用分号";"，而结构体需要，那么什么时候需要加“;”？

答：定义一个类型（例如 struct 或 typedef）告诉编译器这个类型存在但并不提供执行行为，需要以分号结束。

（a）需要分号的地方：变量声明、结构体定义、typedef 定义新类型

int a = 10; // 表示变量声明结束

struct Point {
    int x;
    char y;
}; // 分号表示 `struct Point` 的定义结束

typedef struct {
    int x;
    char y;
} PointType; // 分号表示 `typedef` 的结束

（b）不需要分号的地方：函数定义、#define 宏(宏是简单的文本替换)。

int add(int a, int b) {
    return a + b; // 函数体内语句的分号只是代码逻辑的一部分
}

#define SQUARE(x) ((x) * (x)) // 宏定义

（3）为什么分为 .c 和 .h 文件?

答：每个 .c 文件负责一个模块的实现，多个模块通过 .h 文件互相调用。.h 文件只能声明接口，不能包含具体实现。自定义头文件使用双引号：#include "xxxx.h"。

（4）"int main(int argc, char *argv[]){}" 是一个标准的 C 语言程序入口函数。

答：argc表示参数个数 (Argument Count)，argv表示参数向量 (Argument Vector)。用于获取命令行传递给程序的参数。

int main(int argc, char *argv[]) {
    printf("Number of arguments: %d\n", argc);
    for (int i = 0; i < argc; i++) {
        printf("Argument %d: %s\n", i, argv[i]);
    }
    return 0;
}
运行：
./program Hello World
输出：
Number of arguments: 3
Argument 0: ./program
Argument 1: Hello
Argument 2: World

原文地址：https://blog.csdn.net/qsq_Ai/article/details/145168306

免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！

Redis 学习指南与资料分享
Redis 作为一款高性能内存数据库，在当今软件开发领域占据着重要地位。其丰富的数据类型、强大的功能特性以及广泛的应用场景，吸引着众多开发者深入学习。以下为你精心整理的 Redis 学习指南与实用资料
阅读更多2025-01-19
ODIN：用于 2D 和 3D 分割的单一模型
大家觉得有帮助记得及时关注和点赞！！！目录抽象1介绍2相关工作3D 实例分割3D 数据集和基准测试基于 2D 的 3D 分割3方法4实验4.13D 基准测试评估4.2模拟中多视图 RGB-D 的评估4
阅读更多2025-01-19
ARP Check
防止ARP欺骗的ARPCheck
阅读更多2025-01-19
考前64天学习笔记 - 形成“习惯体系”进行最小启动
从2025年1月18日到3月22日还剩64天。
阅读更多2025-01-19
大数据-240 离线数仓 - 广告业务测试 ADS层数据加载 DataX数据导出到 MySQL
DataX是由阿里巴巴开源的分布式离线数据同步工具，用于解决不同存储系统之间的数据传输问题。它被设计为一种高效、稳定、易扩展的工具，能够适应多种复杂的数据同步需求。
阅读更多2025-01-19
SpringBoot3集成Sa-Token详解
通过以上步骤，我们成功地在SpringBoot 3项目中集成了Sa-Token，实现了登录认证和权限控制功能。Sa-Token的集成过程简单，且提供了丰富的功能和灵活的配置选项，能够满足大多数Web应
阅读更多2025-01-19
endnote x9 如何将参考文献和文中的应用格式由annotated变为编码，例[1],[2]
在EndNoteX9中，将参考文献和文中引用格式更改为编码形式（如[1],[2]）需要以下步骤：如果需要修改编码格式（如将括号改为方括号），可以自定义输出样式：完成以上步骤后，文中引用和参考文献将以编
阅读更多2025-01-19
Android SystemUI——CarSystemBar添加到窗口（十）
上一篇文章我们看到了车载状态栏CarSystemBar视图的创建流程，这里我们继续分析将车载状态栏添加到Windows窗口中。
阅读更多2025-01-19
【STM32-学习笔记-12-】PWR电源控制
本文介绍了PWR电源控制的相关函数，以及STM32的三种低功耗模式的配置
阅读更多2025-01-19
MySQL入门（数据库、数据表、数据、字段的操作以及查询相关sql语法）
本文采用CCBY-NC-SA许可证此许可允许在使用者仅出于非商业目的以任何媒体或格式分发、重新混合、改编和构建材料，并且前提是注明创作者。如果您重新混合、改编或基于该材料进行构建，则必须按照相同的条款
阅读更多2025-01-19