Thrift语法参考（2）

转载至thrift系列 - thrift类型定义感谢原作者的分享

1.命名空间

       接口文件部分示例：

[java] view plain copy

print ?

1. namespace java test_java_package  
2. namespace py test_python_package  

namespace java test_java_package
namespace py test_python_package

          命名空间的语法是这样的：namespace  语言名称  code生成之后的包名。若你想让接口文件生成的java code和python code带有相应的包名，就可以像示例部分那样去定义。如你所见，你可以在一个thrift文件中定义多种语言的命名空间。

      过程中可能有点小问题，在namespace定义的语法中，亦或是在命令行中（如下所示）：

thrift -r --gen py test.thrift

          我怎么知道python对应的语言名称是py呢？难道语言名称都是生成的code的后缀吗？其实，不一定 。以下是语言通俗名称 与 –gen后面的参数(即以上namespace语法中使用的语言名称) 的映射表：

2. service与基本数据类型

        Thrift RPC通信是通过接口调用，而接口的宿主则为service，有点像类的概念。

       以下是基本的数据类型：

    bool         布尔值, 占1个字节
    i8            有符号整数，占1个字节
    i16           有符号整数，占2个字节
    i32           有符号整数，占4个字节
    i64           有符号整数，占8个字节
    double     浮点数，占8个字节
    string       字符串
    binary       二进制大对象（python里对应的是string类型，java里对应的是ByteBuffer等）
    map<t1,t2>  mapparam 键值对，t1,t2 代指其他类型
    list<t1>  listparam 列表，t1代指其他类型
    set<t1>  setparam 散列集，t1代指其他类型

3.常量与枚举

   常量的定义很简单，使用const关键字：

[java] view plain copy

print ?

1. const i32 TESTNAME = 120  

const i32 TESTNAME = 120

    与各类语言中定义枚举的方式类似，使用enum关键字：

[java] view plain copy

print ?

1. enum TestEnum {  
2.      A = 1,  
3.      B = 2  
4.   }  

  enum TestEnum {
       A = 1,
       B = 2
    }

4.别名

     我们可以给基本数据类型取一个别名，使用typedef关键字：

[java] view plain copy

print ?

1. typedef i32 MyInteger  

typedef i32 MyInteger

     定义别名后，我们就可以用别名充当类型来使用了。

5.结构体

     结构体可以定义一组关联的字段集，使用关键字struct：

[java] view plain copy

print ?

1. struct TestStruct{  
2.     1:i32 t1 = 0,  
3.     2:string t2,  
4. optional string t3  
5. }  

   struct TestStruct{
        1:i32 t1 = 0,
        2:string t2,
    3:optional string t3
   }

             生成代码后，每一个结构体会单独生成一个类。 每个变量可以附上默认值（如t1类型）。 字段前可加 optional 标记，表示该字段在没有赋值的情况，不会被序列化。 注意，每定义一个字段，数字标识符需要递增（如以上的1:i32 t1=0 中的1:） 

6.文件包含
      在文件开始的地方包含其他的文件：

[java] view plain copy

print ?

1. include “test.thrift”  

include "test.thrift"

      包含test.thrift文件之后，你可以在当前文件中使用 test.thrift中定义的常量，结构体等信息。
注意，引用其他thrift文件的结构体等信息的时候，要加前缀。 比如A.thrift文件中有结构体 T1, 在B文件中引用A的T1的信息时，需要写成 A.T1，否则无法自动生成code。

7.继承

      对于面向对象的语言来说，有继承的概念。示例定义如下:

[java] view plain copy

print ?

1. service A{  
2. void f1(1:i32 num)  
3. }  
4.   
5. service B extends A{  
6. void f2(1:string str)  
7. }  

       service A{
       void f1(1:i32 num)
       }

       service B extends A{
       void f2(1:string str)
       }

8.异常定义
和结构体类似：

[java] view plain copy

print ?

1. exception IException {  
2.   1: i32 num,  
3.   2: string msg  
4. }  
5.   
6. //使用的时候抛出定义的异常即可  
7. void f() throws (1:IException ex)  

exception IException {
  1: i32 num,
  2: string msg
}

//使用的时候抛出定义的异常即可
void f() throws (1:IException ex)

生成代码的时候，会单独生成IException的代码文件


9.注释
/**
 * 这是ok的
 */

 #这也是ok的


 //这依旧是ok的

11.异步方法

[java] view plain copy

print ?

1. service A{  
2.         oneway void f()  
3. }  

service A{
        oneway void f()
}

加上关键字oneway，异步方法，返回值必须是void。

        本文内容参考如下：

       【1】http://thrift.apache.org/