python thrift使用实例

Transport网络读写（socket，http等）抽象，用于和其他thrift组件解耦。

Transport的接口包括：open, close, read, write, flush, isOpen, readAll。

Server端需要ServerTransport（对监听socket的一种抽象），用于接收客户端连接，接口包括：listen, accept, close。

python中Transport的实现包括：TSocket, THttpServer, TSSLSocket, TTwisted, TZlibTransport，都是对某种协议或框架的实现。还有两个装饰器，用于为已有的Transport添加功能，TBufferedTransport（增加缓冲）和TFramedTransport（添加帧）。

在创建server时，传入的时Tranport的工厂，这些Factory包括：TTransportFactoryBase（没有任何修饰，直接返回），TBufferedTransportFactory（返回带缓冲的Transport）和TFramedTransportFactory（返回帧定位的Transport）。

Protocol用于对数据格式抽象，在rpc调用时序列化请求和响应。

TProtocol的实现包括：TJSONProtocol，TSimpleJSONProtocol，TBinaryProtocol，TBinaryPotocolAccelerated，TCompactProtocol。

Processor对stream读写抽象，最终会调用用户编写的handler已响应对应的service。具体的Processor有compiler生成，用户需要实现service的实现类。

Server创建Transport，输入、输出的Protocol，以及响应service的handler，监听到client的请求然后委托给processor处理。

TServer是基类，构造函数的参数包括：

1) processor, serverTransport

2) processor, serverTransport, transportFactory, protocolFactory

3) processor, serverTransport, inputTransportFactory, outputTransportFactory, inputProtocolFactory, outputProtocolFactory

TServer内部实际上需要3）所列的参数，1）和2）会导致对应的参数使用默认值。

TServer的子类包括：TSimpleServer, TThreadedServer, TThreadPoolServer, TForkingServer, THttpServer, TNonblockingServer, TProcessPoolServer

TServer的serve方法用于开始服务，接收client的请求。

constants.py: 包含声明的所有常量

ttypes.py: 声明的struct，实现了具体的序列化和反序列化

SERVICE_NAME.py: 对应service的描述文件，包含了：

Iface: service接口定义

Client: client的rpc调用桩

Thrift的用法实际上很简单，定义好IDL，然后实现service对应的handler（方法名、参数列表与接口定义一致接口），最后就是选择各个组件。
需要选择的包括：Transport（一般都是socket，只是十分需要选择buffed和framed装饰器factory），Protocol，Server。

namespace py example

struct Data {

    1: string text

    2: i32 id

}

service format_data {

    Data do_format(1:Data data),

}

#! /usr/bin/env python

# -*- coding: utf-8 -*-

import os

import sys

cur_path =os.path.abspath(os.path.join(os.path.dirname('__file__'), os.path.pardir))

sys.path.append(cur_path)

from example import format_data

from example import ttypes

from thrift.transport import TSocket

from thrift.transport import TTransport

from thrift.protocol import TBinaryProtocol

from thrift.server import TServer

__HOST = 'localhost'

__PORT = 9000

class FormatDataHandler(object):

    def do_format(self, data):

        print(data.text, data.id)

        # can do something

        return ttypes.Data(data.text.upper(), data.id)

if __name__ == '__main__':

    handler = FormatDataHandler()

    processor = format_data.Processor(handler)

    transport = TSocket.TServerSocket(__HOST, __PORT)

    # 传输方式，使用buffer

    tfactory = TTransport.TBufferedTransportFactory()

    # 传输的数据类型：二进制

    pfactory = TBinaryProtocol.TBinaryProtocolFactory()

    # 创建一个thrift 服务

    rpcServer = TServer.TSimpleServer(processor,transport, tfactory, pfactory)

    print('Starting the rpc server at', __HOST,':', __PORT)

    rpcServer.serve()

    print('done')

#! /usr/bin/env python

# -*- coding: utf-8 -*-

import os

import sys

sys.path.append(os.path.abspath(os.path.join(os.path.dirname('__file__'), os.path.pardir)))

from thrift.transport import TSocket

from thrift.transport import TTransport

from thrift.protocol import TBinaryProtocol

from example.format_data import Client

from example.format_data import Data

__HOST = 'localhost'

__PORT = 9000

try:

    tsocket = TSocket.TSocket(__HOST, __PORT)

    transport = TTransport.TBufferedTransport(tsocket)

    protocol = TBinaryProtocol.TBinaryProtocol(transport)

    client = Client(protocol)

    data = Data('hello,world!', 123)

    transport.open()

    print('client-requets')

    res = client.do_format(data)

    # print(client.do_format(data).text)

    print('server-answer', res)

    transport.close()

except Thrift.TException as ex:

    print(ex.message)