深入理解RPC自定义网络协议

Linux爱好者 2022-06-12 2570

描述

本文来自srpc作者李颖欣，在此基础上略做改动。

只要涉及到网络通信，必然涉及到网络协议，应用层也是一样。在应用层最标准和常用的就是HTTP协议。但在很多性能要求较高的场景各大企业内部也会自定义的 RPC 协议。举个例子，就是相当于各个省不但用官方普通话，还都有自己的方言，RPC就相当于是一个方言。

RPC 的全称是Remote Procedure Call，翻译过来就是远程过程调用。但这个名字起的一点都不好，过分强调了和LPC（本地过程调用）的对比。没有突出出来 RPC 本身涉及到的一些技术特点。

我们今天来从三个角度和大家聊聊 RPC。

RPC是什么：通过和HTTP的对比来帮大家了解RPC
RPC有什么：介绍了RPC用到的用户桩代码、IDL序列化、压缩、协议、通信等技术点
RPC生命周期：详细探讨RPC从请求发出到收到返回的全过程

今天的讲解会结合基于C++实现的开源项目SRPC。SRPC整体代码风格简洁、架构层次精巧，整体约1万行代码，非常适合用来学习RPC架构：https://github.com/sogou/srpc

一. RPC是什么

RPC可以分为两部分：用户调用接口 + 具体网络协议。前者为开发者需要关心的，后者由框架来实现。

1. 用户调用接口

举个例子，我们定义一个函数，我们希望函数如果输入为“Hello World”的话，输出给一个“OK”，那么这个函数是个本地调用。如果一个远程服务收到“Hello World”可以给我们返回一个“OK”，那么这是一个远程调用。我们会和服务约定好远程调用的函数名。因此，我们的用户接口就是：输入、输出、远程函数名，比如用SRPC开发的话，client端的代码会长这样：

int main()
{
    Example::SRPCClient client(IP, PORT);
    EchoRequest req; // 用户自定义的请求结构
    EchoResponse resp; // 用户自定义的回复结构
  
    req.set_message("Hello World");
    client.Echo(&req, &resp, NULL); // 调用远程函数名为Echo
    return 0;
}

2. 具体网络协议

这是框架来实现的，把开发者要发出和接收的内容以某种应用层协议打包进行网络收发。这里可以和HTTP进行一个明显的对比：

RPC是一种自定义网络协议，由具体框架来定，比如SRPC里支持的RPC协议有：SRPC / thrift / BRPC / tRPC，并且也是tRPC协议目前唯一的开源实现，我们拿其中的SogouRPC-std protocol为例给大家看看RPC协议的大概样子：
HTTP也是一种网络协议，但包的内容是固定的，必须是：请求行 + 请求头 + 请求体；

3. 进一步思考

上图对应的颜色，所实现的功能是类似的。我们想一想，为什么大家都长差不多呢？

这里就需要搞清楚，我们想要实现用户接口，需要怎么做？最重要需要支持以下三个功能：

定位要调用的服务；
把完整的消息切下来；
让我们的消息向前/向后兼容；

这样既可以让消息内保证一定的灵活性，又可以方便拿下一块数据，去调用用户想要的服务。

我们用一个表格来看一下HTTP和RPC分别是怎么解决的：

	定位要调用的服务	消息长度	消息前后兼容
HTTP	URL	header里Content-Length	body里自己解决
RPC	指定Service和Method名	协议header里自行约定	交给具体IDL

因此，大家都会需要类似的结构去组装一条完整的用户请求，而第三部分的body只要框架支持，RPC协议和HTTP是可以互通的！因此开发者完全可以根据自己的业务需求进行选型，接下来我们看一下RPC的层次架构，就可以明白为什么不同RPC框架之间的互通、以及RPC和HTTP协议又是如何做到互通的。

二、 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互通。

三、 RPC的生命周期

到此我们可以通过SRPC看一下，把request通过method发送出去并处理response再回来的整件事情是怎么做的：

网络协议

根据上图，可以更清楚地看到刚才提及的各个层级，其中压缩层、序列化层、协议层其实是互相解耦打通的，在SRPC代码上实现得非常统一，横向增加任何一种压缩算法或IDL或协议都不需要也不应该改动现有的代码，才是一个精美的架构～

我们一直在说生成代码，到底有什么用呢？图中可以得知，生成代码是衔接用户调用接口和框架代码的桥梁，这里以一个最简单的protobuf自定义协议为例：example.proto

syntax = "proto3"; // 这里proto2和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.pb_skeleton.cc和client.pb_skeleton.cc，这是为了方便开发者的两个空文件。我们继续一窥究竟，看看生成代码到底可以实现什么功能：

// 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> async_Echo(const EchoRequest *req);
};

作为一个高性能RPC框架，SRPC生成的client代码中包括了：同步、半同步、异步接口，文章开头展示的是一个同步接口的做法。

而server的接口就更简单了，作为一个服务端，我们要做的就是收到请求->处理逻辑->返回回复，而这个时候，框架已经把刚才提到的网络收发、解压缩、反序列化等都给做好了，然后通过生成代码调用到用户实现的派生service类的函数逻辑中。

由于一种协议定义了一种client/server，因此其实我们同样可以得到的server类型有第二部分提到过的若干种：SRPCServer/SRPCHttpServer/BRPCServer/TRPCServer/ThriftServer/...

四、一个完整的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和workflow，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"}'

网络协议

五、解锁更多

通过这篇文章，相信我们可以清晰地了解到RPC的接口长什么样，也可以通过与HTTP协议互通来理解协议层次，更重要的是可以知道具体纵向的每个层次及横向对比我们常见的每种使用模式都有哪些。但其实，RPC还可以做的事情还有很多，包括内部各层次的解耦合设计、框架层的功能埋点、外部服务集群的对接等等：

网络协议

如果小伙伴对更多功能感兴趣，欢迎点击阅读原文，到Github围观，进一步了解。

原文标题：一文搞懂 RPC 的基本原理和层次架构

文章出处：【微信公众号：Linux爱好者】欢迎添加关注！文章转载请注明出处。

审核编辑：汤梓红

打开APP阅读更多精彩内容

深入理解RPC自定义网络协议

Linux爱好者

描述

一. RPC是什么

1. 用户调用接口

2. 具体网络协议

3. 进一步思考

二、 RPC有什么

三、 RPC的生命周期

四、 一个完整的server例子

五、 解锁更多

四、一个完整的server例子

五、解锁更多