Python 使用thrift

1. 什么是thrift

1.1 thrift 概述

Thrift 是一个跨语言的 RPC 框架，由 Facebook 开发，用于解决不同语言之间通信的问题。它可以定义数据类型和服务接口，并生成不同语言的代码，使得不同语言的程序能够相互通信。

1.2 thrift 的特点

跨语言支持：Thrift 支持多种编程语言，如 Java、Python、C++、Ruby 等，可以在不同语言之间进行通信。
支持多种数据传输协议：Thrift 支持多种数据传输协议，如二进制协议、压缩协议、JSON 格式等。
易于使用：Thrift 提供了简单易用的接口定义语言和代码生成工具，使得开发人员能够方便地定义数据类型和服务接口。
高性能：Thrift 使用二进制协议传输数据，具有较高的性能。

2. 安装 thrift

2.1 安装依赖

在使用 thrift 之前，需要先安装一些依赖库，如编译器和开发包。可以使用以下命令在 Ubuntu 上安装依赖：

sudo apt-get install automake bison flex g++ git libboost-all-dev libevent-dev libssl-dev libtool make pkg-config

2.2 编译和安装 thrift

可以从 Apache 官网下载最新版本的 thrift 源码包，然后解压缩到本地目录。接下来，进入该目录，执行以下命令进行编译和安装：

./configure
make
sudo make install

编译和安装完成后，就可以在命令行中使用 thrift 命令了。

3. 使用 thrift 定义接口

3.1 编写接口定义文件

Thrift 使用一个接口定义文件来定义数据结构和服务接口。接口定义文件使用 Thrift 的接口定义语言（IDL）编写，具有类似于 C 语言的语法。

例如，我们可以编写一个名为 “example.thrift” 的接口定义文件，包含一个数据结构和一个服务接口的定义：

namespace py example

struct Person {
    1: required string name,
    2: optional i32 age,
}

service HelloWorld {
    void sayHello(1: string name),
    list<Person> getPersonList(),
}

在上述例子中，我们定义了一个名为 “Person” 的数据结构，包含一个必选的字符串字段 “name” 和一个可选的整型字段 “age”。接下来，我们定义了一个名为 “HelloWorld” 的服务接口，包含两个方法：一个是不返回任何结果的 “sayHello” 方法，它接受一个字符串参数 “name”；另一个是返回一个包含多个 “Person” 对象的列表的 “getPersonList” 方法。

3.2 生成代码

定义好接口之后，我们可以使用 thrift 命令生成相应语言的代码。例如，要生成 Python 代码，可以使用以下命令：

thrift --gen py example.thrift

上述命令将会在当前目录下生成一个 “gen-py” 文件夹，其中包含了生成的 Python 代码。

4. 编写服务端代码

在 Python 中使用 thrift，需要安装 thrift 库。可以使用以下命令进行安装：

pip install thrift

接下来，我们可以编写一个服务端的 Python 脚本，提供实现了 thrift 接口的方法。

import sys
sys.path.append('gen-py')

from example import HelloWorld
from example.ttypes import Person

from thrift.transport import TSocket
from thrift.transport import TTransport
from thrift.protocol import TBinaryProtocol
from thrift.server import TServer

class HelloWorldHandler(HelloWorld.Iface):
    def sayHello(self, name):
        return "Hello, " + name + "!"

    def getPersonList(self):
        person_list = []
        person1 = Person()
        person1.name = "John"
        person1.age = 25
        person_list.append(person1)
        person2 = Person()
        person2.name = "Alice"
        person2.age = 30
        person_list.append(person2)
        return person_list

handler = HelloWorldHandler()
processor = HelloWorld.Processor(handler)
transport = TSocket.TServerSocket(port=9090)
tfactory = TTransport.TBufferedTransportFactory()
pfactory = TBinaryProtocol.TBinaryProtocolFactory()

server = TServer.TSimpleServer(processor, transport, tfactory, pfactory)
print("Starting the server...")
server.serve()
print("Server stopped.")

以上代码实现了一个简单的服务端，实现了 thrift 接口中定义的方法。在 sayHello 方法中，接收一个名为 “name” 的参数，并返回一个拼接了 “Hello, ” 的字符串。在 getPersonList 方法中，返回了一个包含了两个 Person 对象的列表。

4.1 运行服务端

运行这个服务端代码可以启动 thrift 服务。在命令行中执行以下命令：

python server.py

服务端即可开始监听 9090 端口，并等待客户端的请求。

5. 编写客户端代码

编写一个客户端的 Python 脚本，用于调用 thrift 服务端的接口。

import sys
sys.path.append('gen-py')

from example import HelloWorld
from example.ttypes import Person

from thrift.transport import TSocket
from thrift.transport import TTransport
from thrift.protocol import TBinaryProtocol

transport = TSocket.TSocket('localhost', 9090)
transport = TTransport.TBufferedTransport(transport)
protocol = TBinaryProtocol.TBinaryProtocol(transport)

client = HelloWorld.Client(protocol)
transport.open()

name = "Alice"
result = client.sayHello(name)
print("sayHello result:", result)

person_list = client.getPersonList()
for person in person_list:
    print(person.name, person.age)

transport.close()

以上代码实现了一个简单的客户端，通过 thrift 连接到服务端，并调用其提供的接口方法。在代码中，我们调用了服务端的 sayHello 方法，并打印了其返回结果。接下来，我们调用了服务端的 getPersonList 方法，并遍历了返回的 Person 对象列表，并打印了每个 Person 对象的 name 和 age 字段。