[Thrift]Apache Thrift入门Java实例

1. 概述

Apache Thrift 是 Facebook 实现的一种高效的、支持多种编程语言的远程服务调用的框架。本文将从 Java 开发人员角度详细介绍 Apache Thrift 的架构、开发和部署，并且针对不同的传输协议和服务类型给出相应的 Java 实例，同时详细介绍 Thrift 异步客户端的实现，最后提出使用 Thrift 需要注意的事项。

目前流行的服务调用方式有很多种，例如基于 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 的使用，并且提供丰富的实例代码加以解释说明，帮助使用者快速构建服务。

2. Maven依赖

Maven地址：http://mvnrepository.com/artifact/org.apache.thrift/libthrift

在这里，我使用的是0.9.3版本：

1. <!-- https://mvnrepository.com/artifact/org.apache.thrift/libthrift -->
2. <dependency>
3.    <groupId>org.apache.thrift</groupId>
4.    <artifactId>libthrift</artifactId>
5.    <version>0.9.3</version>
6. </dependency>

3. 安装 Thrift compiler

在编译.thrift文件时需要用到

1. xiaosi@Qunar:/opt/apache-flume-1.6.0-bin$ sudo apt-get install thrift-compiler
2. [sudo] xiaosi 的密码：
3. 正在读取软件包列表... 完成
4. 正在分析软件包的依赖关系树      
5. 正在读取状态信息... 完成      
6. 下列【新】软件包将被安装：
7.  thrift-compiler
8. 升级了 0 个软件包，新安装了 1 个软件包，要卸载 0 个软件包，有 162 个软件包未被升级。
9. 需要下载 819 kB 的软件包。
10. 解压缩后会消耗掉 2,944 kB 的额外空间。
11. 获取：1 http://cn.archive.ubuntu.com/ubuntu/ wily/universe thrift-compiler amd64 0.9.1-2 [819 kB]
12. 下载 819 kB，耗时 0秒 (982 kB/s)        
13. 正在选中未选择的软件包 thrift-compiler。
14. (正在读取数据库 ... 系统当前共安装有 273041 个文件和目录。)
15. 正准备解包 .../thrift-compiler_0.9.1-2_amd64.deb  ...
16. 正在解包 thrift-compiler (0.9.1-2) ...
17. 正在处理用于 man-db (2.7.4-1) 的触发器 ...
18. 正在设置 thrift-compiler (0.9.1-2) ...

4. 创建Thrift文件

在安装Thrift编译器之后，我们需要创建一个.thrift文件，在这里我们在main文件夹下创建calculator.thrift文件。

这个文件是一个接口定义（服务）文件。这些服务会被服务器端实现，被客户端调用。服务器端和客户端下面会讲解到。

1. // defines the namespace
2. namespace java com.sjf.open
4. service CalculatorService {
6.    i32 add(1:i32 num1, 2:i32 num2)
7.    i32 minus(1:i32 num1, 2:i32 num2)
8.    i32 multi(1:i32 num1, 2:i32 num2)
9.    i32 divi(1:i32 num1, 2:i32 num2)
11. }

其中定义了CalculatorService服务的4个方法，每个方法包含一个方法名，参数列表和返回类型。每个参数包括参数序号，参数类型以及参数名（1:i32 num1）。 Thrift 是对 IDL(Interface Definition Language) 描述性语言的一种具体实现。因此，以上的服务描述文件使用 IDL 语法编写。使用 Thrift 工具编译 Calculator.thrift，就会生成相应的 CalculatorService.java 文件。namespace 定义了命名空间，在java中为包，在这里我们会在com.sjf.open包下生成CalculatorService.java 文件。

5. 编译Thrift文件

Thrift编译器会将thrift文件编译成Java代码。使用下面的命令编译.thrift文件：

1. thrift --gen <language> <Thrift filename>

在我们例子中，命令为：

1. xiaosi@Qunar:~/code/open/openDiary/ThriftDemo/src/main$ thrift --gen java calculator.thrift

编译之后，会在gen-java文件夹下创建com.sjf.open包，并在包下生成CalculatorService.java 文件。

该文件包含了在 Calculator.thrift 文件中描述的服务 CalculatorService 的接口定义，即 CalculatorService.Iface 接口，以及服务调用的底层通信细节，包括客户端的调用逻辑 CalculatorService.Client 以及服务器端的处理逻辑 CalculatorService.Processor，用于构建客户端和服务器端的功能。

6. 创建Service Handler类

Service handler 类必须实现 CalculatorService.Iface接口。Handler类是接口的实现类。

