Thrift—IDL基本类型

本是古典何须时尚 2021-06-24 14:37 314阅读 0赞

thrift 采用IDL（Interface Definition Language）来定义通用的服务接口，并通过生成不同的语言代理实现来达到跨语言、平台的功能。在thrift的IDL中可以定义以下一些类型：基本数据类型，结构体，容器，异常、服务

## 1基本类型 ##

*  bool: 布尔值 (true or false), one byte
 *  byte: 有符号字节
 *  i16: 16位有符号整型
 *  i32: 32位有符号整型
 *  i64: 64位有符号整型
 *  double: 64位浮点型
 *  string: Encoding agnostic text or binary string

基本类型中基本都是有符号数，因为有些语言没有无符号数，所以Thrift不支持无符号整型。

## 2特殊类型 ##

binary: Blob (byte array) a sequence of unencoded bytes

这是string类型的一种变形，主要是为[Java][]使用，目前我主要使用C++的语言，所以java的这个类型没有用过

## 3struct ##

thrift中struct是定义为一种对象，和面向对象语言的class差不多.,但是struct有以下一些约束：

*  struct不能继承，但是可以嵌套，不能嵌套自己。
 *  其成员都是有明确类型
 *  成员是被正整数编号过的，其中的编号使不能重复的，这个是为了在传输过程中编码使用。
 *  成员分割符可以是逗号（,）或是分号（;），而且可以混用，但是为了清晰期间，建议在定义中只使用一种，比如C++学习者可以就使用分号（;）。
 *  字段会有optional和required之分和protobuf一样，但是如果不指定则为无类型—可以不填充该值，但是在序列化传输的时候也会序列化进去，optional是不填充则部序列化，required是必须填充也必须序列化。
 *  每个字段可以设置默认值
 *  同一文件可以定义多个struct，也可以定义在不同的文件，进行include引入。

数字标签作用非常大，但是随着项目开发的不断发展，也许字段会有变化，但是建议不要轻易修改这些数字标签，修改之后如果没有同步客户端和服务器端会让一方解析出问题。

规范的struct定义中的每个域均会使用required或者 optional关键字进行标识。如果required标识的域没有赋值，Thrift将给予提示；如果optional标识的域没有赋值，该域将不会被序列化传输；如果某个optional标识域有缺省值而用户没有重新赋值，则该域的值一直为缺省值；如果某个optional标识域有缺省值或者用户已经重新赋值，而不设置它的\_\_isset为true，也不会被序列化传输。

## 4容器（Containers） ##

Thrift容器与目前流行编程语言的容器类型相对应，有3种可用容器类型：

* list<t>: 元素类型为t的有序表，容许元素重复。对应c++的vector，java的ArrayList或者其他语言的数组（官方文档说是ordered list不知道如何理解？排序的？c++的vector不排序）
 * set<t>:元素类型为t的无序表，不容许元素重复。对应c++中的set，java中的HashSet,python中的set，php中没有set，则转换为list类型了
 * map<t,t>: 键类型为t，值类型为t的kv对，键不容许重复。对用c++中的map, Java的HashMap, PHP 对应 array, Python/Ruby 的dictionary。

容器中元素类型可以是除了service外的任何合法Thrift类型（包括结构体和异常）。为了最大的兼容性，map的key最好是thrift的基本类型，有些语言不支持复杂类型的key，JSON协议只支持那些基本类型的key。

容器都是同构容器，不失异构容器。

例子

## 5枚举（enmu） ##

很多语言都有枚举，意义都一样。比如，当定义一个消息类型时，它只能是预定义的值列表中的一个，可以用枚举实现。说明：

*  编译器默认从0开始赋值
 *  可以赋予某个常量某个整数
 *  允许常量是十六进制整数
 *  末尾没有分号
 *  给常量赋缺省值时，使用常量的全称

注意，不同于protocal buffer，thrift不支持枚举类嵌套，枚举常量必须是32位的正整数

