跨语言的服务调用框架Apache Thrift

远程过程调用RPC(Remote Procedure Call)是较为常用的服务调用接口，它可以跨语言、跨平台、跨网络，在接口规范、安全性以及接口效率方面都具有优势。

Apache Thrift框架可以快速生成不同语言的接口服务代码，支持的语言包括：C++, Java, Python, PHP, Ruby, Erlang, Perl, Haskell, C#, Cocoa, JavaScript, Node.js, Smalltalk等。结合Apache Thrift框架提供的软件栈，可以快速实现RPC服务或将已有服务转化为RPC服务。

Thrift的使用也非常简单，首先编写接口定义文件，例如下面的接口定义文件calc.thrift：

namespace py tutorial

/*定义一个复数类型的数据结构*/
struct Complex {
  1: double real = 0,/*实部*/
  2: double imaginary = 0,/*虚部*/
}

/**
 * 定义一个异常.
 */
exception InvalidOperation {
  1: i32 whatOp,
  2: string why
}

/**
 定义一个计算器服务
*/
service Calculator {

  /**
   * 类似C语言的函数定义. 包含返回类型，参数，.
   */
  /*
   整数的加法接口
  */
  i32 add(1:i32 num1, 2:i32 num2),
  /*
   整数的除法接口，该接口可抛出异常
  */
  i32 div(1:i32 num1, 2:i32 num2) throws (1:InvalidOperation err),
  
  /*复数的加法接口*/
  Complex add_complex(1:Complex c1,2:Complex c2)
}

可以看出，接口定义语言和c语言非常相似。在接口定义中，可以定义结构、常量、异常，以及核心的接口服务以及调用方法。有了上述接口定义文件后，就可以编译出自己所需的编程语言代码框架，例如，我们要生成python代码，则执行下列命令。

thrift --gen python calc.thrift

该命令将生成Pyhon代码，如下图，其中的Calculator.py中包含了我们需要在客户端和服务端使用的客户端类Client和服务端处理类Processor。在ttypes.py中则包含了自定义的数据结构。

在服务器代码的实现中，需要创建一个实现具体方法的类CalculatorHandler，并传递到Processor实例中。示例如下：

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

from tutorial import Calculator
from tutorial.ttypes import InvalidOperation,Complex

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

class CalculatorHandler:
    def __init__(self):
        self.log = {}

    def add(self, n1, n2):
        print('add(%d,%d)' % (n1, n2))
        return n1 + n2

    def add_complex(self, c1, c2):
        print('add complex')
        return Complex(c1.real+c2.real,c1.imaginary+c2.imaginary)

if __name__ == '__main__':
		#创建服务端
    handler = CalculatorHandler()
    processor = Calculator.Processor(handler)
    transport = TSocket.TServerSocket(host='127.0.0.1', port=8080)
    tfactory = TTransport.TBufferedTransportFactory()
    pfactory = TBinaryProtocol.TBinaryProtocolFactory()

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

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

在客户端代码中，我们用Calculator.Client类创建客户端实例与服务器端通信，代码如下：

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

from tutorial import Calculator
from tutorial.ttypes import InvalidOperation, Complex

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

def complexString(complexNumer):
    sign = "" if complexNumer.imaginary<0 else "+"
    return "{}{}{}i".format(complexNumer.real,sign,complexNumer.imaginary)

if __name__ == '__main__':
    # 创建连接及缓存
    transport = TSocket.TSocket('localhost', 8080)
    transport = TTransport.TBufferedTransport(transport)
    protocol = TBinaryProtocol.TBinaryProtocol(transport)

    # 创建客户端实例
    client = Calculator.Client(protocol)

    # 连接
    transport.open()

		# 调用加法
    sum_ = client.add(1, 1)
    print('1+1=%d' % sum_)

		# 调用复数加法
    c1 = Complex(1.01,2.02)
    c2 = Complex(3.5,-4.7)
    
    sum_2 = client.add_complex(c1, c2)
    print("({}) + ({}) = {}".format(complexString(c1),complexString(c2),complexString(sum_2)))    

    # 断开连接
    transport.close()

上述代码如果出现找不到thrift模块的错误，则需安装thrift模块，在所使用的的python环境下，运行

pip install thrift

客户端代码运行的结果如下：

1+1=2

(1.01+2.02i) + (3.5-4.7i) = 4.51-2.68i