int main()
Example::SRPCClient client(IP, PORT);
EchoRequest req; // 用户自定义的请求结构
EchoResponse resp; // 用户自定义的回复结构
req.set_message("Hello World");
client.Echo(&req, &resp, NULL); // 调用远程函数名为Echo
return 0;
具体网络协议,是框架来实现的,把开发者要发出和接收的内容以某种应用层协议打包进行网络收发。这里可以和HTTP进行一个明显的对比:
HTTP也是一种网络协议,但包的内容是固定的,必须是:请求行 + 请求头 + 请求体;
RPC是一种自定义网络协议,由具体框架来定,比如SRPC里支持的RPC协议有:SRPC/thrift/BRPC/tRPC
这些RPC协议都和HTTP平行,是应用层协议。我们再进一步思考,HTTP只包含具体网络协议,也可以返回比如我们常见的HTTP/1.1 200 OK,但仿佛没有用户调用接口,这是为什么呢?
这里需要搞清楚,用户接口的功能是什么?最重要的功能有两个:
定位要调用的服务;
让我们的消息向前/向后兼容;
我们用一个表格来看一下HTTP和RPC分别是怎么解决的:
因此,HTTP的调用减少了用户调用接口的函数,但是牺牲了一部分消息向前/向后兼容的自由度。但是,开发者可以根据自己的习惯进行技术选型,因为RPC和HTTP之间大部分都是协议互通的!是不是很神奇?接下来我们看一下RPC的层次架构,就可以明白为什么不同RPC框架之间、以及RPC和HTTP协议是如何做到互通的。
2. RPC有什么
我们可以从SRPC的架构层次上来看,RPC框架有哪些层,以及SRPC目前所横向支持的功能是什么:
用户代码(client的发送函数/server的函数实现)
IDL序列化(protobuf/thrift serialization)
数据组织 (protobuf/thrift/json)
压缩(none/gzip/zlib/snappy/lz4)
协议 (Sogou-std/Baidu-std/Thrift-framed/TRPC)
通信 (TCP/HTTP)
我们先关注以下三个层级:
如图从左到右,是用户接触得最多到最少的层次。IDL层会根据开发者定义的请求/回复结构进行代码生成,目前小伙伴们用得比较多的是protobuf和thrift,而刚才说到的用户接口和前后兼容问题,都是IDL层来解决的。SRPC对于这两个IDL的用户接口实现方式是:
thrift:IDL纯手工解析,用户使用srpc是不需要链thrift的库的 !!!
protobuf:service的定义部分纯手工解析
中间那列是具体的网络协议,而各RPC能互通,就是因为大家实现了对方的“语言”,因此可以协议互通。
而RPC作为和HTTP并列的层次,第二列和第三列理论上是可以两两结合的,只需要第二列的具体RPC协议在发送时,把HTTP相关的内容进行特化,不要按照自己的协议去发,而按照HTTP需要的形式去发,就可以实现RPC与HTTP互通。
3. RPC的生命周期
到此我们可以通过SRPC看一下,把request通过method发送出去并处理response再回来的整件事情是怎么做的:
根据上图,可以更清楚地看到刚才提及的各个层级,其中压缩层、序列化层、协议层其实是互相解耦打通的,在SRPC代码上实现得非常统一,横向增加任何一种压缩算法或IDL或协议都不需要也不应该改动现有的代码,才是一个精美的架构~
我们一直在说生成代码,到底有什么用呢?图中可以得知,生成代码是衔接用户调用接口和框架代码的桥梁,这里以一个最简单的protobuf自定义协议为例:example.proto
syntax = "proto3";
message EchoRequest
string message = 1;
message EchoResponse
string message = 1;
service Example
rpc Echo(EchoRequest) returns (EchoResponse);
我们定义好了请求、回复、远程服务的函数名,通过以下命令就可以生成出接口代码example.srpc.h
:
protoc example.proto --cpp_out=./ --proto_path=./
srpc_generator protobuf ./example.proto ./
我们一窥究竟,看看生成代码到底可以实现什么功能:
// SERVER代码
class Service : public srpc::RPCService
public:
// 用户需要自行派生实现这个函数,与刚才pb生成的是对应的
virtual void Echo(EchoRequest *request, EchoResponse *response,
srpc::RPCContext *ctx) = 0;
// CLIENT代码
using EchoDone = std::function<void (echoresponse *, srpc::rpccontext *)>;
class SRPCClient : public srpc::SRPCClient
public:
// 异步接口
void Echo(const EchoRequest *req, EchoDone done);
// 同步接口
void Echo(const EchoRequest *req, EchoResponse *resp, srpc::RPCSyncContext *sync_ctx);
// 半同步接口
WFFuture<std::pair<echoresponse, srpc::rpcsynccontext>> async_Echo(const EchoRequest *req);
作为一个高性能RPC框架,SRPC生成的client代码中包括了:同步、半同步、异步接口,文章开头展示的是一个同步接口的做法。
而server的接口就更简单了,作为一个服务端,我们要做的就是收到请求
->处理逻辑
->返回回复
,而这个时候,框架已经把刚才提到的网络收发、解压缩、反序列化等都给做好了,然后通过生成代码调用到用户实现的派生service类的函数逻辑中。
由于一种协议定义了一种client/server,因此其实我们同样可以得到的server类型有第二部分提到过的若干种:
SRPCServer
SRPCHttpServer
BRPCServer
TRPCServer
ThriftServer
4. 一个完整的server例子
最后我们用一个完整的 server
例子,来看一下用户调用接口的使用方式,以及如何跨协议使用HTTP作为client进行调用。刚才提到,srpc_generator
在生成接口的同时,也会自动生成空的用户代码,我们这里打开 server.pb_skeleton.cc
直接改两行,即可 run
起来:
#include "example.srpc.h"
#include "workflow/WFFacilities.h"
using namespace srpc;
static WFFacilities::WaitGroup wait_group(1);
void sig_handler(int signo)
wait_group.done();
class ExampleServiceImpl : public Example::Service
public:
void Echo(EchoRequest *request, EchoResponse *response, srpc::RPCContext *ctx) override
response->set_message("OK"); // 具体逻辑在这里添加,我们简单地回复一个OK
int main()
unsigned short port = 80; // 因为要启动Http服务
SRPCHttpServer server; // 我们需要构造一个SRPCHttpServer
ExampleServiceImpl example_impl;
server.add_service(&example_impl);
server.start(port);
wait_group.wait();
server.stop();
return 0;
只要安装了srpc,linux下即可通过以下命令编译出可执行文件:
g++ -o server server.pb_skeleton.cc example.pb.cc -std=c++11 -lsrpc
接下来是激动人心的时刻了,我们用人手一个的curl
来发起一个HTTP请求:
$ curl -i 127.0.0.1:80/Example/Echo -H 'Content-Type: application/json' -d '{message:"Hello World"}'
HTTP/1.1 200 OK
SRPC-Status: 1
SRPC-Error: 0
Content-Type: application/json
Content-Encoding: identity
Content-Length: 16
Connection: Keep-Alive
{"message":"OK"}
5. 总结
今天我们基于 C++ 实现的开源项目 SRPC 深入分析了 RPC 的基本原理。SRPC 整体代码风格简洁、架构层次精巧,整体约1万行代码,如果你使用 C++,那可能非常适合你用来学习 RPC 架构。
通过这篇文章,相信我们可以清晰地了解到 RPC 是什么,接口长什么样,也可以通过与HTTP协议互通来理解协议层次,更重要的是可以知道具体纵向的每个层次,及横向对比我们常见的每种使用模式都有哪些。如果小伙伴对更多功能感兴趣,也可以通过阅读 SRPC 源码进行进一步了解。
6. 项目地址
https://github.com/sogou/srpc
欢迎使用并 star 支持一下作者的开源精神!