深入理解Thrift Python

一、Thrift Python 简介

Apache Thrift 是一个软件框架，用于开发可伸缩的跨语言服务。它提供了一组工具和库，使开发人员能够快速创建跨平台、跨语言的服务。Thrift Python 以 Python 为中心，支持 Python 2.x 和 3.x 版本。

Thrift Python 提供了一个简单易用的 Python API，以及一个针对 Python 生成的 Thrift 编译器。它支持从 Thrift IDL 文件生成 Python 代码，以及从 Python 代码生成 Thrift 消息。同时，它还支持各种 Transports 和 Protocols，使得开发人员能够针对自己的需求进行灵活的配置。

二、Thrift Python 的使用

1. 安装 Thrift Python

Thrift Python 可以通过 pip 安装：

sudo pip install thrift

2. 定义 Thrift IDL

定义 Thrift IDL 是定义 Thrift 服务的第一步。以下是一个简单的示例：

namespace py thrift.demo

struct Person {
  1: required string username,
  2: optional i32 age,
  3: optional bool isMale
}

service PersonService {
  Person getPerson(1: string username),
  bool updatePerson(1: Person person)
}

以上示例定义了一个名为 Person 的 struct 和一个名为 PersonService 的服务。服务中包含两个函数：getPerson 和 updatePerson。getPerson 函数接收一个参数 username，返回一个 Person 对象；updatePerson 函数接收一个参数 person，返回一个 bool 类型的值。

3. 生成 Python 代码

使用 Thrift 编译器生成 Python 代码：

thrift --gen py person.thrift

这将在当前目录下生成 Python 代码。如果你要引入生成的 Python 代码，请将该目录添加到 PYTHONPATH 中。

4. 实现 Thrift 服务

下面是一个简单的 Thrift 服务的示例：

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

from person import PersonService
from person.ttypes import Person

class PersonServiceHandler:
    def getPerson(self, username):
        print("getPerson(%r)" % username)
        return Person()

    def updatePerson(self, person):
        print("updatePerson(%r)" % person)
        return True

handler = PersonServiceHandler()
processor = PersonService.Processor(handler)

transport = TSocket.TServerSocket("localhost", 9090)
tfactory = TTransport.TFramedTransportFactory()
pfactory = TCompactProtocol.TCompactProtocolFactory()

server = TServer.TThreadedServer(processor, transport, tfactory, pfactory)

print("Starting the server...")
server.serve()
print("done.")

以上代码（假设保存为 person_server.py）实现了 PersonServiceHandler 类，该类是 PersonService 服务的处理器。当客户端请求 PersonService 服务时，将调用 PersonServiceHandler 实例的相应方法。

在程序中，我们使用 TSocket 创建了一个 TServerSocket 监听指定的主机和端口。同时，我们创建了 TTransport 和 TProtocol 工厂，为程序提供了更好的灵活性。例如，我们可以在 TServer 中使用 TCompactProtocol 代替 TBinaryProtocol，以提高程序的效率。

5. 客户端调用服务

下面是一个简单的客户端程序的示例：

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

from person import PersonService
from person.ttypes import Person

transport = TSocket.TSocket("localhost", 9090)
transport = TTransport.TFramedTransport(transport)
protocol = TBinaryProtocol.TBinaryProtocol(transport)
client = PersonService.Client(protocol)

transport.open()

person = client.getPerson("username")
print("getPerson: %r" % person)

result = client.updatePerson(Person())
print("updatePerson: %r" % result)

transport.close()

以上代码（假设保存为 person_client.py）创建了一个客户端程序，该程序通过 TSocket 连接到服务端程序的主机和端口。 客户端程序使用 TTransport 和 TProtocol 来序列化和反序列化消息。

使用 Thrift Python，你可以轻松地创建跨语言、跨平台的服务，不管你是在 Python 2.x 还是 3.x 环境下工作。Thrift Python 还支持多种 Transport 和 Protocol，可以为你在不同场景下提供灵活的配置和选择。