原文鏈接：thrift入門 轉(zhuǎn)載請注明出處~

Thrift簡介

什么是thrift

簡單來說,是Facebook公布的一款開源跨語言的RPC框架.

什么是RPC框架?

RPC (Remote Procedure Call Protocal)脸爱，遠(yuǎn)程過程調(diào)用協(xié)議

rpc

RPC, 遠(yuǎn)程過程調(diào)用直觀說法就是A通過網(wǎng)絡(luò)調(diào)用B的過程方法。

• 簡單的說涨岁，RPC就是從一臺(tái)機(jī)器（客戶端）上通過參數(shù)傳遞的方式調(diào)用另一臺(tái)機(jī)器（服務(wù)器）上的一個(gè)函數(shù)或方法（可以統(tǒng)稱為服務(wù)）并得到返回的結(jié)果。

• RPC 會(huì)隱藏底層的通訊細(xì)節(jié)（不需要直接處理Socket通訊或Http通訊） RPC 是一個(gè)請求響應(yīng)模型桅锄。

• 客戶端發(fā)起請求乐疆，服務(wù)器返回響應(yīng)（類似于Http的工作方式） RPC 在使用形式上像調(diào)用本地函數(shù)（或方法）一樣去調(diào)用遠(yuǎn)程的函數(shù)（或方法）。

早期單機(jī)時(shí)代辆沦，一臺(tái)電腦上運(yùn)行多個(gè)進(jìn)程昼捍，大家各干各的，老死不相往來肢扯。假如A進(jìn)程需要一個(gè)畫圖的功能妒茬，B進(jìn)程也需要一個(gè)畫圖的功能，程序員就必須為兩個(gè)進(jìn)程都寫一個(gè)畫圖的功能蔚晨。這不是整人么乍钻？于是就出現(xiàn)了IPC（Inter-process communication沮尿，單機(jī)中運(yùn)行的進(jìn)程之間的相互通信）兽泣。OK苔严，現(xiàn)在A既然有了畫圖的功能楼熄，B就調(diào)用A進(jìn)程上的畫圖功能好了彤敛，程序員終于可以偷下懶了傲霸。
到了網(wǎng)絡(luò)時(shí)代婶肩，大家的電腦都連起來了陵霉。以前程序只能調(diào)用自己電腦上的進(jìn)程被盈，能不能調(diào)用其他機(jī)器上的進(jìn)程呢析孽？于是就程序員就把IPC擴(kuò)展到網(wǎng)絡(luò)上搭伤，這就是RPC（遠(yuǎn)程過程調(diào)用）了。現(xiàn)在不僅單機(jī)上的進(jìn)程可以相互通信袜瞬，多機(jī)器中的進(jìn)程也可以相互通信了怜俐。要知道實(shí)現(xiàn)RPC很麻煩呀，什么多線程邓尤、什么Socket拍鲤、什么I/O，都是讓咱們普通程序員很頭疼的事情汞扎。于是就有牛人開發(fā)出RPC框架（比如殿漠，CORBA、RMI佩捞、Web Services绞幌、RESTful Web Services等等）。OK一忱，現(xiàn)在可以定義RPC框架的概念了莲蜘。簡單點(diǎn)講，RPC框架就是可以讓程序員來調(diào)用遠(yuǎn)程進(jìn)程上的代碼一套工具帘营。有了RPC框架票渠，咱程序員就輕松很多了，終于可以逃離多線程芬迄、Socket问顷、I/O的苦海了。

thrift的跨語言特型

thrift通過一個(gè)中間語言IDL(接口定義語言)來定義RPC的數(shù)據(jù)類型和接口,這些內(nèi)容寫在以.thrift結(jié)尾的文件中,然后通過特殊的編譯器來生成不同語言的代碼,以滿足不同需要的開發(fā)者,比如java開發(fā)者,就可以生成java代碼,c++開發(fā)者可以生成c++代碼,生成的代碼中不但包含目標(biāo)語言的接口定義,方法,數(shù)據(jù)類型,還包含有RPC協(xié)議層和傳輸層的實(shí)現(xiàn)代碼.

thrift的協(xié)議棧結(jié)構(gòu)

thrift協(xié)議棧結(jié)構(gòu)

