Apache Thrift的简单使用

———————-

1. 简介

Thrift是Facebook的一个开源项目，主要是一个跨语言的服务开发框架。它有一个代码生成器来对它所定义的IDL定义文件自己主动生成服务代码框架。用户仅仅要在其之前进行二次开发即可，对于底层的RPC通讯等都是透明的。眼下它支持的语言有C++, Java, Python, PHP, Ruby, Erlang, Perl, Haskell, C#, Cocoa, Smalltalk, and OCaml.

2. 下载与安装

能够在http://incubator.apache.org/thrift/download/去下载它的最新版本号，眼下最新版本号是0.5.0。另外你也能够check出它的svn,方法例如以下：

svn co http://svn.apache.org/repos/asf/thrift/trunk thrift

cd thrift

在它的jira中看到，它的0.6版本号也非常快就会出来了。

我的本本是debian 6.0，假设用ubuntu的兄弟安装方法也是一样的

tar -zxvf thrift-0.5.0.tar.gz<br />cd thrift-0.5.0<br />./configure<br />make<br />sudo make install 

这时thrift的代码生成器和一些库文件就生成好了。

你能够用例如以下命令看一下thrift的版本号信息

thrift -version 

3. 一个简单的样例

在thrift源码文件夹有一个叫tutorial的文件夹，进行当中后执行thrift命令生成对应的服务代码：

$ thrift -r –gen cpp tutorial.thrift // -r对当中include的文件也生成服务代码 -gen是生成服务代码的语言 

执行完之后会在当前文件夹看到一个gen-cpp文件夹，当中就是thrfit命令生成的代码

这时你cd到tutorial/cpp文件夹,执行make，生成对应的CppServer与CppClient程式。

这时你能够用./CppServer执行服务端，让其监听一个特定的port

这时你能够用./CppClient执行client程式，让其去连接服务端，调用其所相应的服务。默认调用后会输出例如以下信息：

lemo@debian:~/Workspace/Facebook/Thrift/thrift-0.5.0/tutorial/cpp$ ./CppServer<br />Starting the server…<br />ping()<br />add(1,1)<br />calculate(1,{4,1,0})<br />calculate(1,{2,15,10})<br />getStruct(1) 

假设你的终端中也出现了如上的信息，恭喜你，执行成功了。假设在执行CppServer的时候找不到动态库，看看你是不是执行了make install，假设执行了，再执行一下sudo ldconfig试试。再用ldd CppServer看一下它有没有找到对应的动态库了。

4. 样例分析

4.1 Thrift IDL的分析

这边有两个IDL文件，内容例如以下：

