本文主要是介绍跨语言RPC框架:Thrift的使用例子解析(包含完整项目源码),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
概述
- Thrift是由FaceBook于2007年开发的一款高性能,跨语言的RPC框架,支持多种不同语言之间的RPC调用,如Java,C++等,以下基于一个HelloWorld项目来展示Thrift框架的基本使用方法,项目的完整代码请参见:
- Thrift项目:Github thrift-IDL
- HelloWorld demo项目:Github thrift-demo
1. 创建Thrift项目,并在thrift文件定义数据结构与服务方法
- 在基于IDEA来开发Thrift项目,首先需要在IDEA中集成对应的thrift插件,然后可以直接创建包含thrift文件的Thrift项目并支持编译成Java类文件,如下为对应的Thrift项目:
-
首先需要在thrift文件定义业务数据结构和服务方法,如下在RpcHelloServiceThrift.thrift文件中定义RPC服务方法:如下定义了RpcHelloService服务或者称为RpcHelloService接口,声明了一个getHello方法。关于thrift的语法的更多知识可以参考thrift的官方文档。
namespace java com.yzxie.demo.java.thrift.api service RpcHelloService {// 返回Hello, userNamestring getHello(1:string userName) }
-
然后可以将该thrift文件编译为对应的Java文件,其中对应如上的thrift文件定义,编译得到的Java类文件为RpcHelloService.java,最后将该文件拷贝到一个Java项目中,该项目可以专门用于管理thrift对应的Java文件,从而实现thrift的客户端thrift-client项目与服务端thrift-server项目只需要引入该项目的jar包依赖即可,如下在thrift-rpc项目定义:
2. 实现RPC服务与Thrift服务端
-
RPC服务的实现主要是实现thrift文件编译得到的Java类文件的Iface接口,然后实现对应的业务方法即可,如下在RpcHelloServiceImpl文件中实现RpcHelloService的Iface接口并实现getHello方法。
public class RpcHelloServiceImpl implements RpcHelloService.Iface {@Overridepublic String getHello(String userName) throws TException {return "Hello, " + userName;} }
-
接着需要开发Thrift服务端来监听Thrift客户端对该服务方法的RPC调用请求,核心逻辑如下:关于以下类的更多知识可以参考thrift的官方文档。
public void start() {try {// 非阻塞NIO通信TNonblockingServerTransport serverTransport = new TNonblockingServerSocket(port);// 参数设置TNonblockingServer.Args serverArgs = new TNonblockingServer.Args(serverTransport);serverArgs.protocolFactory(new TBinaryProtocol.Factory());// 可以不指定,TNonblockingServer默认为TFramedTransportserverArgs.transportFactory(new TFramedTransport.Factory());// RPC请求处理器,需要指定提供RPC方法的服务类对象RpcHelloService.Processor processor = new RpcHelloService.Processor<RpcHelloService.Iface>(rpcHelloService);serverArgs.processor(processor);// NIO服务器监听thrift客户端的连接请求和后续的RPC方法调用请求TNonblockingServer server = new TNonblockingServer(serverArgs);LOG.info("TNonblockingServer listen on: {}", port);// 阻塞等待客户端连接到来server.serve();} catch (Exception e) {LOG.error("start {}", port, e);} }
其中需要指定RPC服务对应thrift的RPC请求处理器,如RpcHelloService.Processor ,并且需要指定RPC服务的对象,如rpcHelloService。之后thrift服务端启动后会在指定的端口监听thrift客户端的连接请求和后续的RPC方法调用请求。
3. 实现Thrift客户端
-
thrift客户端的实现主要包括创建连接thrift的服务端的socket套接字和RPC服务对应的客户端代理对象,其中是通过创建编译thrift文件得到的Java类的内部类Client的对象来实现,如RpcHelloService对应的RpcHelloService.Client。具体定义如下:
public class ThriftClientWrapper {private TTransport tTransport;private RpcHelloService.Client helloClient;public void init(String host, int port){// 指定需要连接的thrift服务端的域名host与port来创建对应的通信sockettTransport = new TFramedTransport(new TSocket(host, port));// RPC服务调用代理helloClient = new RpcHelloService.Client(new TBinaryProtocol(tTransport));}public void open() throws TTransportException {// 建立socket连接this.tTransport.open();}public void close() {// 关闭socket连接this.tTransport.close();}// 业务方法调用该方法获取RPC服务调用代理对象来发起RPC方法调用请求public RpcHelloService.Client getHelloClient() {return this.helloClient;} }
-
接着在Java的标准Service类,如HelloService中调用以上的ThriftClientWrapper类对象来发起RPC方法调用请求,核心实现如下:
public String sayHello(String userName) {try {// 建立socket连接thriftClient.open();// 发起RPC方法调用请求return thriftClient.getHelloClient().getHello(userName);} catch (TException e) {LOG.error("sayHello {}", userName, e);} finally {// 关闭socket连接thriftClient.close();}return ""; }
首先需要建立socket连接,然后通过客户端RPC服务调用代理来发起RPC方法调用请求,最后需要关闭socket连接。
这篇关于跨语言RPC框架:Thrift的使用例子解析(包含完整项目源码)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!