　　thrift是一種c/s的架構(gòu)體系禀梳。在最上層是用戶自行實(shí)現(xiàn)的業(yè)務(wù)邏輯代碼杜窄。
　　第二層是由thrift編譯器自動(dòng)生成的代碼，主要用于結(jié)構(gòu)化數(shù)據(jù)的解析算途，發(fā)送和接收塞耕。TServer主要任務(wù)是高效的接受客戶端請求，并將請求轉(zhuǎn)發(fā)給Processor處理嘴瓤。Processor負(fù)責(zé)對客戶端的請求做出響應(yīng)扫外，包括RPC請求轉(zhuǎn)發(fā)，調(diào)用參數(shù)解析和用戶邏輯調(diào)用廓脆，返回值寫回等處理筛谚。
　　從TProtocol以下部分是thirft的傳輸協(xié)議和底層I/O通信。TProtocol是用于數(shù)據(jù)類型解析的停忿，將結(jié)構(gòu)化數(shù)據(jù)轉(zhuǎn)化為字節(jié)流給TTransport進(jìn)行傳輸驾讲。TTransport是與底層數(shù)據(jù)傳輸密切相關(guān)的傳輸層，負(fù)責(zé)以字節(jié)流方式接收和發(fā)送消息體，不關(guān)注是什么數(shù)據(jù)類型蝎毡。底層IO負(fù)責(zé)實(shí)際的數(shù)據(jù)傳輸厚柳，包括socket氧枣、文件和壓縮數(shù)據(jù)流等沐兵。

Thrift安裝

安裝環(huán)境：window 7

• 在官網(wǎng)上下載thrift-0.9.3.exe包到一個(gè)新建文件夾(博主的文件夾名稱為Thrift)中
• 然后將此文件夾放到環(huán)境變量Path中。例如博主就是將D:Thrift添加到Path中
• cmd便监，打開終端扎谎，輸入thrift -version，即可看到相應(yīng)的版本號烧董，就算是成功安裝啦

ThriftDemo

下面毁靶，來做個(gè)小Demo來熟悉Thrift的使用流程

1. 首先在一個(gè)目錄下，創(chuàng)建一個(gè)文件逊移，博主是用NotePad++創(chuàng)建的预吆，用windows自帶的記事本貌似也是可以的，這里創(chuàng)建了一個(gè)thrift腳本胳泉，命名為login.thrift拐叉，內(nèi)容如下

namespace java com.game.lll.thrift  
  
struct Request {  
    1: string username;        
    2: string password;             
}  
  
exception RequestException {  
    1: required i32 code;  
    2: optional string reason;  
}  
  
// 服務(wù)名  
service LoginService {  
    string doAction(1: Request request) throws (1:RequestException qe); // 可能拋出異常。  
}  

2. 終端進(jìn)入當(dāng)前文件夾扇商，在終端輸入命令thrift -gen java login.thrift凤瘦。當(dāng)前目錄下會(huì)生成一個(gè)gen-java文件夾，文件夾下會(huì)按照namespace定義的路徑名一層層生成文件夾案铺，到最里層的文件夾里可以看到生成的3個(gè)java類Request.java,RequestException.java,LoginService.java

3. 用IDEA/Eclipse新建一個(gè)工程蔬芥，并為此工程添加依賴。博主創(chuàng)建的是Maven工程控汉，就在pom.xml里面添加依賴笔诵，如下

  <!-- https://mvnrepository.com/artifact/org.apache.thrift/libthrift -->
    <dependency>
        <groupId>org.apache.thrift</groupId>
        <artifactId>libthrift</artifactId>
        <version>0.9.3</version>
    </dependency>

    <!-- https://mvnrepository.com/artifact/org.slf4j/slf4j-api -->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.21</version>
    </dependency>

    <!-- https://mvnrepository.com/artifact/org.slf4j/slf4j-nop -->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-nop</artifactId>
        <version>1.7.21</version>
    </dependency>

4. 將目錄中的代碼拷貝到工程的classpath下，IDEA中的classpath就是source所處的文件夾(會(huì)有顏色標(biāo)識姑子，博主的版本是藍(lán)色文件夾)
5. 創(chuàng)建LoginServiceImpl.java類嗤放，實(shí)現(xiàn)在LoginService.Iface接口