shared.thrift<br />—————<br />**<br /> * This Thrift file can be included by other Thrift files that want to share<br /> * these definitions.<br /> */<br />namespace cpp shared<br />namespace java shared<br />namespace perl shared<br />// 这里定义了一个结构体，未定义方法，相应于生成的代码在gen-cpp中的shared_types.h中，当中有一个class叫SharedStruct,<br />// 有没有看到当中有两个方法叫read和write，这就是用来对其进行序列化与把序列化的方法.<br />// 对了，当中的i32是Thrift IDL中定义的变量类型，相应于c++语言中的int32_t<br />struct SharedStruct {<br /> 1: i32 key<br /> 2: string value<br />}<br />// 这里定义的一个服务，它语义上相似于面向对象中的定义一个接口，thrift的编译器会对其产生一套实现其接口的client与服务端方法<br />// 服务的一般定义格式例如以下<br />// service <name><br />// <returntype> <name>(<arguments>)<br />// [ throws (<exceptions>)]<br />// …<br />// }<br />service SharedService {<br /> SharedStruct getStruct(1: i32 key)<br />}<br />tutorial.thrift<br />—————-<br />/**<br /> * Thrift files can reference other Thrift files to include common struct<br /> * and service definitions. These are found using the current path, or by<br /> * searching relative to any paths specified with the -I compiler flag.<br /> *<br /> * Included objects are accessed using the name of the .thrift file as a<br /> * prefix. i.e. shared.SharedObject<br /> */<br /> // 这个IDL包括了还有一个IDL,也就是说还有一个IDL中的对象与服务对其时可见的<br />include “shared.thrift”<br />/**<br /> * Thrift files can namespace, package, or prefix their output in various<br /> * target languages.<br /> */<br /> // 这里定义了一些语言的namespace空间<br />namespace cpp tutorial<br />namespace java tutorial<br />namespace php tutorial<br />namespace perl tutorial<br />/**<br /> * Thrift lets you do typedefs to get pretty names for your types. Standard<br /> * C style here.<br /> */<br /> // 自己定义类型<br />typedef i32 MyInteger<br />/**<br /> * Thrift also lets you define constants for use across languages. Complex<br /> * types and structs are specified using JSON notation.<br /> */<br /> // 定义一些变量<br />const i32 INT32CONSTANT = 9853<br />const map<string,string> MAPCONSTANT = {‘hello’:’world’, ‘goodnight’:’moon’}<br />/**<br /> * You can define enums, which are just 32 bit integers. Values are optional<br /> * and start at 1 if not supplied, C style again.<br /> */<br /> // 定义枚举类型<br />enum Operation {<br /> ADD = 1,<br /> SUBTRACT = 2,<br /> MULTIPLY = 3,<br /> DIVIDE = 4<br />}<br />/**<br /> * Structs are the basic complex data structures. They are comprised of fields<br /> * which each have an integer identifier, a type, a symbolic name, and an<br /> * optional default value.<br /> *<br /> * Fields can be declared “optional”, which ensures they will not be included<br /> * in the serialized output if they aren’t set. Note that this requires some<br /> * manual management in some languages.<br /> */<br />struct Work {<br /> 1: i32 num1 = 0,<br /> 2: i32 num2,<br /> 3: Operation op,<br /> 4: optional string comment, //这里的optional字段类型表示假设这个字段的值没有被赋值，它就不会被序列化输出<br />}<br />/**<br /> * Structs can also be exceptions, if they are nasty.<br /> */<br /> // 这里定义了一些异常<br />exception InvalidOperation {<br /> 1: i32 what,<br /> 2: string why<br />}<br />/**<br /> * Ahh, now onto the cool part, defining a service. Services just need a name<br /> * and can optionally inherit from another service using the extends keyword.<br /> */<br /> // 这里是定义服务，它继承了shared的服务<br />service Calculator extends shared.SharedService {<br /> /**<br /> * A method definition looks like C code. It has a return type, arguments,<br /> * and optionally a list of exceptions that it may throw. Note that argument<br /> * lists and exception lists are specified using the exact same syntax as<br /> * field lists in struct or exception definitions.<br /> */<br /> void ping(),<br /> i32 add(1:i32 num1, 2:i32 num2),<br /> i32 calculate(1:i32 logid, 2:Work w) throws (1:InvalidOperation ouch),<br /> /**<br /> * This method has a oneway modifier. That means the client only makes<br /> * a request and does not listen for any response at all. Oneway methods<br /> * must be void.<br /> */<br /> oneway void zip()<br />} 

