PhxRPC是微信后台团队推出的一个非常简洁小巧的RPC框架,编译生成的库只有450K。
开源地址:
https://github.com/tencent-wechat/phxrpc
点击阅读原文可自动跳转到github地址
使用Protobuf作为IDL用于描述RPC接口以及通信数据结构。
基于Protobuf文件自动生成Client以及Server接口,用于Client的构建,以及Server的实现。
半同步半异步模式,采用独立多IO线程,通过Epoll管理请求的接入以及读写,工作线程采用固定线程池。IO线程与工作线程通过内存队列进行交互。
提供完善的过载保护,无需配置阀值,支持动态自适应拒绝请求。
提供简易的Client/Server配置读入方式。
基于lambda函数实现并发访问Server,可以非常方便地实现Google提出的 Backup Requests 模式。
不支持多进程模式。
使用Sample目录下的Search RPC C/S进行Echo RPC调用的压测,相当于Worker空转情况。
下面是sample目录下的proto文件样例。
syntax = "proto3"; package search; import "google/protobuf/wrappers.proto"; import "google/protobuf/empty.proto"; import "phxrpc/phxrpc.proto"; enum SiteType { BLOG = 0; NEWS = 1; VIDEO = 2; UNKNOWN = 3; } message Site { string url = 1; string title = 2; SiteType type = 3; tring summary = 4; } message SearchRequest { string query = 1; } message SearchResult { repeated Site sites = 1; } service Search{ rpc Search( SearchRequest ) returns( SearchResult ) { option( phxrpc.CmdID ) = 1; option( phxrpc.OptString ) = "q:"; option( phxrpc.Usage ) = "-q <query>"; } rpc Notify( google.protobuf.StringValue ) returns( google.protobuf.Empty ) { option( phxrpc.CmdID ) = 2; option( phxrpc.OptString ) = "m:"; option( phxrpc.Usage ) = "-m <msg>"; } }
打开生成代码放置目录下的Makefile文件。
#choose to use boost for network#LDFLAGS := $(PLUGIN_BOOST_LDFLAGS) $(LDFLAGS)可以看到以上两行,取消注释掉第二行,重新make clean, make即可开启boost对PhxRPC的优化。开启前记得编译好PhxRPC的boost插件。
int SearchServiceImpl :: PHXEcho( const google::protobuf::StringValue & req, google::protobuf::StringValue * resp ) { resp->set_value( req.value() ); return 0; } int SearchServiceImpl :: Search( const search::SearchRequest & req, search::SearchResult * resp ) { //这里补充这个RPC调用的Server端代码 return -1; } int SearchServiceImpl :: Notify( const google::protobuf::StringValue & req, google::protobuf::Empty * resp ) { //这里补充这个RPC调用的Server端代码 return -1; }
//这个是默认生成的代码, 可自行修改,或利用我们提供的stub API自定义封装Client int SearchClient :: PHXEcho( const google::protobuf::StringValue & req, google::protobuf::StringValue * resp ) { const phxrpc::Endpoint_t * ep = global_searchclient_config_.GetRandom(); if(ep != nullptr) { phxrpc::BlockTcpStream socket; bool open_ret = phxrpc::PhxrpcTcpUtils::Open(&socket, ep->ip, ep->port, global_searchclient_config_.GetConnectTimeoutMS(), NULL, 0, *(global_searchclient_monitor_.get())); if ( open_ret ) { socket.SetTimeout(global_searchclient_config_.GetSocketTimeoutMS()); SearchStub stub(socket, *(global_searchclient_monitor_.get())); return stub.PHXEcho(req, resp); } } return -1; }
int SearchClient :: PhxBatchEcho( const google::protobuf::StringValue & req, google::protobuf::StringValue * resp ) { int ret = -1; size_t echo_server_count = 2; uthread_begin; for (size_t i = 0; i < echo_server_count; i++) { uthread_t [=, &uthread_s, &ret](void *) { const phxrpc::Endpoint_t * ep = global_searchclient_config_.GetByIndex(i); if (ep != nullptr) { phxrpc::UThreadTcpStream socket; if(phxrpc::PhxrpcTcpUtils::Open(&uthread_s, &socket, ep->ip, ep->port, global_searchclient_config_.GetConnectTimeoutMS(), *(global_searchclient_monitor_.get()))) { socket.SetTimeout(global_searchclient_config_.GetSocketTimeoutMS()); SearchStub stub(socket, *(global_searchclient_monitor_.get())); int this_ret = stub.PHXEcho(req, resp); if (this_ret == 0) { ret = this_ret; uthread_s.Close(); } } } }; } uthread_end; return ret; }
uthread_begin, uthread_end, uthread_s, uthread_t这几个关键字是PhxRPC自定义的宏,分别表示协程的准备,结束,协程调度器以及协程的创建。
上面的代码实现了Google提出的 Backup Requests 模式。实现的功能是分别对两个Server同时发起Echo调用,当有一个Server响应的时候,则整个函数结束。在这段代码里面,我们提供了一种异步IO的同步写法,并给予了一些方便使用的宏定义。首先使用uthread_begin进行准备,然后使用uthread_t以lambda的形式创建一个协程,而在任意一个协程里面都可使用我们PhxRPC生成的Client API进行RPC调用,并可使用uthread_s随时结束所有RPC调用。最后的uthread_end真正通过协程调度发起这些lambda内的RPC调用,并等待结束。
当然你可以借用这4个宏定义,以同步代码的写法,进行更自定义的并发访问。