深入理解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，可以為你在不同場景下提供靈活的配置和選擇。