使用Thrift RPC编写程序

Category: 搜索引擎 View: 12,602 阅 Author: Dong

作者:Dong | 可以转载, 但必须以超链接形式标明文章原始出处和作者信息及版权声明
网址:http://dongxicheng.org/search-engine/thrift-rpc/

1．概述

本文以C++语言为例介绍了thrift RPC的使用方法，包括对象序列化和反序列化，数据传输和信息交换等。

本文采用了一个示例进行说明，该示例主要完成传输（上报日志或者报表）功能，该示例会贯穿本文，内容涉及thrift定义，代码生成，thrift类说明，client编写方法，server编写方法等。

关于Thrift架构分析，可参考：Thrift架构介绍。

关于Thrift文件编写方法，可参考：Thrift使用指南。

2．示例描述

假设我们要使用thrift RPC完成一个数据传输任务，数据格式和PRC接口用一个thrift文件描述，具体如下：

(1) book.thrift，用于描述书籍信息的thrift接口

//book.thrift， 
namespace
cpp example 
struct
Book_Info { 
1: i32 book_id, 
2: string book_name,
3: string book_author,
4: double
book_price, 
5: string book_publisher,
}

(2) rpc.thrift，client向server传输数据（上报日志或者报表）的RPC接口

//rpc.thrift 
namespace
cpp example 
include "book.thrift"
service BookServlet {
bool 
Sender(1: list<book.Book_Info> books); 
oneway void
Sender2(1: list<book.Book_Info> books); 
}

说明：该thrift文件定义了一个service，它包含两个接口，server端需要实现这两个接口以对client提供服务。其中，第一个接口函数是阻塞式的，即要等待server返回值以后才能继续，另外一个声明为oneway类型（返回值为void），表明该函数是非阻塞式的，将数据发给server后不必等待返回结果，但使用该函数时，需要考虑server的承受能力，适度的调整发送频率。

3． Thrift文件与生成的代码对应关系

每个thrift文件会产生四个文件，分别为：${thrift_name}_constants.h，${thrift_name}_constants.cpp，${thrift_name}_types.h，${thrift_name}_types.cpp

对于含有service的thrift文件，会额外生成两个文件，分别为：${service_name}.h，${service_name}.cpp

对于含有service的thrift文件，会生成一个可用的server桩：${service_name}._server.skeleton.cpp

对于本文中的例子，会产生以下文件：

book_constants.h book_constants.cpp

book_types.h book_types.cpp

rpc_constants.h rpc_constants.cpp

rpc_types.h rpc_types.cpp

BookServlet.h BookServlet.cpp

BookServlet_server.skeleton.cpp

4． Thrift类介绍

Thrift代码包（位于thrift-0.6.1/lib/cpp/src）有以下几个目录：

concurrency：并发和时钟管理方面的库

processor：Processor相关类

protocal：Protocal相关类

transport：transport相关类

server：server相关类

4.1 Transport类（how is transmitted？）

负责数据传输，有以下几个可用类：

TFileTransport：文件（日志）传输类，允许client将文件传给server，允许server将收到的数据写到文件中。

THttpTransport：采用Http传输协议进行数据传输

TSocket：采用TCP Socket进行数据传输

TZlibTransport：压缩后对数据进行传输，或者将收到的数据解压

下面几个类主要是对上面几个类地装饰（采用了装饰模式），以提高传输效率。

TBufferedTransport：对某个Transport对象操作的数据进行buffer，即从buffer中读取数据进行传输，或者将数据直接写入buffer

TFramedTransport：同TBufferedTransport类似，也会对相关数据进行buffer，同时，它支持定长数据发送和接收。

TMemoryBuffer：从一个缓冲区中读写数据

4.2 Protocol类（what is transmitted？）

负责数据编码，主要有以下几个可用类：

TBinaryProtocol：二进制编码

TJSONProtocol：JSON编码

TCompactProtocol：密集二进制编码

TDebugProtocol：以用户易读的方式组织数据

4.3 Server类（providing service for clients）

TSimpleServer：简单的单线程服务器，主要用于测试

TThreadPoolServer：使用标准阻塞式IO的多线程服务器

TNonblockingServer：使用非阻塞式IO的多线程服务器，TFramedTransport必须使用该类型的server

5．对象序列化和反序列化

Thrift中的Protocol负责对数据进行编码，因而可使用Protocol相关对象进行序列化和反序列化。

由于对象序列化和反序列化不设计传输相关的问题，所以，可使用TBinaryProtocol和TMemoryBuffer，具体如下：

