Pure python approach of Apache Thrift（https://github.com/Thriftpy/thriftpy2.git）

数据类型（IDL）

基本类型

  • bool: 布尔值 (true or false), one byte
  • byte: 有符号字节
  • i16: 16位有符号整型
  • i32: 32位有符号整型
  • i64: 64位有符号整型
  • double: 64位浮点型
  • string: 包括文本类型和二进制字符串
  • void: 方法无返回值，可以定义返回类型为 void


容器类型

  • list: 元素类型为t1的有序表，容许元素重复
  • set:元素类型为t1的无序表，不容许元素重复
  • map: 键类型为t1，值类型为t2的kv对，键不容许重复

枚举类型

枚举可以指定每个元素的值，也可以不指定，默认从 0 开始递增

  1. enum TweetType {
  2.     TWEET,
  3.     RETWEET = 2,
  4.     DM = 0xa,
  5.     REPLY
  6. }

结构体

thrift 要求每个域都必须有一个唯一的正整数标识符，结构体可以包含其它结构体，可以指定默认值

  1. struct Location {
  2.     1: required double latitude = 1.0;
  3.     2: required double longitude;
  4. }

常量

  1. const i32 INT_CONST = 1234;

其他

  • namespace – 用于指定不同语言生成的目录结构

    namespace cpp project namespace java com.example.project namespace php project

  • include – 用于引用其他 idl 文件

    include “tweet.thrift”

Thrift IDL

  1. const i16 DEFAULT_LIST_SIZE = 10
  3. typedef i32 timestamp
  5. enum PhoneType {
  6.     MOBILE = 0,
  7.     HOME,
  8.     WORK,
  9. }
  11. struct PhoneNumber {
  12.     1: optional PhoneType type = PhoneType.MOBILE,
  13.     2: optional string number,
  14. }
  16. struct Person {
  17.     1: required string name,
  18.     2: optional list<PhoneNumber> phones,
  19.     3: optional timestamp created_at,
  20. }
  22. # 异常定义
  23. exception PersonNotExistsError {
  24.     1: optional string message = "Person Not Exists!",
  25. }
  27. service PersonService {
  28.     bool add(1: required Person person);
  29.     bool remove(1: string name) throws (1: PersonNotExistsError not_exists);
  30.     Person get(1: string name) throws (1: PersonNotExistsError not_exists);
  31. }

服务端

  1. import asyncio
  2. import thriftpy2
  4. from thriftpy2.rpc import make_aio_server
  6. echo_thrift = thriftpy2.load("echo.thrift", module_name="echo_thrift")
  9. class Dispatcher(object):
  10.     async def echo(self, param):
  11.         print(param)
  12.         await asyncio.sleep(0.1)
  13.         return param
  16. def main():
  17.     server = make_aio_server(
  18.         echo_thrift.EchoService, Dispatcher(), '127.0.0.1', 6000)
  19.     server.serve()
  22. if __name__ == '__main__':
  23.     main()

客户端

同步

  1. import thriftpy2
  2. pingpong_thrift = thriftpy2.load("pingpong.thrift", module_name="pingpong_thrift")
  4. from thriftpy2.rpc import make_client
  6. client = make_client(pingpong_thrift.PingPong, '127.0.0.1', 6000)
  7. print(client.ping())

异步

仅支持Python3.5以上

  1. import thriftpy2
  2. import asyncio
  3. from thriftpy2.rpc import make_aio_client
  6. echo_thrift = thriftpy2.load("echo.thrift", module_name="echo_thrift")
  9. async def request():
  10.     client = await make_aio_client(
  11.         echo_thrift.EchoService, '127.0.0.1', 6000)
  12.     print(await client.echo('hello, world'))
  13.     client.close()

参考资源

分会场B-【5】从 Thriftpy 中学习 RPC 协议 - 张汝家.pdf

https://landybird.github.io/thrift/2019/01/26/thrift%E7%9A%84%E7%AE%80%E5%8D%95%E4%BD%BF%E7%94%A8(%E5%9B%9B)//)