Thrift 语法这是我参与8月更文挑战的第7天，活动详情查看：8月更文挑战 IDL 文件 Thrift 采用的是 ID

这是我参与8月更文挑战的第7天，活动详情查看：8月更文挑战

IDL 文件

Thrift 采用的是 IDL（Interface Definition Language) 文件来定义通用的服务接口，然后通过 Thrift 提供的编译器，可以将服务接口编译成不同语言的代码，通过这个方式来实现跨语言功能。

看个 thrift 文件例子 base.thrift, example.thrift

include "base.thrift"

namespace go example.hello


struct User{
  1: required string name, //改字段必须填写
  2: optional i32 age = 0; //默认值
  3: bool gender //默认字段类型为optional
}

service ExampleService {
       ExampleResp CheckService(1:ExampleReq req)
}

可以看到一个 thrift 文件中一般会包含 struct 结构体，还有服务 Service 定义，和面向对象中的接口类似。

基本数据类型

bool: 布尔值对应Java中的boolean
byte: 有符号字节对应Java中的byte
i16: 16位有符号整型对应Java中的short
i32: 32位有符号整型对应Java中的int
i64: 64位有符号整型对应Java中的long
double: 64位浮点型对应Java中的double
string: 字符串对应Java中的String
binary: Blob 类型对应Java中的byte[]

struct 结构体

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

看个例子

struct User{
  1: required string name, //改字段必须填写
  2: optional i32 age = 0; //默认值
  3: bool gender //默认字段类型为optional
}

要注意如下:

如果required标识的域没有赋值，Thrift将给予提示
如果optional标识的域没有赋值，该域将不会被序列化传输；
如果某个optional标识域有缺省值而用户没有重新赋值，则该域的值一直为缺省值；
如果某个optional标识域有缺省值或者用户已经重新赋值，而不设置它的__isset为true，也不会被序列化传输。

容器类型

有三种容器类型: list set map 和 Java 很像.

list: 元素类型为T的有序表，容许元素重复。对应C++的vector，Java的ArrayList或者其他语言的数组
set: 元素类型为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

struct Test {
  1: map<string, User> usermap,
  2: set<i32> intset,
  3: list<double> doublelist
}

枚举类型

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

栗子：

enum HttpStatus {
  OK = 200,
  NOTFOUND=404
}

常量类型

只需要再常量前面加上关键字 const 即可

const i32 const_int = 1

类型定义

thrift 支持自定义类型

typedef i32 myint
typedef i64 usernumber

异常类型

异常类型在结构上类似于 struct , 差异是需要使用关键字 exception

exception MyException {
    1: i32 errorCode,
    2: string message
}

服务类型

服务类型的定义方法在语意上等同于面向对象中的接口

service HelloService {
    i32 sayInt(1:i32 param)
    string sayString(1:string param)
    bool sayBoolean(1:bool param)
    void sayVoid()
}

namespace 关键字

Thrift中的命名空间类似于C++中的namespace和java中的package，它们提供了一种组织（隔离）代码的简便方式。名字空间也可以用于解决类型定义中的名字冲突。由于每种语言均有自己的命名空间定义方式（如python中有module）, thrift允许开发者针对特定语言定义namespace

例子

namespace java com.example.test

include 关键字

thrift 允许文件包含其他 thrift 文件，用户可以通过前缀访问被包含的对象。

例子

include "test.thrift"   
...
struct StSearchResult {
    1: in32 uid;
     ...
}

注释

Thrift 支持单行或者多行风格, 和 Java 风格类似

/** 
 * This is a multi-line comment. 
 * Just like in C. 
 */
 // C++/Java style single-line comments work just as well.