# gayrpc

**Repository Path**: yoioy/gayrpc

## Basic Information

- **Project Name**: gayrpc
- **Description**: No description available
- **Primary Language**: C++
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2022-08-18
- **Last Updated**: 2022-08-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# gayrpc
基于Protobuf协议的双向RPC系统,也即通信两端都可以同时作为服务方和客户端,彼此均可请求对方的服务和接收对方的response.
Moved to https://github.com/IronsDu/gayrpc

## 依赖
Windows下可使用 [vcpkg](https://github.com/Microsoft/vcpkg) 进行安装以下依赖库.

* [protobuf](https://github.com/google/protobuf)
* [brynet](https://github.com/IronsDu/brynet)

请注意,当使用Windows时,务必使用`vcpkg install brynet --head`安装brynet.</br>
且务必根据自身系统中的protoc版本对meta.proto和gayrpc_option.proto预先生成代码，请在core_proto 目录里执行: 
```sh
 protoc --cpp_out=../include meta.proto gayrpc_option.proto
```

## 代码生成工具
地址：`https://github.com/IronsDu/protoc-gen-gayrpc`，由[liuhan](https://github.com/liuhan907)编写完成。</br>
首先将插件程序放到系统 PATH路径下(比如Linux下的/usr/bin)，然后执行代码生成，比如（在具体的服务目录里，比如`gayrpc/examples/echo/pb`）:
```sh
 protoc  -I. -I../../../core_proto --cpp_out=. echo_service.proto
 protoc  -I. -I../../../core_proto --gayrpc_out=. echo_service.proto
```

## 协议
目前RPC通信协议底层采用两层协议.
第一层采用二进制协议,且字节序统一为大端.
通信格式如下:

    [data_len | op | data]
    字段解释:
    data_len : uint64_t;
    op       : uint32_t;
    data     : char[data_len];

当`op`值为1时表示RPC消息,此为第二层协议!这时第一层协议中的data的内存布局则为:
    
    [meta_size | data_size | meta | data]
    字段解释:
    meta_size  : uint32_t;
    data_size  : uint64_t;
    meta       : char[meta_size];
    data       : char[data_size];

其中`meta`为 `RpcMata`的binary.`data`为某业务上的Protobuf Request或Response类型对象的binary或JSON.

`RpcMata`的proto定义如下:
```
syntax = "proto3";

message RpcMeta {
    enum Type {
        REQUEST = 0;
        RESPONSE = 1;
    };

    enum DataEncodingType {
        BINARY = 0;
        JSON = 1;
    };

    message Request {
        // 请求的服务函数
        uint64  method = 1;
        // 请求方是否期待服务方返回response
        bool    expect_response = 2;
        // 请求方的序号ID
        uint64  sequence_id = 3;
    };

    message Response {
        // 请求方的序号ID
        uint64  sequence_id = 1;
        // 执行是否成功
        bool    failed = 2;
        // (当failed为true)错误码
        int32   error_code = 3;
        // (当failed为true)错误原因
        string  reason = 4;
    };
    
    // Rpc类型(请求、回应)
    Type    type = 1;
    // RpcData的编码方式
    DataEncodingType encoding = 2;
    // 请求元信息
    Request request_info = 3;
    // 回应元信息
    Response response_info = 4;
}
```

## 服务描述文件范例
以下面的服务定义为例:
```
syntax = "proto3";

package dodo.test;

message EchoRequest {
    string message = 1;
}

message EchoResponse {
    string message = 1;
}

service EchoServer {
    rpc Echo(EchoRequest) returns(EchoResponse){
        option (message_id)= 1 ;//设定消息ID,也就是rpc协议中request_info的method
    };
}
```

## 处理请求或Response的实现原理
1. 编写第一层通信协议的编解码
2. 将第一层中的`data`作为第二层协议数据,反序列化其中的`meta`作为`RpcMeta`对象
3. 判断`RpcMata`中的`type`
    1. 如果为`REQUEST`则根据`request_info`中的元信息调用`method`所对应的服务函数.
        此时第二层协议中的`data`则为服务函数的请求请求对象(比如`EchoRequest`).
    2. 如果为`RESPONSE`则根据`response_info`中的元信息调用`sequence_id`对应的回调函数.
        此时第二层协议中的`data`则为服务方返回的Response(比如`EchoResponse`)

## 发送请求的实现原理
以`client->echo(echoRequest, responseCallback)`为例
参考代码:[EchoService.h](https://gitee.com/irons/gayrpc/blob/master/examples/echo/pb/EchoService.h#L62)

1. 客户端分配 sequence_id,以它为key将 responseCallback保存起来.
2. 将echoRequest序列化为binary作为第二层协议中的`data`
3. 构造RpcMeta对象,将echo函数对应的id号作为request_info的method,并设置sequence_id.
4. 将RpcMeta对象的binary作为第二层协议中的`meta`
5. 用第二层协议的数据写入第一层协议进行发送给服务端.

## 发送Response的实现原理
以`replyObj->reply(echoResponse)`为例
参考代码:[EchoService.h](https://gitee.com/irons/gayrpc/blob/master/examples/echo/pb/EchoService.h#L237)

1. 首先replyObj里(拷贝)储存了来自于请求中的RpcMata对象.
2. 将echoResponse序列化为binary作为第二层协议中的`data`
3. 构造RpcMeta对象,将备份的RpcMeta对象中的sequence_id设置到前者中response_info的sequence_id.
4. 将RpcMeta对象的binary作为第二层协议中的`meta`
5. 用第二层协议的数据写入第一层协议进行发送给服务端.

## 编解码参考
* 对于发送请求或Response都可以走出站拦截器,用于统一的发送消息,最终的序列化参考代码：
    [OpPacket.h](https://gitee.com/irons/gayrpc/blob/master/include/OpPacket.h#L138)
* 对于接收请求或Response则都可以走入站拦截器,统一的解析消息,参考代码:
    [OpPacket.h](https://gitee.com/irons/gayrpc/blob/master/include/OpPacket.h#L97)

## 注意点
* 通信协议的第一层并不是重点,RPC核心在实现上尽量不要依赖它(目前的第一层协议只是某一种范例)
* 同样,RPC核心并不依赖通信采用的传输协议,可以是TCP也可以是UDP或者WebSocket
* RPC服务方的reply顺序与客户端的调用顺序无关,也就是可能后发起的请求先得到返回.