RPC框架實踐之：Apache Thrift

---

一、概述

RPC（Remote Procedure Call）即 遠端過程呼叫，說的這麼抽象，其實簡化理解就是一個節點如何請求另一節點所提供的服務。在文章 微服務呼叫鏈追蹤中心搭建 一文中模擬出來的呼叫鏈：ServiceA ---> ServiceB ---> ServiceC 就是一個遠端呼叫的例子，只不過這篇文章裡是通過RestTemplate這種 同步呼叫方式，利用的是HTTP協議在應用層完成的，這種方法雖然奏效，但有時效率並不高。而RPC可以不依賴於應用層協議，可以直接基於TCP進行遠端呼叫，在傳輸層中即可完成通訊，因此更適於某些對效率要求更高的場景。由於RPC呼叫方式依賴於客戶端與服務端之間建立Socket連線來實現二進位制資料通訊，底層會比較複雜，所以一些RPC框架應運而生來封裝這種複雜性，讓開發者將精力聚焦於業務之上。常見的RPC框架包括：Thrift、gRPC、Finagle、Dubbo等等，從本文開始作者將選一些實踐一下，本文主要記錄作者對於Thrift框架的實踐過程。

Thrift是Apache的專案，它結合了功能強大的軟體堆疊和程式碼生成引擎，可以在諸多語言之間提供無縫支援。

心動不如行動吧！

注： 本文首發於 My 公眾號 CodeSheep ，可 長按 或 掃描 下面的 小心心 來訂閱 ↓ ↓ ↓

---

二、實驗環境

• Mac OS X 10.13.2
• SpringBoot 2.0.1
• Thrift 0.11.0
• IDE：IntelliJ IDEA 2018.01

---

為了便於讀者理解，我先將下文內容總結一下，包含7點：

• Thrift環境搭建
• IDEA中Thrift外掛配置
• 建立 Thrift 專案並編譯（目的：定義RPC介面）
• 開發Thrift API介面
• 開發RPC服務端
• 開發RPC客戶端
• RPC通訊實際實驗

---

三、Thrift環境搭建

• **方法一：**原生安裝方式，通過官方提供的步驟一步一步來安裝

參考這裡：Mac上Thrift官方安裝教程

• **方法二：**使用 brew 工具（推薦）

brew install thrift

---

四、IDEA中Thrift外掛配置

方法一：直接在IDEA介面中配置

開啟IDEA的外掛中心，搜尋 Thrift 即可安裝

方法二：手動下載Thrift外掛安裝

就像文章 SpringBoot優雅編碼之：Lombok加持 一文中在IDEA中安裝Lombok外掛一樣，有時由於網路原因，方法一不奏效時外掛裝不上，此時可以手動下載外掛並安裝。

可以去如下地址下載Thrift外掛：http://plugins.jetbrains.com/plugin/7331-thrift-support

然後去IDEA中 Install plugin from disk... 選擇下載的zip包安裝，然後重啟IDE即可

安裝完成的成功標誌是 Compiler 中出現了 Thrift編譯器！如下圖所示：

---

五、建立 Thrift 專案並編譯（定義RPC介面）

• 第一步：建立Thrift專案並配置

IDE 很智慧地在 New Project 時提供 Thrift專案建立選項：

專案建立完成以後，在 Project Settings 中設定好 Facets 的 Thrift配置，如下圖所示，這裡我們新增一個 Java的Generator

在彈出的對話方塊中配置好 Output folder 路徑，該路徑用於存放由 thrift檔案 轉化而成的 java原始檔：

OK，Thrift專案就緒了！

• 第二步：建立thrift介面檔案

這裡建立一個thrift介面檔案：RPCDateService.thrift

thrift檔案的寫法我不贅述，跟gRPC一樣有其自己的語法，namespace是最後生成的介面檔案的包名

namespace java com.hansonwang99.thrift.interface
service RPCDateService{
    string getDate(1:string userName)
}
複製程式碼

在該介面檔案中，我們定義了一個 提供日期的Service，讓客戶端能通過該介面查詢到伺服器當前的時間

• 第三步：編譯Thrift原始檔生成Java介面類