4.2 服务端与client代码的分析

   4.2.1 c++服务端

   在tutorial/cpp文件夹中的CppServer.cpp是它的服务代码，主要分成两部分，

   一部分是main方法用于做一些初始化与服务的启动，第二部分对于IDL中定义的接口的实现

  int main(int argc, char **argv) {<br />// 定义了RPC的协议工厂，这里使用了二进制协议，你不能够使用别的协议，如JSON,Compact等<br />shared_ptr<TProtocolFactory> protocolFactory(new TBinaryProtocolFactory());<br />// 这里生成用户实现的CalculatorHandler服务，再把其帮定到一个Processor上去，它主要用于处理协议的输入与输出流<br />shared_ptr<CalculatorHandler> handler(new CalculatorHandler());<br />shared_ptr<TProcessor> processor(new CalculatorProcessor(handler));<br />// 生成一个传输通道，这里使用了Socket方式<br />shared_ptr<TServerTransport> serverTransport(new TServerSocket(9090));<br />// 生成一个传输工厂，主要用于把上面的transport转换成一个新的应用层传输通道<br />shared_ptr<TTransportFactory> transportFactory(new TBufferedTransportFactory());<br />// 生成一个简单的服务端，这是一个单线程的服务端<br />TSimpleServer server(processor,<br /> serverTransport,<br /> transportFactory,<br /> protocolFactory);<br />// 你也能够生成一个多线程的服务端，就是对其添�线程池。但它如今还不支持进程池，但可能会在0.7版本号中进行支持。<br /> /**<br /> * Or you could do one of these<br /> shared_ptr<ThreadManager> threadManager =<br /> ThreadManager::newSimpleThreadManager(workerCount);<br /> shared_ptr<PosixThreadFactory> threadFactory =<br /> shared_ptr<PosixThreadFactory>(new PosixThreadFactory());<br /> threadManager->threadFactory(threadFactory);<br /> threadManager->start();<br /> TThreadPoolServer server(processor,<br /> serverTransport,<br /> transportFactory,<br /> protocolFactory,<br /> threadManager);<br /> TThreadedServer server(processor,<br /> serverTransport,<br /> transportFactory,<br /> protocolFactory);<br /> */<br /> printf(“Starting the server…/n”);<br /> server.serve(); // 启动服务<br /> printf(“done./n”);<br /> return 0;<br />} 

还有一部分例如以下：

// 这一部分主要是实现接口类，用于提供给对应的服务使用。<br />class CalculatorHandler : public CalculatorIf {<br />public:<br /> CalculatorHandler() {}<br /> void ping() {<br /> printf(“ping()/n”);<br /> }<br /> int32_t add(const int32_t n1, const int32_t n2) {<br /> …<br /> }<br /> int32_t calculate(const int32_t logid, const Work &work) {<br /> …<br /> }<br /> void getStruct(SharedStruct &ret, const int32_t logid) {<br /> …<br /> }<br /> void zip() {<br /> printf(“zip()/n”);<br /> }<br />protected:<br /> map<int32_t, SharedStruct> log;<br />};<br /> 

4.2.2 c++client

int main(int argc, char** argv) {<br /> // 生成一个Socket连接到服务端<br /> shared_ptr<TTransport> socket(new TSocket(“localhost”, 9090));<br /> // 对Socket通道添�缓冲功能<br /> shared_ptr<TTransport> transport(new TBufferedTransport(socket));<br /> // 生成对应的二进制协议，这个要和服务端一致，不然会出现协议版本号不正确的错误<br /> shared_ptr<TProtocol> protocol(new TBinaryProtocol(transport));<br /> // 生成client的服务对象<br /> CalculatorClient client(protocol);<br /> try {<br /> transport->open(); // 加开服务<br /> // 调用事先定义好的服务接口<br /> client.ping();<br /> printf(“ping()/n”);<br /> int32_t sum = client.add(1,1);<br /> printf(“1+1=%d/n”, sum);<br /> Work work;<br /> work.op = Operation::DIVIDE;<br /> work.num1 = 1;<br /> work.num2 = 0;<br /> try {<br /> int32_t quotient = client.calculate(1, work);<br /> printf(“Whoa? We can divide by zero!/n”);<br /> } catch (InvalidOperation &io) {<br /> printf(“InvalidOperation: %s/n”, io.why.c_str());<br /> }<br /> work.op = Operation::SUBTRACT;<br /> work.num1 = 15;<br /> work.num2 = 10;<br /> int32_t diff = client.calculate(1, work);<br /> printf(“15-10=%d/n”, diff);<br /> // Note that C++ uses return by reference for complex types to avoid<br /> // costly copy construction<br /> SharedStruct ss;<br /> client.getStruct(ss, 1);<br /> printf(“Check log: %s/n”, ss.value.c_str());<br /> // 关闭服务<br /> transport->close();<br /> } catch (TException &tx) {<br /> printf(“ERROR: %s/n”, tx.what());<br /> }<br />} 

4.2.3 其他代码的实现

在tutorial文件夹中有其他代码的样例，如erl,java,python,perl,ruby等。

5 參考

1. http://incubator.apache.org/thrift/

2. http://incubator.apache.org/thrift/static/thrift-20070401.pdf