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 Report { 1: required string msg, //改字段必須填寫 2: optional i32 type = 0; //默認值 3: i32 time //默認字段類型為optional } |
規范的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。
容器都是同構容器,不失異構容器。
例子
struct Test {1: map<Numberz, UserId> user_map,2: set<Numberz> num_sets,
3: list<Stusers> users } |
5枚舉(enmu)
很多語言都有枚舉,意義都一樣。比如,當定義一個消息類型時,它只能是預定義的值列表中的一個,可以用枚舉實現。說明:
- 編譯器默認從0開始賦值
- 可以賦予某個常量某個整數
- 允許常量是十六進制整數
- 末尾沒有分號
- 給常量賦缺省值時,使用常量的全稱
注意,不同於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,當然其中方法了多了很多。
6常量定義和類型定義
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。
7異常(Exceptions)
Thrift結構體在概念上類似於(similar to)C語言結構體類型—將相關屬性封裝在一起的簡便方式。Thrift結構體將會被轉換成面向對象語言的類。
異常在語法和功能上類似於結構體,差別是異常使用關鍵字exception,而且異常是繼承每種語言的基礎異常類。
exception Extest {
1: i32 errorCode, 2: string message, 3: StUser userinfo } |
8服務(Services)
服務的定義方法在語義(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; }; |
- 首先所有的方法都是純虛汗數,也就是繼承類必須實現這些方法
- 返回值不是基本類型的都把返回值放到了函數參數中第一個參數,命名_return
- 所有的參數(除返回值)都是const類型,意味這函數一般參數無法作為返回值攜帶者。只會有一個返回參數,如果返回值有多個,那只能封裝復雜類型作為返回值參數。
- oneway的返回值一定是void
- 當然服務是支持繼承。
- 服務不支持重載
9名字空間(Namespace)
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是空的,會產生編譯錯誤。
10注釋(Comment)
Thrift支持C多行風格和Java/C++單行風格。
/* * This is a multi-line comment. * Just like in C. */ // C++/Java style single-line comments work just as well. |
11Includes
便於管理、重用和提高模塊性/組織性,我們常常分割Thrift定義在不同的文件中。包含文件搜索方式與c++一樣。Thrift允許文件包含其它thrift文件,用戶需要使用thrift文件名作為前綴訪問被包含的對象,如:
include "test.thrift" ... struct StSearchResult { 1: in32 uid; ... } |
thrift文件名要用雙引號包含,末尾沒有逗號或者分號