右擊.thrift原始檔，點選 Recompile 'xxx.thrift' 即可完成 thrift介面檔案 ---> java介面檔案 的轉換

輸出的Java介面檔案生成於上文中配置的 output 中，其 包結構=上文.thrift檔案中的namespace ，其包結構如下圖所示，該Java介面十分重要，後續會用於實現Client和Server之間的RPC呼叫。

---

六、開發Thrift API介面

我們建立一個Maven專案：ThriftAPI，其包含的的就是上文由自定義Thrift介面生成的Java介面：RPCDateService.java 檔案，該檔案將用於後面的RPC服務端和RPC客戶端的程式碼實現！

• pom.xml中新增thrift依賴

    <dependencies>
        <dependency>
            <groupId>org.apache.thrift</groupId>
            <artifactId>libthrift</artifactId>
            <version>0.11.0</version>
        </dependency>
    </dependencies>
複製程式碼

• 新增RPCDateService.java

將上文 第五步 由 RPCDateService.thrift 生成的 RPCDateService.java 原樣拷貝到該Maven專案中即可，程式碼結構如下：

再次強調，該 ThriftAPI專案 會服務於下文即將要建立的RPC服務端和RPC客戶端

---

七、開發RPC服務端

我們是利用SpringBoot來實現RPC服務端

• pom.xml中新增依賴

這裡除了自動新增好的SpringBoot依賴外，需要額外新增的就是上文的 ThriftAPI依賴 了

<dependency>
        <groupId>com.hansonwang99</groupId>
        <artifactId>ThriftAPI</artifactId>
         <version>1.0-SNAPSHOT</version>
</dependency>
複製程式碼

• 建立Controller並實現RPC介面

@Controller
public class RPCDateServiceImpl implements RPCDateService.Iface {
    @Override
    public String getDate(String userName) throws TException {
        Date now=new Date();
        SimpleDateFormat simpleDateFormat = new SimpleDateFormat("今天是"+"yyyy年MM月dd日 E kk點mm分");
        String nowTime = simpleDateFormat.format( now );
        return "Hello " + userName + "\n" + nowTime;
    }
}
複製程式碼

這裡將伺服器當前時間以字串形式返回給呼叫端！

• 編寫RPCThriftServer：用於啟動RPC伺服器

@Component
public class RPCThriftServer {
    protected final Logger logger = LoggerFactory.getLogger(this.getClass());
    @Value("${thrift.port}")
    private int port;
    @Value("${thrift.minWorkerThreads}")
    private int minThreads;
    @Value("${thrift.maxWorkerThreads}")
    private int maxThreads;

    private TBinaryProtocol.Factory protocolFactory;
    private TTransportFactory transportFactory;

    @Autowired
    private RPCDateServiceImpl rpcDateService;

    public void init() {
        protocolFactory = new TBinaryProtocol.Factory();
        transportFactory = new TTransportFactory();
    }

    public void start() {
        RPCDateService.Processor processor = new RPCDateService.Processor<RPCDateService.Iface>( rpcDateService );
        init();
        try {
            TServerTransport transport = new TServerSocket(port);
            TThreadPoolServer.Args tArgs = new TThreadPoolServer.Args(transport);
            tArgs.processor(processor);
            tArgs.protocolFactory(protocolFactory);
            tArgs.transportFactory(transportFactory);
            tArgs.minWorkerThreads(minThreads);
            tArgs.maxWorkerThreads(maxThreads);
            TServer server = new TThreadPoolServer(tArgs);
            logger.info("thrift服務啟動成功, 埠={}", port);
            server.serve();
        } catch (Exception e) {
            logger.error("thrift服務啟動失敗", e);
        }
    }
}
複製程式碼

• 建立SpringBootApplication

