Thrift 框架的使用

Thrift 框架主要用于跨语言服务的开发。一般场景下,服务端对于接口的互相调用可以直接使用 http 请求来完成,这种方式简单并且方便,但是,数据的传输速度并不是很快,并且很难规范出一种统一的调用方式。

比较理想的调用方式应该是这样,对于客户端来说,服务端的实现方式是透明的,客户端只需要知道自己可以调用哪些方法,以及如何调用这些方法,所谓如何调用,是指相关方法需要传入什么参数,以及其返回值格式。在thrift框架中,这种约定可以通过接口描述来实现。

在确定接口描述之后,实际上对于任何需要与服务端通信的客户端来说,调用方式就已经确定。而客户端可以由其它各种语言自己实现。

数据类型

基础类型

  • bool: A boolean value (true or false)
  • byte: An 8-bit signed integer
  • i16: A 16-bit signed integer
  • i32: A 32-bit signed integer
  • i64: A 64-bit signed integer
  • double: A 64-bit floating point number
  • string: A text string encoded using UTF-8 encoding

结构体

通其它语言中一样,IDL中的结构体,定义一种数据类型的集合,这个变量可以在其他地方被使用。对应于具体的语言,类似于类的概念。

容器

在IDL中,这种存放数据的结构称为容器,在编译之后的具体语言文件中,将会对应到这种语言所支持的数据结构。

  • list: An ordered list of elements. Translates to an STL vector, Java ArrayList, native arrays in scripting languages, etc.
  • set: An unordered set of unique elements. Translates to an STL set, Java HashSet, set in Python, etc. Note: PHP does not support sets, so it is treated similar to a List
  • map: A map of strictly unique keys to values. Translates to an STL map, Java HashMap, PHP associative array, Python/Ruby dictionary, etc. While defaults are provided, the type mappings are not explicitly fixed. Custom code generator directives have been added to allow substitution of custom types in various destination languages.

Services

定义 service 相当于定义接口,或者纯虚抽象类,定义的方法相当于面向对象语言中的纯虚函数。thrift 的编译器将根据相关定义来实现客户端和服务端的代码。
service 由一组函数组成,每个函数都有一组参数定义和返回值的定义。

IDL

以官网 tutorial.thrift 示例来做说明

常量定义
// 定义32位整型
const i32 INT32CONSTANT = 9853
//定义一个map结构
const map<string,string> MAPCONSTANT = {'hello':'world', 'goodnight':'moon'}
//定义一个结构体,每个字段前面都有一个整数作为标记,字段可设置默认值
struct Work {
  1: i32 num1 = 0,
  2: i32 num2,
  3: Operation op,
  4: optional string comment,
}
//定义一个service
service Calculator extends shared.SharedService {

   void ping(),

  //返回值,参数列表同样用数字作为标记
   i32 add(1:i32 num1, 2:i32 num2),

   i32 calculate(1:i32 logid, 2:Work w) throws (1:InvalidOperation ouch),

   /**
    * This method has a oneway modifier. That means the client only makes
    * a request and does not listen for any response at all. Oneway methods
    * must be void.
    */
   oneway void zip()

}

编译

可直接在本地安装 thrift 编译器,或者用docker来运行编译命令。docker 运行可能更方便一些,还可以避免本机环境和部署环境的不同而导致代码无法运行。
运行编译命令:thrift --gen <language> <Thrift filename>

以 go 语言为例:thrift --gen go tutorial.thrift
编译过程中,会生成 go-gen 目录,编译好的包也会自动放入这个目录。上述 thrift 文件则生成了包名为 tutorial 的 go 语言包。然后将生成的包移动到 GOPATH 目录下,就可以直接调用了。

运行

以官网示例作为说明:
https://thrift.apache.org/tutorial/go

代码分为三部分,server handler client。
server.go 启动了一个服务端程序,handler.go 则具体实现了service里面定义的纯虚函数,client.go 则是远程调用的实现方式。

运行 server.go 需要向其添加入口函数,完整代码如下:

package main

import (
    "crypto/tls"
    "fmt"
    "tutorial"

    "./handler"
    "git.apache.org/thrift.git/lib/go/thrift"
)

func runServer(transportFactory thrift.TTransportFactory, protocolFactory thrift.TProtocolFactory, addr string, secure bool) error {
    var transport thrift.TServerTransport
    var err error
    if secure {
        cfg := new(tls.Config)
        if cert, err := tls.LoadX509KeyPair("server.crt", "server.key"); err == nil {
            cfg.Certificates = append(cfg.Certificates, cert)
        } else {
            return err
        }
        transport, err = thrift.NewTSSLServerSocket(addr, cfg)
    } else {
        transport, err = thrift.NewTServerSocket(addr)
    }

    if err != nil {
        return err
    }
    fmt.Printf("%T\n", transport)
        //引入 handler 并传入,此处相当于返回一个对象实例,对象的方法就是纯虚函数的具体实现
    handler := handler.NewCalculatorHandler()
    processor := tutorial.NewCalculatorProcessor(handler)
    server := thrift.NewTSimpleServer4(processor, transport, transportFactory, protocolFactory)

    fmt.Println("Starting the simple server... on ", addr)
    return server.Serve()
}

func main() {
    transportFactory := thrift.NewTBufferedTransportFactory(1024)
    protocolFactory := thrift.NewTBinaryProtocolFactoryDefault()
//监听 1234 端口
    addr := "127.0.0.1:1234"
    runServer(transportFactory, protocolFactory, addr, false)
}

运行 client.go 同样需要添加入口函数 main ,并初始化连接,步骤和上述相同。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,457评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,837评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,696评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,183评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,057评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,105评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,520评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,211评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,482评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,574评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,353评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,213评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,576评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,897评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,489评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,683评论 2 335

推荐阅读更多精彩内容