/**
 * Created by CiCi on 2017/5/16.
 */
import org.apache.thrift.TException;

import com.game.lll.thrift.LoginService;
import com.game.lll.thrift.Request;
import com.game.lll.thrift.RequestException;

public class LoginServiceImpl implements LoginService.Iface{

    @Override
    public String doAction(Request request) throws RequestException,TException {
        // TODO Auto-generated method stub
        System.out.println("hahaha");
        System.out.println("username:"+request.getUsername());
        System.out.println("password:"+request.getPassword());
        return request.getUsername()+request.getPassword();
    }

}

6. 新建服務(wù)器端LoginMain.java

/**
 * Created by CiCi on 2017/5/16.
 */
import java.net.ServerSocket;

import org.apache.thrift.server.TServer;
import org.apache.thrift.server.TSimpleServer;
import org.apache.thrift.transport.TServerSocket;

import com.game.lll.thrift.LoginService;
import com.game.lll.thrift.LoginService.Processor;

public class LoginMain {
    public static void main(String[] args) throws Exception {
        // Transport
        ServerSocket socket = new ServerSocket(8888);
        TServerSocket serverTransport = new TServerSocket(socket);

        // Processor
        LoginService.Processor processor = new Processor(new LoginServiceImpl());

        TServer.Args tServerArgs = new TServer.Args(serverTransport);
        tServerArgs.processor(processor);

        // Server
        TServer server = new TSimpleServer(tServerArgs);
        System.out.println("Starting the simple server...");
        server.serve();
    }
}

7. 新建客戶端

/**
 * Created by CiCi on 2017/5/16.
 */
import org.apache.thrift.protocol.TBinaryProtocol;
import org.apache.thrift.protocol.TProtocol;
import org.apache.thrift.transport.TSocket;
import org.apache.thrift.transport.TTransport;

import com.game.lll.thrift.LoginService;
import com.game.lll.thrift.Request;

public class ClientMain {
    public static void main(String[] args) throws Exception {
        TTransport transport = null;
        try {
            // 創(chuàng)建TTransport
            transport = new TSocket("localhost", 8888);

            // 創(chuàng)建TProtocol 協(xié)議要與服務(wù)端一致
            TProtocol protocol = new TBinaryProtocol(transport);

            // 創(chuàng)建client
            LoginService.Client client = new LoginService.Client(protocol);

            transport.open();  // 建立連接
            
            Request request = new Request().setUsername("liulongling").setPassword("123456");
             
            // client調(diào)用server端方法
            System.out.println(client.doAction(request));
        }catch (Exception e) {
            e.printStackTrace();
        }finally {
            transport.close();  // 請求結(jié)束，斷開連接

        }

    }
}

8. 運(yùn)行服務(wù)器端壁酬，控制臺(tái)輸出結(jié)果“Starting the simple server...”
9. 運(yùn)行客戶端次酌，控制臺(tái)輸出結(jié)果
   username:lalala
   password:123456

Thrift使用流程

服務(wù)端編碼的基本流程

1. 創(chuàng)建TTransport
2. 創(chuàng)建TProtocol
3. 創(chuàng)建TProcessor
4. 創(chuàng)建Server
5. 啟動(dòng)服務(wù)

客戶端編碼的基本流程

1. 創(chuàng)建TTransport
2. 創(chuàng)建TProtocol
3. 創(chuàng)建Client
4. client方法調(diào)用

Transport

Transport層提供了一個(gè)簡單的網(wǎng)絡(luò)讀寫抽象層，這使得thrift底層的transport從系統(tǒng)其他的部分解耦舆乔。Thrift使用ServerTransport接口接受或者創(chuàng)建原始transport對象岳服。ServerTransport用在Server端，為到來的連接創(chuàng)建Transport對象希俩。

Protocol

Protocol抽象層定義了一種怎樣將內(nèi)存中數(shù)據(jù)結(jié)構(gòu)映射成可傳輸格式的機(jī)制吊宋。Protocol定義了datatype怎樣使用底層的Transport對自己進(jìn)行編解碼

Processor

Processor封裝了從輸入數(shù)據(jù)流中讀數(shù)據(jù)和向數(shù)據(jù)流中寫數(shù)據(jù)的操作。

interface TProcessor {
 
bool process(TProtocol in, TProtocol out) throws TException
 
}