@SpringBootApplication
public class RPCThriftServerApplication {
    private static RPCThriftServer rpcThriftServer;
    public static void main(String[] args) {
        ApplicationContext context = SpringApplication.run(RPCThriftServerApplication.class, args);
        try {
            rpcThriftServer = context.getBean(RPCThriftServer.class);
            rpcThriftServer.start();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
複製程式碼

• 新增配置檔案application.properties

thrift.port=6666
thrift.minWorkerThreads=10
thrift.maxWorkerThreads=100
複製程式碼

我們讓thrift服務起在6666埠！

• 啟動RPC服務端服務

---

八、開發RPC客戶端

這裡同樣用SpringBoot來實現RPC客戶端！

• pom.xml中新增依賴

  此處同RPC服務端依賴，不贅述

• 編寫RPCThriftClient：用於發出RPC呼叫

這裡包含兩個檔案：RPCThriftClient.java 和 RPCThriftClientConfig.java

RPCThriftClient.java如下：

public class RPCThriftClient {
    private RPCDateService.Client client;
    private TBinaryProtocol protocol;
    private TSocket transport;
    private String host;
    private int port;

    public String getHost() {
        return host;
    }
    public void setHost(String host) {
        this.host = host;
    }
    public int getPort() {
        return port;
    }
    public void setPort(int port) {
        this.port = port;
    }

    public void init() {
        transport = new TSocket(host, port);
        protocol = new TBinaryProtocol(transport);
        client = new RPCDateService.Client(protocol);
    }

    public RPCDateService.Client getRPCThriftService() {
        return client;
    }

    public void open() throws TTransportException {
        transport.open();
    }

    public void close() {
        transport.close();
    }
}
複製程式碼

而RPCThriftClientConfig.java是利用config生成bean

@Configuration
public class RPCThriftClientConfig {
    @Value("${thrift.host}")
    private String host;
    @Value("${thrift.port}")
    private int port;

    @Bean(initMethod = "init")
    public RPCThriftClient rpcThriftClient() {
        RPCThriftClient rpcThriftClient = new RPCThriftClient();
        rpcThriftClient.setHost(host);
        rpcThriftClient.setPort(port);
        return rpcThriftClient;
    }
}
複製程式碼

• 編寫Restful的Controller作為呼叫入口

@RestController
@RequestMapping("/hansonwang99")
public class RPCThriftContoller {
    protected final Logger logger = LoggerFactory.getLogger(this.getClass());
    @Autowired
    private RPCThriftClient rpcThriftClient;

    @RequestMapping(value = "/thrift", method = RequestMethod.GET)
    public String thriftTest(HttpServletRequest request, HttpServletResponse response) {
        try {
            rpcThriftClient.open();
            return rpcThriftClient.getRPCThriftService().getDate("hansonwang99");
        } catch (Exception e) {
            logger.error("RPC呼叫失敗", e);
            return "error";
        } finally {
            rpcThriftClient.close();
        }
    }
}
複製程式碼

• 建立SpringBootApplication

@SpringBootApplication
public class RPCThriftClientApplication {
    public static void main(String[] args) {
        SpringApplication.run(RPCThriftClientApplication.class, args);
    }
}
複製程式碼

• 新增配置檔案application.properties

thrift.host=localhost
thrift.port=6666
server.port=9999
複製程式碼

• 啟動RPC客戶端服務

---

九、RPC通訊實驗

我們瀏覽器輸入：localhost:9999/hansonwang99/thrift 即可檢視客戶端從服務端取回的伺服器當前時間，說明RPC通訊過程打通！

---

十、後記

本文實驗程式碼已開源，點選獲取

• 作者更多的原創文章在此，歡迎觀賞

• My Personal Blog

作者更多的SpringBt實踐文章在此：

• Spring Boot應用監控實戰
• SpringBoot應用部署於外接Tomcat容器
• ElasticSearch搜尋引擎在SpringBt中的實踐
• 初探Kotlin+SpringBoot聯合程式設計
• Spring Boot日誌框架實踐
• SpringBoot優雅編碼之：Lombok加持

---

如果有興趣，也可以抽點時間看看作者一些關於容器化、微服務化方面的文章：

• 利用K8S技術棧打造個人私有云 連載文章
• 從一份配置清單詳解Nginx伺服器配置
• Docker容器視覺化監控中心搭建
• 利用ELK搭建Docker容器化應用日誌中心
• RPC框架實踐之：Apache Thrift
• RPC框架實踐之：Google gRPC
• 微服務呼叫鏈追蹤中心搭建
• Docker容器跨主機通訊
• Docker Swarm叢集初探
• 高效編寫Dockerfile的幾條準則

---

---