本文主要是教大家實(shí)現(xiàn)一個(gè)具有基本功能的rpc框架峰档。
技術(shù)選型
很多RPC框架的實(shí)現(xiàn)都是基于protobuf的,包括我們公司服務(wù)端引擎實(shí)現(xiàn)的rpc框架也是基于protobuf。從前做過一些簡單的測試刺洒,對(duì)相同數(shù)據(jù)進(jìn)行序列化汁咏,protobuf對(duì)數(shù)據(jù)的壓縮率明顯高于對(duì)比的msgpack、bson和json作媚;相同的對(duì)于序列化時(shí)間上的比較攘滩,msgpack則最快。但是protobuf最讓我受不了的就是需要定義固定的協(xié)議纸泡,并且使用對(duì)應(yīng)的工具生成協(xié)議代碼漂问,然后才能使用,用起來需要一定的學(xué)習(xí)成本女揭。
因此我在想蚤假,是否可以基于msgpack實(shí)現(xiàn)一個(gè)不需要預(yù)先定義通信協(xié)議的rpc框架呢?答案當(dāng)然是肯定的吧兔。
設(shè)計(jì)原型
class rpc_service {
void handle_data();
void register_rpc();
void remote_call();
};
目前rpc_service這個(gè)類只是個(gè)原型磷仰,我們提供三個(gè)接口:
- handle_data: 用于處理原生數(shù)據(jù),將原生數(shù)據(jù)序列化為msgpack
- register_rpc: 用于Server端注冊(cè)rpc函數(shù)
- remote_call: Stub端調(diào)用遠(yuǎn)程rpc函數(shù)
msgpack都提供了什么
這里我使用了msgpack c++(https://github.com/msgpack/msgpack-c)境蔼。我們可以利用msgpack將參數(shù)進(jìn)行打包和解包灶平。
// 將參數(shù)打包成字符串
std::tuple<int, bool, std::string> t(1, false, "hi");
std::stringstream buffer;
msgpack::pack(buffer, t);
buffer.seekg(0);
std::string s(buffer.str());
// 對(duì)字符串進(jìn)行解包
std::tuple<int, bool, std::string> dest;
msgpack::object_handle oh = msgpack::unpack(str.data(), str.size());
oh.get().convert(t);
實(shí)現(xiàn)一個(gè)簡單rpc,我們只需要msgpack上面介紹的功能就可以了箍土。
實(shí)現(xiàn)remote_call函數(shù)
先從最簡單的函數(shù)開始實(shí)現(xiàn)逢享。
template<typename ... Args>
void remote_call(const std::string& method, Args&& ... args);
思路很簡單,我們將method字符串和args打包后的msgpack字符串都存入一個(gè)字符串流中吴藻。這里的字符串流我們定義為rpc_stream(后續(xù)將詳細(xì)講解rpc_stream)的實(shí)現(xiàn)瞒爬,這里先簡單介紹一下:
class rpc_stream : private asio::noncopyable {
public:
rpc_stream();
public:
std::istream& read_stream() { return stream_; }
std::ostream& write_stream() { return stream_; }
streambuf_ex& buf() { return buf_; }
void reset();
char* c_str();
private:
streambuf_ex buf_;
std::iostream stream_;
};
typedef std::shared_ptr<rpc_stream> rpc_stream_ptr;
rpc_stream是我寫的服務(wù)端引擎的一個(gè)副產(chǎn)品,基于asio::streambuf的字節(jié)流處理類沟堡。接口也比較簡單易懂:
- read/write_stream: 讀出/輸入流
- buf: 數(shù)據(jù)的緩沖區(qū)侧但,提供size接口獲得緩沖區(qū)大小
- c_str: 將字節(jié)流中的數(shù)據(jù)轉(zhuǎn)化為字符串
到目前為止,就可以動(dòng)手開始寫remote_call函數(shù)了航罗。
class rpc_service {
public:
rpc_service(): stream_ptr_(new hex_engine::rpc::rpc_stream()) {}
template<typename ... Args>
void remote_call(const std::string& method, Args&& ... args) {
// 1.構(gòu)造tuple
auto t = std::make_tuple(std::forward<Args>(args)...);
// 2.總長度
uint32_t total_sz = 0;
stream_ptr_->write_stream().write((char*)&total_sz, sizeof(total_sz));
// 3.函數(shù)名稱
uint8_t method_sz = method.size();
stream_ptr_->write_stream().write((char*)&method_sz, sizeof(method_sz));
stream_ptr_->write_stream().write(method.c_str(), method_sz);
// 4.寫入?yún)?shù)
msgpack::pack(stream_ptr_->write_stream(), t);
total_sz = stream_ptr_->buf().size() - sizeof(total_sz);
// 5.重新寫入總長度
stream_ptr_->write_stream().seekp(0);
stream_ptr_->write_stream().write((char*)&total_sz, sizeof(total_sz));
}
hex_engine::rpc::rpc_stream_ptr stream_ptr() { return stream_ptr_; }
private:
hex_engine::rpc::rpc_stream_ptr stream_ptr_;
};
這樣數(shù)據(jù)便存在rpc_stream的字節(jié)流中了禀横,之后可以通過c_str接口將字節(jié)流的數(shù)據(jù)導(dǎo)出,通過網(wǎng)絡(luò)傳輸?shù)竭h(yuǎn)端伤哺。
接下來
后面一章將講解Server端Rpc的實(shí)現(xiàn)