前言
本文將介紹由 Facebook 開發(fā)的遠(yuǎn)程服務(wù)調(diào)用框架 Apache Thrift膳叨,它采用接口描述語言定義并創(chuàng)建服務(wù),支持可擴(kuò)展的跨語言服務(wù)開發(fā)粘都,所包含的代碼生成引擎可以在多種語言中不跟,如 C++, Java, Python, PHP, Ruby, Erlang, Perl, Haskell, C#, Cocoa, Smalltalk 等創(chuàng)建高效的、無縫的服務(wù)励堡,其傳輸數(shù)據(jù)采用二進(jìn)制格式谷丸,相對(duì) XML 和 JSON 體積更小,對(duì)于高并發(fā)应结、大數(shù)據(jù)量和多語言的環(huán)境更有優(yōu)勢刨疼。本文將詳細(xì)介紹 Th[圖片上傳失敗...(image-6396aa-1563673235590)]
rift 在C#語言下的使用方式,并且提供豐富的實(shí)例代碼加以解釋說明鹅龄,幫助使用者快速構(gòu)建服務(wù)揩慕。
完善開發(fā)工具
通過nuget在vs2019中安裝thrift
在項(xiàng)目中引用右鍵點(diǎn)擊管理Nuget程序包,在打開的界面輸入thrift扮休,如下圖:
我們選擇ApacheThrift這一項(xiàng)進(jìn)行安裝迎卤,安裝后,在我們項(xiàng)目里有Thrift45.dll的引用肛炮,如下圖:
下載thrift代碼生成工具
thrift是支持異構(gòu)語言止吐、異構(gòu)平臺(tái)的通信開發(fā)RPC框架,它通過中間語言IDL進(jìn)行描述你要定義的結(jié)構(gòu)侨糟、類碍扔、服務(wù)等,并通過代碼生成工具生成各個(gè)語言上對(duì)應(yīng)的代碼秕重。
接下來不同,我們進(jìn)入Apache網(wǎng)站Thrift項(xiàng)目下載Thrift代碼生成工具,如下圖:
我們把下載的這個(gè)exe文件放到我們項(xiàng)目的根目錄下,以備后用二拐,如下圖:
至此服鹅,關(guān)于thrift的開發(fā)工具,我們已經(jīng)準(zhǔn)備完畢百新,接下來來編寫thrift接口描述文件
thrift描述文件
thrift提供的接口描述文件是以thrift結(jié)尾的格式文件企软,我們來解釋一下這種IDL的語法,
- 它提供了基礎(chǔ)類型的定義饭望,包括bool仗哨、i16、i32铅辞、i64厌漂、double、string
- enum
- Struct 對(duì)一些基礎(chǔ)類型的封裝斟珊,對(duì)應(yīng)C#中Class字段
- 還有一些集合的定義苇倡,包含 set<> 對(duì)應(yīng)C#中的HashSet,是一種唯一元素的集合(Thrift框架自己定義了THashSet類型與之相對(duì)應(yīng))囤踩;list<>對(duì)應(yīng)C#中的List<>;map<K,V>對(duì)應(yīng)C#的Dictionary<K,V>
- service 這個(gè)是thrift的重點(diǎn)旨椒,它是一些方法集合,thrift會(huì)根據(jù)這個(gè)定義生成客戶端代碼和服務(wù)端代碼
- exception 對(duì)應(yīng)C#中的Exception類型
thrift關(guān)于類型的定義以及示例代碼請(qǐng)打開這個(gè)網(wǎng)址:IDL描述
在IDL描述文件中高职,Thrift除了對(duì)類型的定義外钩乍,我們還需要記住一下知識(shí)點(diǎn):
- namespace 在描述文件的頭部定義。 以當(dāng)前文件為根目錄怔锌,生成多級(jí)目錄寥粹;在生成的代碼上添加namespace命名空間。代碼如下:
namespace csharp WpfApp1.ceshi
- include 在描述文件的頭部定義埃元。 用該命令包含其他thrift描述文件涝涤,當(dāng)編譯生成代碼時(shí)也會(huì)編譯include指定的thrift文件。代碼如下:
include "pe1.thrift"
使用方法,pe1.thrift文件定義如下:
struct pe1
{
1: i32 id;
}
在其他文件中岛杀,引入上述文件阔拳,定義如下:
include "pe1.thrift"
service GuidGenService
{
string getGuid(1:pe1.pe1 pe1);
}
- typedef 類型定義命令,將thrift支持的類型定義一個(gè)別名类嗤。代碼如下:
typedef i32 int
struct People
{
1: int ID;
2: string Name;
3: i16 Age;
4: list<i32> onelist;
5: set<string> oneSet;
6: map<i32,string> oneset;
}
當(dāng)定義完描述文件后糊肠,我們通過如下cmd命令生成代碼文件:
thrift-0.12.0.exe -r -gen csharp People.thrift
我們先要通過cd 將當(dāng)前路徑跳轉(zhuǎn)到thrift-0.12.0.exe所在的路徑
示例
我定義了了一個(gè)描述文件,如下:
namespace csharp WpfApp1.ceshi
include "pe1.thrift"
typedef i32 int
struct People
{
1: int ID;
2: string Name;
3: i16 Age;
4: list<i32> onelist;
5: set<string> oneSet;
6: map<i32,string> oneset;
}
service HelloService
{
void SetPeople(1: People people1);
}
service GuidGenService
{
string getGuid(1:pe1.pe1 pe1);
}
我們通過上述命令執(zhí)行后遗锣,生成的代碼結(jié)構(gòu)如下圖:
我們打開people.cs可以看到struct people生成了如下代碼:
namespace WpfApp1.ceshi
{
#if !SILVERLIGHT
[Serializable]
#endif
public partial class People : TBase
{
private int _ID;
private string _Name;
private short _Age;
private List<int> _onelist;
private THashSet<string> _oneSet;
private Dictionary<int, string> _oneset;
.....
這里需要注意一下people類的命名空間货裹,這和我們上文講的時(shí)一致的。
我們定義的service GuidGenService生成了如下代碼:
該類是我們使用該框架的重點(diǎn)精偿,它給我們生成了客戶端和服務(wù)器端代碼弧圆,從圖中我們可以看該文件下生成了兩個(gè)接口ISync和Iface赋兵,前者是同步方法,后者生成的是異步調(diào)用方法搔预,接下來是一個(gè)供我們客戶端調(diào)用的類霹期,它繼承了iface接口,而iface又繼承了ISync接口拯田;再往下看是一個(gè)Processor历造,是服務(wù)端使用的類。
結(jié)尾
這篇文件我們講了從0到1使用thrift框架的方法勿锅,也講了一些該框架的基本知識(shí)帕膜,接下來的文件昼扛,我們將通過一個(gè)示例具體講解一下service指令代碼生成的代碼的具體含義和使用方法