簡言:介紹Thrift的IDL基本語法,初次使用或多或少的會有很有"坑"要踩,但是我們要遇山挖山,遇海填海,在學習的道路上堅定的走下去,方可日后吹牛B!

IDL

Thrift 采用IDL（Interface Definition Language）來定義通用的服務接口，然后通過Thrift提供的編譯器，可以將服務接口編譯成不同語言編寫的代碼，通過這個方式來實現跨語言的功能。

基本類型

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有以下一些約束：

1.struct不能繼承，但是可以嵌套，不能嵌套自己。(0.12.0版本可以支持嵌套自己本身)

2.其成員都是有明確類型

3.成員是被正整數編號過的，其中的編號使不能重復的，這個是為了在傳輸過程中編碼使用。

4.成員分割符可以是逗號（,）或是分號（;），而且可以混用

5.字段會有optional和required之分和protobuf一樣，但是如果不指定則為無類型–可以不填充該值，但是在序列化傳輸的時候也會序列化進去，optional是不填充則部序列化，required是必須填充也必須序列化。

6.每個字段可以設置默認值

7.同一文件可以定義多個struct，也可以定義在不同的文件，進行include引入。

舉個"栗"子:

struct User{1: required string name, //改字段必須填寫2: optional i32 age = 0; //默認值3: bool gender //默認字段類型為optional }

規則:

如果required標識的域沒有賦值，Thrift將給予提示；

如果optional標識的域沒有賦值，該域將不會被序列化傳輸；

如果某個optional標識域有缺省值而用戶沒有重新賦值，則該域的值一直為缺省值；

如果某個optional標識域有缺省值或者用戶已經重新賦值，而不設置它的__isset為true，也不會被序列化傳輸。

Container (容器)

有3種可用容器類型：

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 }

enum (枚舉)

約束：

1.編譯器默認從0開始賦值

2.可以賦予某個常量某個整數

3.允許常量是十六進制整數

4.末尾沒有分號

5.給常量賦缺省值時，使用常量的全稱

規則:

Thrift不支持枚舉類嵌套，枚舉常量必須是32位的正整數

舉個"栗"子

enum HttpStatus {OK = 200,NOTFOUND=404 }

常量定義

使用方法：在變量前面加上const

舉個"栗"子

const i32 const_int = 1;

類型定義

Thrift支持C/C++類型定義

舉個"栗"子

typedef i32 myint typedef i64 usernumber

規則:

末尾沒有逗號

Exception (異常)

異常在語法和功能上類似于結構體，差別是異常使用關鍵字exception，而且異常是繼承每種語言的基礎異常類。

舉個"栗"子

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

Service (服務定義類型)

服務的定義方法在語義上等同于面向對象語言中的接口。

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

編譯后的Java代碼

public class HelloService {public interface Iface {public int sayInt(int param) throws org.apache.thrift.TException;public java.lang.String sayString(java.lang.String param) throws org.apache.thrift.TException;public boolean sayBoolean(boolean param) throws org.apache.thrift.TException;public void sayVoid() throws org.apache.thrift.TException;}// ... 省略超級多超級多代碼 }

Namespace (名字空間)

Thrift中的命名空間類似于C++中的namespace和java中的package，它們提供了一種組織（隔離）代碼的簡便方式。名字空間也可以用于解決類型定義中的名字沖突。
由于每種語言均有自己的命名空間定義方式（如python中有module）, thrift允許開發者針對特定語言定義namespace：

舉個"栗"子

namespace java com.example.test

轉換成:

package com.example.test

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.

Include

便于管理、重用和提高模塊性/組織性，我們常常分割Thrift定義在不同的文件中。包含文件搜索方式與c++一樣。Thrift允許文件包含其它thrift文件，用戶需要使用thrift文件名作為前綴訪問被包含的對象，

舉個"栗"子

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

thrift文件名要用雙引號包含，末尾沒有逗號或者分號

參考文章

Apache Thrift - 可伸縮的跨語言服務開發框架:https://www.ibm.com/developerworks/cn/java/j-lo-apachethrift/index.html

轉載于:https://www.cnblogs.com/xzy-/p/11131407.html

總結

以上是生活随笔為你收集整理的Thrift IDL基本语法的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。