# KVstorageBaseRaft-cpp 项目 RPC 模块源码学习

KVstorageBaseRaft-cpp 项目 RPC 模块源码学习

一、项目简介

KVstorageBaseRaft-cpp 是一个基于 Raft 一致性算法实现的分布式 KV 存储系统,采用 C++ 开发。项目的核心目标是帮助开发者理解 Raft 原理和分布式 KV 存储的基本实现。RPC 模块是分布式系统通信的关键基础设施,负责节点间、客户端与服务端之间的远程过程调用。

二、RPC 模块结构总览

源码主要位于 src/rpc/ 目录,包含如下关键文件:

  • mprpcchannel.h/cpp:RPC 客户端通道,负责序列化、发送请求、接收响应。
  • mprpccontroller.h/cpp:RPC 调用控制器,负责错误状态管理。
  • mprpcconfig.h/cpp:RPC 配置加载,负责读取 ip、端口等配置信息。
  • rpcprovider.h/cpp:RPC 服务端,负责服务注册、请求分发和实际业务调用。
  • rpcheader.proto:RPC 协议头部的 protobuf 定义。
  • rpcheader.pb.h/cpp:由 proto 自动生成的协议头部 C++ 代码。

三、核心源码解读

1. RPC 协议头部定义

rpcheader.proto 内容如下:

proto 复制代码
syntax = "proto3";
package RPC;

message RpcHeader {
    bytes service_name = 1;
    bytes method_name = 2;
    uint32 args_size = 3;
}
  • 该消息定义了每次 RPC 调用的服务名、方法名和参数长度,便于服务端正确分发请求。

2. RPC 客户端通道(mprpcchannel)

主要职责
  • 负责将本地的 RPC 方法调用序列化为网络数据包,发送到远程服务端,并接收响应。
  • 自动处理连接失败时的重连与重试。
关键流程
  1. 获取服务名和方法名
    通过 MethodDescriptor 自动获取,便于通用化。
  2. 参数序列化
    将请求参数序列化为字符串,记录长度。
  3. 构造并序列化 RpcHeader
    组装服务名、方法名、参数长度,序列化为二进制。
  4. 数据打包
    先写入 header 长度(变长编码),再写入 header 内容,最后拼接参数内容。
  5. 发送与重连
    发送失败自动重连,保证健壮性。
  6. 接收与反序列化响应
    ParseFromArray 反序列化,避免字符串截断 bug。
代码片段举例
cpp 复制代码
// 1. 获取服务名和方法名
const google::protobuf::ServiceDescriptor* sd = method->service();
std::string service_name = sd->name();
std::string method_name = method->name();

// 2. 参数序列化
uint32_t args_size{};
std::string args_str;
if (request->SerializeToString(&args_str)) {
    args_size = args_str.size();
} else {
    controller->SetFailed("serialize request error!");
    return;
}

// 3. 构造 RpcHeader
RPC::RpcHeader rpcHeader;
rpcHeader.set_service_name(service_name);
rpcHeader.set_method_name(method_name);
rpcHeader.set_args_size(args_size);

// 4. 数据打包
std::string send_rpc_str;
{
    google::protobuf::io::StringOutputStream string_output(&send_rpc_str);
    google::protobuf::io::CodedOutputStream coded_output(&string_output);
    coded_output.WriteVarint32(static_cast<uint32_t>(rpc_header_str.size()));
    coded_output.WriteString(rpc_header_str);
}
send_rpc_str += args_str;

// 5. 发送与重连
while (-1 == send(m_clientFd, send_rpc_str.c_str(), send_rpc_str.size(), 0)) {
    // ...重连逻辑...
}

// 6. 接收与反序列化
if (!response->ParseFromArray(recv_buf, recv_size)) {
    controller->SetFailed("parse error!");
    return;
}

3. RPC 控制器(mprpccontroller)

  • 负责记录本次 RPC 调用的失败状态和错误信息,便于上层业务判断和处理。
  • 代码简洁,主要实现了 SetFailedFailedErrorText 等接口。

4. RPC 服务端(rpcprovider)

  • 负责服务注册、请求分发和实际业务调用。
  • 建议结合头文件和实现文件一起阅读,理解服务端如何根据收到的 RpcHeader 分发到具体的服务和方法。

5. 配置加载(mprpcconfig)

  • 负责从配置文件读取 ip、端口等信息,便于灵活部署和管理。

相关推荐
悠哉悠哉愿意1 小时前
【电赛学习笔记】MaxiCAM 项目实践——与单片机的串口通信
笔记·python·单片机·嵌入式硬件·学习·视觉检测
快乐肚皮2 小时前
ZooKeeper学习专栏(五):Java客户端开发(原生API)详解
学习·zookeeper·java-zookeeper
慕y2742 小时前
Java学习第七十二部分——Zookeeper
java·学习·java-zookeeper
★YUI★3 小时前
学习游戏制作记录(剑投掷技能)7.26
学习·游戏·unity·c#
程序员编程指南3 小时前
Qt 数据库连接池实现与管理
c语言·数据库·c++·qt·oracle
蓝桉8023 小时前
opencv学习(图像金字塔)
人工智能·opencv·学习
rannn_1114 小时前
Java学习|黑马笔记|Day23】网络编程、反射、动态代理
java·笔记·后端·学习
火车叨位去19494 小时前
用Java实现rpc的逻辑和流程图和核心技术与难点分析
java·rpc·流程图
go54631584654 小时前
中文语音识别与偏误检测系统开发
开发语言·人工智能·学习·生成对抗网络·数学建模·语音识别
晨风先生4 小时前
如何Visual Studio 的配置从 Qt-Debug 切换到 x64-Debug
ide·qt·visual studio