Apache Thrift 服务开发框架学习记录

　　Apache Thrift 是 Facebook 实现的一种高效的、支持多种编程语言的远程服务调用的框架。

前言：

目前流行的服务调用方式有很多种，例如基于 SOAP 消息格式的 Web Service，基于 JSON 消息格式的 RESTful 服务等。其中所用到的数据传输方式包括 XML，JSON 等，然而 XML 相对体积太大，传输效率低，JSON 体积较小，新颖，但还不够完善。

本文将介绍由 Facebook 开发的远程服务调用框架 Apache Thrift，它采用接口描述语言定义并创建服务，支持可扩展的跨语言服务开发，所包含的代码生成引擎可以在多种语言中，如 C++, Java, Python, PHP, Ruby, Erlang, Perl, Haskell, C#, Cocoa, Smalltalk 等创建高效的、无缝的服务，其传输数据采用二进制格式，相对 XML 和 JSON 体积更小，对于高并发、大数据量和多语言的环境更有优势。

使用Thrift和传统的Corba之类的RPC框架并无太大差异，主要分为如下三个部分：

使用IDL定义提供的服务：主要用于服务接口和数据传输对象（DTO）并且有一套自己的语法， Thrift中命名为thirft文件，并且有一套自己的语法。
将IDL编译成框架代码
客户端使用框架代码调用远程服务
服务端使用框架代码实现接口，并提供服务

和传统RPC框架一样，Thrift框架提供数据传输的服务，服务端和客户端只需要关注业务即可；这一系列流程并没有多大新颖的地方。

一个简单的 Thrift 实例：

首先介绍一个简单的 Thrift 实现实例，快速直观地了解什么是 Thrift 以及如何使用 Thrift 构建服务。

创建一个简单的服务 Hello。首先根据 Thrift 的语法规范编写脚本文件 Hello.thrift，代码如下：

 namespace java service.demo

 service Hello{

  string helloString(1:string para)

  i32 helloInt(1:i32 para)

  bool helloBoolean(1:bool para)

  void helloVoid()

  string helloNull()

 }

其中定义了服务 Hello 的五个方法，每个方法包含一个方法名，参数列表和返回类型。每个参数包括参数序号，参数类型以及参数名。

Thrift 是对 IDL(Interface Definition Language) 描述性语言的一种具体实现。因此，以上的服务描述文件使用 IDL 语法编写。使用 Thrift 工具编译 Hello.thrift，就会生成相应的 Hello.java 文件。该文件包含了在 Hello.thrift 文件中描述的服务 Hello 的接口定义，即 Hello.Iface 接口，以及服务调用的底层通信细节，包括客户端的调用逻辑 Hello.Client 以及服务器端的处理逻辑 Hello.Processor，用于构建客户端和服务器端的功能。

HelloServiceImpl.java

创建 HelloServiceImpl.java 文件并实现 Hello.java 文件中的 Hello.Iface 接口，代码如下：

package service.demo;

 import org.apache.thrift.TException;

 public class HelloServiceImpl implements Hello.Iface {

    @Override

    public boolean helloBoolean(boolean para) throws TException {

        return para;

    }

    @Override

    public int helloInt(int para) throws TException {

        try {

            Thread.sleep(20000);

        } catch (InterruptedException e) {

            e.printStackTrace();

        }

        return para;

    }

    @Override

    public String helloNull() throws TException {

        return null;

    }

    @Override

    public String helloString(String para) throws TException {

        return para;

    }

    @Override

    public void helloVoid() throws TException {

        System.out.println("Hello World");

    }

 }

创建服务器端实现代码，将 HelloServiceImpl 作为具体的处理器传递给 Thrift 服务器，代码如下：

HelloServiceServer.java

package service.server;

 import org.apache.thrift.TProcessor;

 import org.apache.thrift.protocol.TBinaryProtocol;

 import org.apache.thrift.protocol.TBinaryProtocol.Factory;

 import org.apache.thrift.server.TServer;

 import org.apache.thrift.server.TThreadPoolServer;

 import org.apache.thrift.transport.TServerSocket;

 import org.apache.thrift.transport.TTransportException;

 import service.demo.Hello;

 import service.demo.HelloServiceImpl; 

 public class HelloServiceServer {

    /**

     * 启动 Thrift 服务器

     * @param args

     */

    public static void main(String[] args) {

        try {

            // 设置服务端口为 7911

            TServerSocket serverTransport = new TServerSocket(7911);

            // 设置协议工厂为 TBinaryProtocol.Factory

            Factory proFactory = new TBinaryProtocol.Factory();

            // 关联处理器与 Hello 服务的实现

            TProcessor processor = new Hello.Processor(new HelloServiceImpl());

            TServer server = new TThreadPoolServer(processor, serverTransport,

                    proFactory);

            System.out.println("Start server on port 7911...");

            server.serve();

        } catch (TTransportException e) {

            e.printStackTrace();

        }

    }

 }

创建客户端实现代码，调用 Hello.client 访问服务端的逻辑实现，代码如下：

HelloServiceClient.java

package service.client;

 import org.apache.thrift.TException;

 import org.apache.thrift.protocol.TBinaryProtocol;

 import org.apache.thrift.protocol.TProtocol;

 import org.apache.thrift.transport.TSocket;

 import org.apache.thrift.transport.TTransport;

 import org.apache.thrift.transport.TTransportException;

 import service.demo.Hello; 

 public class HelloServiceClient {

 /**

     * 调用 Hello 服务

     * @param args

     */

    public static void main(String[] args) {

        try {

            // 设置调用的服务地址为本地，端口为 7911

            TTransport transport = new TSocket("localhost", 7911);

            transport.open();

            // 设置传输协议为 TBinaryProtocol

            TProtocol protocol = new TBinaryProtocol(transport);

            Hello.Client client = new Hello.Client(protocol);

            // 调用服务的 helloVoid 方法

            client.helloVoid();

            transport.close();

        } catch (TTransportException e) {

            e.printStackTrace();

        } catch (TException e) {

            e.printStackTrace();

        }

    }

 }

代码编写完后运行服务器，再启动客户端调用服务 Hello 的方法 helloVoid，在服务器端的控制台窗口输出“Hello World”(helloVoid 方法实现在控制台打印字符串，没有返回值，所以客户端调用方法后没有返回值输出，读者可以自己尝试其他有返回值方法的调用，其结果可以打印在客户端的控制台窗口 )。