1. package com.sjf.open;
3. import org.apache.thrift.TException;
5. /**
6. * Created by xiaosi on 16-9-20.
7. */
8. public class CalculatorHandler implements CalculatorService.Iface{
9.    public int add(int num1, int num2) throws TException {
10.        return num1 + num2;
11.    }
13.    public int minus(int num1, int num2) throws TException {
14.        return num1 - num2;
15.    }
17.    public int multi(int num1, int num2) throws TException {
18.        return num1 * num2;
19.    }
21.    public int divi(int num1, int num2) throws TException {
22.        if(num2 == 0){
23.            throw new RuntimeException("分母不能为0");
24.        }
25.        return num1 / num2;
26.    }
27. }

7. 创建服务器端CalculatorServer

创建服务器端实现代码，将 CalculatorHandler 作为具体的处理器传递给 Thrift 服务器。

1. package com.sjf.open;
3. import org.apache.thrift.server.TServer;
4. import org.apache.thrift.server.TSimpleServer;
5. import org.apache.thrift.transport.TServerSocket;
6. import org.apache.thrift.transport.TServerTransport;
8. /**
9. * Created by xiaosi on 16-9-20.
10. */
11. public class CalculatorServer {
13.    private static int port = 9090;
14.    private static CalculatorHandler handler;
15.    private static CalculatorService.Processor processor;
17.    /**
18.     * 启动服务器
19.     * @param processor
20.     */
21.    public static void start(CalculatorService.Processor processor){
22.        try {
23.            TServerTransport serverTransport = new TServerSocket(port);
24.            TServer server = new TSimpleServer(new TServer.Args(serverTransport).processor(processor));
26.            // Use this for a multithreaded server
27.            // TServer server = new TThreadPoolServer(new TThreadPoolServer.Args(serverTransport).processor(processor));
29.            System.out.println("Starting the simple server...");
30.            server.serve();
32.        } catch (Exception e) {
33.            e.printStackTrace();
34.        }
35.    }
37.    public static void main(String[] args) {
38.        handler = new CalculatorHandler();
39.        processor = new CalculatorService.Processor(handler);
40.        start(processor);
41.    }
42. }

8. 创建客户端CalculatorClient

创建客户端实现代码，调用 CalculatorService.client 访问服务端的逻辑实现。

1. package com.sjf.open;
4. import com.google.common.base.Objects;
5. import org.apache.thrift.TException;
6. import org.apache.thrift.protocol.TBinaryProtocol;
7. import org.apache.thrift.protocol.TProtocol;
8. import org.apache.thrift.transport.TSocket;
9. import org.apache.thrift.transport.TTransport;
10. import org.apache.thrift.transport.TTransportException;
12. /**
13. * Created by xiaosi on 16-9-20.
14. */
15. public class CalculatorClient {
17.    private static int port = 9090;
18.    private static String ip = "localhost";
19.    private static CalculatorService.Client client;
21.    private static TTransport transport;
23.    /**
24.     * 创建 TTransport
25.     * @return
26.     */
27.    public static TTransport createTTransport(){
29.        TTransport transport = new TSocket(ip, port);
30.        return transport;
32.    }
34.    /**
35.     * 开启 TTransport
36.     * @param transport
37.     * @throws TTransportException
38.     */
39.    public static void openTTransport(TTransport transport) throws TTransportException {
41.        if(Objects.equal(transport, null)){
42.            return;
43.        }
44.        transport.open();
46.    }
48.    /**
49.     * 关闭 TTransport
50.     * @param transport
51.     */
52.    public static void closeTTransport(TTransport transport){
54.        if(Objects.equal(transport, null)){
55.            return;
56.        }
57.        transport.close();
59.    }
61.    /**
62.     * 创建客户端
63.     * @return
64.     */
65.    public static CalculatorService.Client createClient(TTransport transport){
67.        if(Objects.equal(transport, null)){
68.            return null;
69.        }
71.        TProtocol protocol = new TBinaryProtocol(transport);
72.        if(Objects.equal(protocol, null)){
73.            return null;
74.        }
76.        CalculatorService.Client client = new CalculatorService.Client(protocol);
77.        return client;
78.    }
80.    public static void main(String[] args) {
82.        try {
84.            // 创建 TTransport
85.            transport = createTTransport();
87.            // 开启 TTransport
88.            openTTransport(transport);
90.            // 创建客户端
91.            client = createClient(transport);
93.            // 调用服务
94.            if(Objects.equal(client, null)){
95.                System.out.println("创建客户端失败...");
96.                return;
97.            }
98.            System.out.println(client.add(100, 200));
100.        } catch (TException e) {
101.            e.printStackTrace();
102.        }
103.        finally {
104.            // 关闭 TTransport
105.            closeTTransport(transport);
106.        }
107.    }
108. }

9. 运行

完成结构图：

运行服务端代码（CalculatorServer）将会看到下面的输出：

1. Starting the simple server...

然后运行客户端代码（CalculatorClient），将会看到如下输出：

10. 代码连接

https://github.com/sjf0115/OpenDiary/tree/master/ThriftDemo

参考连接：

http://thrift.apache.org/

http://thrift.apache.org/