（1）使用thrift进行对象序列化

//对对象object进行序列化，保存到str中

template
<typename 
Type> 
void 
Object2String(Type& object, string &str) { 
shared_ptr<TMemoryBuffer> membuffer(new
TMemoryBuffer()); 
shared_ptr<TProtocol> protocol(new
TBinaryProtocol(membuffer)); 
object.write(protocol.get());
str.clear();
str = membuffer.getBufferAsString();
}

（2）使用thrift进行对象反序列化

//对str中保存的对象进行反序列化，保存到object中
template
<typename 
Type> 
void 
String2Object(string& buffer, Type &object) { 
shared_ptr<TMemoryBuffer> membuffer(new
TMemoryBuffer( 
reinterpret_cast<uint*>(buffer.data())));
shared_ptr<TProtocol> protocol(new
TBinaryProtocol(membuffer)); 
object.read(protocol.get());
}

6．编写client和server

6.1 client端代码编写

Client编写的方法分为以下几个步骤：

（1）定义TTransport，为你的client设置传输方式（如socket， http等）。

（2）定义Protocal，使用装饰模式（Decorator设计模式）封装TTransport，为你的数据设置编码格式（如二进制格式，JSON格式等）

（3）实例化client对象，调用服务接口。

说明：如果用户在thrift文件中定义了一个叫${server_name}的service，则会生成一个叫${server_name}Client的对象，比如，我给出的例子中，thrift会自动生成一个叫BookServletClient的类，Client端的代码编写如下：

#include " gen-cpp/BookServlet.h" //一定要包含该头文件
//其头文件，其他using namespace …….
int 
main(int argc,
char** argv) {
shared_ptr<TTransport> socket(new
TSocket("localhost", 9090));
shared_ptr<TTransport> transport(new
TBufferedTransport(socket)); 
shared_ptr<TProtocol> protocol(new
TBinaryProtocol(transport)); 
example::BookServletClient client(protocol);
try
{ 
transport->open();
vector<example::Book_Info> books;
…...
client.Sender(books);//RPC函数，调用serve端的该函数
transport->close();
} catch
(TException &tx) { 
printf("ERROR: %s\n", tx.what());
} 
}

6.2 Server端代码编写

（1）定义一个TProcess，这个是thrift根据用户定义的thrift文件自动生成的类

（2）使用TServerTransport获得一个TTransport

（3）使用TTransportFactory，可选地将原始传输转换为一个适合的应用传输（典型的是使用TBufferedTransportFactory）

（4）使用TProtocolFactory，为TTransport创建一个输入和输出

（5）创建TServer对象（单线程，可以使用TSimpleServer；对于多线程，用户可使用TThreadPoolServer或者TNonblockingServer），调用它的server()函数。

说明：thrift会为每一个带service的thrift文件生成一个简单的server代码（桩），在例子中，thrift会生成BookServlet_server.skeleton.cpp，用户可以在这个文件基础上实现自己的功能。

#include "gen-cpp/BookServlet.h"
#include <protocol/TBinaryProtocol.h>
#include <server/TSimpleServer.h>
#include <transport/TServerSocket.h>
#include <transport/TBufferTransports.h>
using
namespace ::apache::thrift;
using
namespace ::apache::thrift::protocol;
using
namespace ::apache::thrift::transport;
using
namespace ::apache::thrift::server;
using
boost::shared_ptr; 
using
namespace example; 
class
BookServletHandler : virtual
public BookServletIf {
public:
BookServletHandler() {
// Your initialization goes here
} 
//用户需实现这个接口 
bool
Sender(const
std::vector<example::Book_Info> & books) { 
// Your implementation goes here
printf("Sender\n");
} 
//用户需实现这个接口 
void
Sender2(const
std::vector<example::Book_Info> & books) { 
// Your implementation goes here
printf("Sender2\n");
} 
}; 
int 
main(int argc,
char **argv) {
int
port = 9090; 
shared_ptr<BookServletHandler> handler(new
BookServletHandler()); 
shared_ptr<TProcessor> processor(new
BookServletProcessor(handler)); 
shared_ptr<TServerTransport> serverTransport(new
TServerSocket(port)); 
shared_ptr<TTransportFactory> transportFactory(new
TBufferedTransportFactory()); 
shared_ptr<TProtocolFactory> protocolFactory(new
TBinaryProtocolFactory()); 
TSimpleServer server(processor, serverTransport, transportFactory, protocolFactory);
server.serve();
return
0; 
}