與服務(wù)相關(guān)的processor實(shí)現(xiàn)由編譯器產(chǎn)生颜武。Processor主要工作流程如下：從連接中讀取數(shù)據(jù)（使用輸入protocol）璃搜，將處理授權(quán)給handler（由用戶實(shí)現(xiàn)）拖吼，最后將結(jié)果寫到連接上（使用輸出protocol）。

Server

Server將以上所有特性集成在一起

• 創(chuàng)建一個(gè)transport對象
• 為transport對象創(chuàng)建輸入輸出protocol
• 基于輸入輸出protocol創(chuàng)建processor
• 等待連接請求并將之交給processor處理

Thrift語法

基本類型

thrift不支持無符號類型这吻，因?yàn)楹芏嗑幊陶Z言不存在無符號類型

• byte：有符號字節(jié)
• i16：16位有符號整數(shù)
• i32：32位有符號整數(shù)
• i64：64位有符號整數(shù)
• double：64位浮點(diǎn)數(shù)
• string：字符串類型

容器類型

集合黃總的元素可以是除了service之外的任何類型

• list<<T>T>：一系列由T類型的數(shù)據(jù)組成的有序列表吊档，元素可以重復(fù)
• set<<T>T>：一系列由T類型的數(shù)據(jù)組成的無序集合，元素不可重復(fù)
• map<K, V>：一個(gè)字典結(jié)構(gòu)唾糯，key為K類型怠硼，value為V類型

其他類型

結(jié)構(gòu)體(struct)

thrift支持struct類型，目的是將一些數(shù)據(jù)聚合在一起移怯，方便傳輸管理香璃，struct定義如下

struct People {
     1: string name;
     2: i32 age;
     3: string sex;
}

枚舉(enum)

枚舉的定義形式和Java的Enum類似，例如：

enum Sex {
    RED,
    BLUE
}

異常(exception)

thrift支持自定義異常

exception RequestException {
     1: i32 code;
    2: string reason;
}

服務(wù)(Service)

thrift定義的服務(wù)相當(dāng)于Java中創(chuàng)建Interface一樣舟误，創(chuàng)建的Service經(jīng)過代碼生成命令后會(huì)生成客戶端與服務(wù)端的框架代碼葡秒，定義形式如下

service HelloWordService {
     // service中定義的函數(shù)，相當(dāng)于Java interface中定義的函數(shù)
     string doAction(1: string name, 2: i32 age);
 }

類型定義

thrift支持類似C++一樣的typedef 定義嵌溢，注意末尾沒有逗號或者分號眯牧，比如

typedef i32 Integer
typedef i64 Long

常量(const)

thrift使用const關(guān)鍵字定義常量，末尾的分號是可選的堵腹，可有可無

const i32 MAX_RETRIES_TIME = 10

命名空間(namespace)

thrift的命名空間相當(dāng)于Java中的package炸站，主要目的是組織代碼。格式為

namespace <語言> <包的位置>
eg:namespace java.com.test.thrift

文件包含

thrift支持文件包含疚顷，相當(dāng)于C/C++中的include旱易，使用關(guān)鍵字include定義

include "global.thrift"

注釋

thrift注釋方式支持shell風(fēng)格的注釋，支持C/C++風(fēng)格的注釋腿堤，即#和//開頭的語句都單當(dāng)做注釋阀坏，/**/包裹的語句也是注釋。

可選與必選

thrift提供兩個(gè)關(guān)鍵字required笆檀，optional忌堂，分別用于表示對應(yīng)的字段時(shí)必填的還是可選的。例如：

struct People {
    1: required string name;
    2: optional i32 age;
}

表示name是必填的酗洒，age是可選的士修。

參考文獻(xiàn)

thrift入門教程
Thrift入門初探--thrift安裝及java入門實(shí)例
Thrift
Thrift RPC實(shí)戰(zhàn)(一) 初次體驗(yàn)Thrift
【Apache Thrift】windows下thrift的安裝(一)
【Apache Thrift】Thrift的使用和編譯(二)
Thrift入門初探(2)--thrift基礎(chǔ)知識詳解
Thrift使用指南
Thrift入門及Java實(shí)例演示

個(gè)人博客地址：kongdehui.com 歡迎批評指正~~