thrift+springBoot

1 基本语法

1.1 数据类型

基本类型：
bool 布尔类型，true或者false
byte 字节类型，长度为8位，有符号
i16 16位有符号整形，java中的short
i32 32位有符号整形，java中的int
i64 64位有符号整形，java中的long
double 64位浮点数
string 一串编码未知的文本或二进制串需要注意的是，没有无符号整形。这是兼容多种语言所要求的(utf-8编码的字符串)。

特殊类型：
binary：未经过编码的字节流，java中的ByteBuffer。

容器类型：
Thrift支持三种容器：

list 列表容器，会被直接转化为STL的vector, JAVA的ArrayList和其他脚本语言的内置数组.
set 元素无序唯一的集合容器，会被转化为STL set，JAVA HashSet, Python set或内置PHP/Ruby的内置字典.
map<type1, type2> 一个key唯一的key-value映射map，会被转化为STL map, Java HashMap, PHP 关联数组, 或Python/Ruby的字典.
容器的类型可以是任何有效的Thrift类型，包括其他容器和结构体.

结构体：
一个Thrift struct定义了一个用于多语言的通用对象，基本上相当于面向对象语言中的一个类。一个结构体的例子如下：

struct Example {1:i32 number=10,2:i64 bigNumber,3:double decimals,4:string name="thrifty"
}

异常:
异常的语法和结构体基本相同，除了异常使用的关键字是exception而不是struct. 生成的对象会继承目标语言的异常基类，以便和任何指定语言的异常处理机制更好的整合.

枚举：
可以像C/C++那样定义枚举类型，如：

enum TweetType {TWEET,RETWEET = 2,DM = 0xa,REPLY
}struct Tweet {1: required i32 userId;2: required string userName;3: required string text;4: optional Location loc;5: optional TweetType tweetType = TweetType.TWEET6: optional string language = "english"
}

说明：
编译器默认从0开始赋值
可以赋予某个常量某个整数
允许常量是十六进制整数
末尾没有逗号
给常量赋缺省值时，使用常量的全称。

服务
服务是基于Thrift类型定义的. 服务的定义在语义上大概相当于面向对象语言中定义一个接口或一个纯虚抽象类. Thrift编译器会生成实现该接口的全功能客户端和服务端桩代码. 服务定义类似如下：

service <name> {<returntype> <name>(<arguments>)[throws (<exceptions>)]...
}

实例如下:

service StringCache {void set(1:i32 key, 2:string value),string get(1:i32 key) throws (1:KeyNotFound knf),void delete(1:i32 key)
}

注释：
Thrift支持Shell注释风格，也支持C/C++的单行和多行注释风格.

# shell风格注释./** 多行注释* 类似C/C++/Java*/// C++/Java 当行注释

名空间：
Thrift中的命名空间同C++中的namespace和java中的package类似，它们均提供了一种组织（隔离）代码的方式。因为每种语言均有自己的命名空间定义方式（如python中有module），thrift允许开发者针对特定语言定义namespace：

namespace cpp com.example.project  // a
namespace java com.example.project // b 说明： a．  转化成namespace com { namespace example { namespace project { b．  转换成package com.example.project

文件包含
Thrift允许thrift文件包含，用户需要使用thrift文件名作为前缀访问被包含的对象，如：

#include "tweet.thrift"
...
struct TweetSearchResult {1: list<tweet.Tweet> tweets;

} * 注意包含时的tweet前缀
常量
Thrift允许用户定义常量，复杂的类型和结构体可使用JSON形式表示。

const i32 INT_CONST = 1234;    // 分号是可选的
const map<string,string> MAP_CONST = {"hello": "world", "goodnight": "moon"} // 复杂结构可以使用JSON表示

Union：
Union：类似于C++的union，成员默认全部是optional类型，语法

union 名称标识 {
数字标识: (required|optional)? 类型 名称标识 (= 值)?
}

//示例
union SomeUnion {2: string string_thing,3: i32 i32_thing
}

2 springBoot+thrift

thrift接口生成工具下载地址：https://mirrors.tuna.tsinghua.edu.cn/apache/thrift/

生成代码的命令：

thrift --gen <language> <Thrift filename>

如果有thrift文件中有包含其他thrift，可以使用递归生成命令：

thrift -r --gen <language> <Thrift filename>

2.1 创建一个HelloService.thrift文件