<table style="color:rgb(0,0,0); padding:0px; margin:0px; font-family:Verdana,Arial,Helvetica,sans-serif; font-size:13px; line-height:22px"> 
 <tbody style="padding:0px; margin:0px"> 
 <tr style="padding:0px; margin:0px"> 
 <td style="padding:0px; margin:0px">enum EnOpType { CMD_OK = 0, // (0)&nbsp;　　CMD_NOT_EXIT = 2000, // (2000) CMD_EXIT = 2001, // (2001)&nbsp;&nbsp;　　 CMD_ADD = 2002 // (2002) } struct StUser { 1: required i32 userId; 2: required string userName; 3: optional EnOpType cmd_code = EnOpType.CMD_OK; // (0) 4: optional string language = “english” } </td> 
 </tr> 
 </tbody> 
</table>

枚举类型和struct编译后的c++代码

<table style="color:rgb(0,0,0); padding:0px; margin:0px; font-family:Verdana,Arial,Helvetica,sans-serif; font-size:13px; line-height:22px"> 
 <tbody style="padding:0px; margin:0px"> 
 <tr style="padding:0px; margin:0px"> 
 <td style="padding:0px; margin:0px">struct EnOpType { &nbsp;enum type { &nbsp;CMD_OK = 0, CMD_NOT_EXIT = 2000, CMD_EXIT = 2001, CMD_ADD = 2002 }; }; class StUser { public: 。。。。。。 </td> 
 </tr> 
 </tbody> 
</table>

枚举类型编译后被struct封装了，struct编译后成了class，当然其中方法了多了很多。

## 6常量定义和类型定义 ##

Thrift允许定义跨语言使用的常量，复杂的类型和结构体可使用JSON形式表示。

说明：分号可有可无。支持16进制。

Thrift支持C/C++类型定义。

说明：a.末尾没有逗号。b. Struct也可以使用typedef。

## 7异常（Exceptions） ##

Thrift结构体在概念上类似于（similar to）C语言结构体类型—将相关属性封装在一起的简便方式。Thrift结构体将会被转换成面向对象语言的类。

异常在语法和功能上类似于结构体，差别是异常使用关键字exception，而且异常是继承每种语言的基础异常类。

## 8服务（Services） ##

服务的定义方法在语义(semantically)上等同于面向对象语言中的接口。Thrift编译器会产生执行这些接口的client和server stub。具体参见下一节。

在流行的序列化/反序列化框架（如protocal buffer）中，Thrift是少有的提供多语言间RPC服务的框架。这是Thrift的一大特色。

Thrift编译器会根据选择的目标语言为server产生服务接口代码，为client产生stubs。

编译后的c++代码

*  首先所有的方法都是纯虚汗数，也就是继承类必须实现这些方法
 *  返回值不是基本类型的都把返回值放到了函数参数中第一个参数，命名\_return
 *  所有的参数（除返回值）都是const类型，意味这函数一般参数无法作为返回值携带者。只会有一个返回参数，如果返回值有多个，那只能封装复杂类型作为返回值参数。
 *  oneway的返回值一定是void
 *  当然服务是支持继承。
 *  服务不支持重载

## 9名字空间（Namespace） ##

Thrift中的命名空间类似于C++中的namespace和java中的package，它们提供了一种组织（隔离）代码的简便方式。名字空间也可以用于解决类型定义中的名字冲突。

由于每种语言均有自己的命名空间定义方式（如[Python][]中有module）, thrift允许开发者针对特定语言定义namespace：

c++转化成

在C++的版本中如果不加namespace，那么生成的代码中*server.skeleton.cpp代码中的namespace是空的，会产生编译错误。

## 10注释（Comment） ##

Thrift支持C多行风格和Java/C++单行风格。

## 11Includes ##

便于管理、重用和提高模块性/组织性，我们常常分割Thrift定义在不同的文件中。包含文件搜索方式与c++一样。Thrift允许文件包含其它thrift文件，用户需要使用thrift文件名作为前缀访问被包含的对象，如：

thrift文件名要用双引号包含，末尾没有逗号或者分号

[Java]: http://lib.csdn.net/base/javase
[Python]: http://lib.csdn.net/base/python