标签:
thrift 采用IDL(Interface Definition Language)来定义通用的服务接口,并通过生成不同的语言代理实现来达到跨语言、平台的功能。在thrift的IDL中可以定义以下一些类型:基本数据类型,结构体,容器,异常、服务
基本类型中基本都是有符号数,因为有些语言没有无符号数,所以Thrift不支持无符号整型。
binary: Blob (byte array) a sequence of unencoded bytes
这是string类型的一种变形,主要是为java使用,目前我主要使用C++的语言,所以java的这个类型没有用过
thrift中struct是定义为一种对象,和面向对象语言的class差不多.,但是struct有以下一些约束:
数字标签作用非常大,但是随着项目开发的不断发展,也许字段会有变化,但是建议不要轻易修改这些数字标签,修改之后如果没有同步客户端和服务器端会让一方解析出问题。
struct Report { 1: required string msg, //改字段必须填写 2: optional i32 type = 0; //默认值 3: i32 time //默认字段类型为optional } |
规范的struct定义中的每个域均会使用required或者 optional关键字进行标识。如果required标识的域没有赋值,Thrift将给予提示;如果optional标识的域没有赋值,该域将不会被序列化传输;如果某个optional标识域有缺省值而用户没有重新赋值,则该域的值一直为缺省值;如果某个optional标识域有缺省值或者用户已经重新赋值,而不设置它的__isset为true,也不会被序列化传输。
Thrift容器与目前流行编程语言的容器类型相对应,有3种可用容器类型:
容器中元素类型可以是除了service外的任何合法Thrift类型(包括结构体和异常)。为了最大的兼容性,map的key最好是thrift的基本类型,有些语言不支持复杂类型的key,JSON协议只支持那些基本类型的key。
容器都是同构容器,不失异构容器。
例子
struct Test {1: map<Numberz, UserId> user_map,2: set<Numberz> num_sets,
3: list<Stusers> users } |
很多语言都有枚举,意义都一样。比如,当定义一个消息类型时,它只能是预定义的值列表中的一个,可以用枚举实现。说明:
注意,不同于protocal buffer,thrift不支持枚举类嵌套,枚举常量必须是32位的正整数
enum EnOpType {CMD_OK = 0, // (0) CMD_NOT_EXIT
= 2000, // (2000)
CMD_EXIT = 2001, // (2001) 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” } |
枚举类型和struct编译后的c++代码
struct EnOpType { enum type { CMD_OK = 0,
CMD_NOT_EXIT = 2000, CMD_EXIT = 2001, CMD_ADD = 2002 }; }; class StUser { public: 。。。。。。 |
枚举类型编译后被struct封装了,struct编译后成了class,当然其中方法了多了很多。
Thrift允许定义跨语言使用的常量,复杂的类型和结构体可使用JSON形式表示。
const i32 INT_CONST = 1234; const EnOpType myEnOpType = EnOpType.CMD_EXIT; //2001 |
说明:分号可有可无。支持16进制。
Thrift支持C/C++类型定义。
typedef i32 MyInteger // a typedef StUser ReU // b typedef i64 UserId |
说明:a.末尾没有逗号。b. Struct也可以使用typedef。
Thrift结构体在概念上类似于(similar to)C语言结构体类型—将相关属性封装在一起的简便方式。Thrift结构体将会被转换成面向对象语言的类。
异常在语法和功能上类似于结构体,差别是异常使用关键字exception,而且异常是继承每种语言的基础异常类。
exception Extest {
1: i32 errorCode, 2: string message, 3: StUser userinfo } |
服务的定义方法在语义(semantically)上等同于面向对象语言中的接口。Thrift编译器会产生执行这些接口的client和server stub。具体参见下一节。
在流行的序列化/反序列化框架(如protocal buffer)中,Thrift是少有的提供多语言间RPC服务的框架。这是Thrift的一大特色。
Thrift编译器会根据选择的目标语言为server产生服务接口代码,为client产生stubs。
service SeTest { void ping(), bool postTweet(1: StUser user);
StUser searchTweets(1:string name); oneway void zip() } |
编译后的c++代码
class SeTestIf {public: virtual ~SeTestIf() {}
virtual bool AddUser(const StUser& user) = 0; virtual void SearchUser(StUser& _return, const std::string& name) = 0; virtual void NopNop() = 0; }; |
Thrift中的命名空间类似于C++中的namespace和java中的package,它们提供了一种组织(隔离)代码的简便方式。名字空间也可以用于解决类型定义中的名字冲突。
由于每种语言均有自己的命名空间定义方式(如python中有module), thrift允许开发者针对特定语言定义namespace:
namespace cpp com.example.test
namespace java com.example.test
namespace php com.example.test
|
c++转化成
namespace com { namespace example { namespace test {
|
在C++的版本中如果不加namespace,那么生成的代码中*server.skeleton.cpp代码中的namespace是空的,会产生编译错误。
Thrift支持C多行风格和Java/C++单行风格。
/* * This is a multi-line comment. * Just like in C. */ // C++/Java style single-line comments work just as well. |
便于管理、重用和提高模块性/组织性,我们常常分割Thrift定义在不同的文件中。包含文件搜索方式与c++一样。Thrift允许文件包含其它thrift文件,用户需要使用thrift文件名作为前缀访问被包含的对象,如:
include "test.thrift" ... struct StSearchResult { 1: in32 uid; ... } |
thrift文件名要用双引号包含,末尾没有逗号或者分号
标签:
原文地址:http://blog.csdn.net/iloveyin/article/details/46308643