namespace java com.example.thrift.service
service HelloService {string sayHello(1:string message);
}

2.2 在thrift文件所在的目录下执行命令

thrift --gen java HelloService

执行之后，会在HelloService.thrift目录下生成一个gen-java目录，里面有个生成的HelloService.java文件，这个就是用来实现远程调用的接口，然后，复制到我们项目对应的位置。【提示：执行命令的时候可以直接在idea的控制台执行】

2.3 springBoot引入thrift依赖

<dependency><groupId>org.apache.thrift</groupId><artifactId>libthrift</artifactId><version>选择版本</version>
</dependency>

2.4 实现接口

实现上面生成的HelloService接口

package com.example.thrift.service;import lombok.extern.slf4j.Slf4j;
import org.apache.thrift.TException;@Slf4j
public class HelloServiceImpl implements HelloService.Iface {@Overridepublic String sayHello(String message) throws TException {log.info("<<<收到消息：{}", message);return "Hi, I'm Server!";}
}

2.5 实现服务端

下一个thrift server

package com.example.thrift.server;import com.example.thrift.service.TestService;
import com.example.thrift.service.TestServiceImpl;
import lombok.extern.slf4j.Slf4j;
import org.apache.thrift.TProcessor;
import org.apache.thrift.server.TServer;
import org.apache.thrift.server.TThreadPoolServer;
import org.apache.thrift.transport.TServerSocket;@Slf4j
public class ThriftServer {public void start() {try {log.info(">>>Thrift服务端开启");TServerSocket serverSocket = new TServerSocket(1998); //服务端口1998TProcessor tProcessor = new TestService.Processor<TestService.Iface>(new TestServiceImpl());//BIO单线程版//TSimpleServer.Args sArgs = new  TSimpleServer.Args(serverSocket);//sArgs.processor(tProcessor);  //注册服务//TServer server = new TSimpleServer(sArgs);//BIO多线程版TThreadPoolServer.Args tArgs = new TThreadPoolServer.Args(serverSocket);tArgs.processor(tProcessor); //注册服务tArgs.minWorkerThreads(2); //设置线程池核心线程数量tArgs.maxWorkerThreads(10); //设置线程池最大线程数量TServer server = new TThreadPoolServer(tArgs);server.serve();} catch (Exception e) {log.error("Thrift服务发生错误：", e);}}
}

Thrift提供了两种线程版本，一个是单线程的一个是多线程的。另外一点要注意的是服务端server是会阻塞主线程的，所以在server开启之后不要有任务其他操作，否则是运行不到的。在SpringBoot初始化的过程中也不要启动服务，因为SpringBoot默认是以类名称排序去扫描包下面的配置或者组件等等，如果Thrift服务类名称在其他配置前面，刚好你在初始化Thrift的时候顺便也启动了服务的话，那么其他的Spring配置就会不能初始化了，所以可以在SpringBoot完全初始化之后再启动Thrift，或者干脆起一个线程跑Thrift服务。

2.6 编写客户端

package com.example.thrift.client;import com.example.thrift.service.HelloService;
import lombok.extern.slf4j.Slf4j;
import org.apache.thrift.protocol.TBinaryProtocol;
import org.apache.thrift.protocol.TProtocol;
import org.apache.thrift.transport.TSocket;
import org.apache.thrift.transport.TTransport;@Slf4j
public class ThriftClient {public static void main(String[] args) {TTransport transport = null;try {//TSocket 参数分别是：服务器地址，端口，连接超时时间(毫秒)transport = new TSocket("localhost", 1998, 30000);TProtocol protocol = new TBinaryProtocol(transport);HelloService.Client client = new HelloService.Client(protocol);transport.open();//这里得到返回数据是同步的String reply = client.sayHello("Hello, I'm Client");log.info(">>>收到回复消息：{}", reply);//如果需要异步，不要返回数据可以使用send_***方法//client.send_sayHello("Hello, I'm Client ~ ");//注意recv_***方法是同步的，会阻塞到收完数据//String reply = client.recv_sayHello();//log.info(">>>收到回复消息：{}", reply);} catch (Exception e) {log.error("Thrift客户端发生错误", e);} finally {if (transport != null) {transport.close();}}}
}

以上为用BIO的方式创建的服务端和客户端，提高效率可以修改为用NIO的方式实现，自己动手尝试一下吧