Thrift 基本使用

Steven大约 1 分钟

记录 Thrift 的安装、使用。

参考：

https://www.cnblogs.com/fingerboy/p/6424248.htmlopen in new window

安装

Thrfit 是 c++ 编写的，源码存放在 github 仓库open in new window上，一般需要源码编译安装。

安装脚本

#!/bin/bash
#
# thrift 安装脚本
#
# 参考：
# + 安装脚本 —— https://thrift.apache.org/docs/install/centos
# + 环境要求 —— https://thrift.apache.org/docs/install/
#

WORKSPACE=$1
if [ -n "$WORKSPACE" ] || WORKSPACE=$(mktemp -d)
cd $WORKSPACE

THRIFT_VERSION="0.20.0"
THRIFT_HOME="${WORKSPACE}/thrift-install/${THRIFT_VERSION}/"

function install_src_thrift() {
  cd ${WORKSPACE}
  if [ ! -d "thrift-${THRIFT_VERSION}" ]; then
    wget https://dlcdn.apache.org/thrift/${THRIFT_VERSION}/thrift-${THRIFT_VERSION}.tar.gz
    tar -zxvf thrift-${THRIFT_VERSION}.tar.gz
  fi
}

function install_yum() {
  yum -y install wget
  yum -y groupinstall "Development Tools"
  yum -y install libtool flex bison pkgconfig boost-devel libevent-devel zlib-devel python-devel ruby-devel openssl-devel
  yum -y install ant
  yum -y install boost
}

function build() {
  cd thrift-${THRIFT_VERSION}

  local CONFIGURE_FLAGS=""
  CONFIGURE_FLAGS="${CONFIGURE_FLAGS} --prefix=$THRIFT_HOME"
  # CONFIGURE_FLAGS="${CONFIGURE_FLAGS} --with-cpp --with-boost=/usr/local/" # 源码编译 boot 则指定 boost 位置。否则 “g++: error: /usr/local//lib/libboost_unit_test_framework.a: No such file or directory”
  CONFIGURE_FLAGS="${CONFIGURE_FLAGS} --with-cpp" # 使用 boost 默认位置
  CONFIGURE_FLAGS="${CONFIGURE_FLAGS} --with-python"
  CONFIGURE_FLAGS="${CONFIGURE_FLAGS} --with-java" # ant
  CONFIGURE_FLAGS="${CONFIGURE_FLAGS} --without-csharp"
  CONFIGURE_FLAGS="${CONFIGURE_FLAGS} --without-erlang"
  CONFIGURE_FLAGS="${CONFIGURE_FLAGS} --without-perl"
  CONFIGURE_FLAGS="${CONFIGURE_FLAGS} --without-php --without-php_extension"
  CONFIGURE_FLAGS="${CONFIGURE_FLAGS} --without-ruby"
  CONFIGURE_FLAGS="${CONFIGURE_FLAGS} --without-haskell"
  CONFIGURE_FLAGS="${CONFIGURE_FLAGS} --without-go"

  ./bootstrap.sh
  ./configure ${CONFIGURE_FLAGS}

: <<COMMENT
thrift 0.20.0

Building C (GLib) Library .... : no
Building C++ Library ......... : yes
Building Common Lisp Library.. : no
Building D Library ........... : no
Building Dart Library ........ : no
Building .NET Standard Library : no
Building Erlang Library ...... : no
Building Go Library .......... : no
Building Haxe Library ........ : no
Building Java Library ........ : no # ???? 确定有 java 和 ant 的。而且编译后又确实能生成 java 代码？
Building Kotlin Library ...... : no
Building Lua Library ......... : no
Building NodeJS Library ...... : no
Building Perl Library ........ : no
Building PHP Library ......... : no
Building Python Library ...... : yes
Building Py3 Library ......... : yes
Building Ruby Library ........ : no
Building Rust Library ........ : no
Building Swift Library ....... : no

C++ Library:
   C++ compiler .............. : g++ -std=c++11
   Build TZlibTransport ...... : yes
   Build TNonblockingServer .. : yes
   Build TQTcpServer (Qt5) ... : no
   C++ compiler version ...... : g++ (GCC) 10.3.1

Python Library:
   Using Python .............. : /usr/bin/python3
   Using Python version ...... : Python 3.9.9
   Using Python3 ............. : /usr/bin/python3
   Using Python3 version ..... : Python 3.9.9

If something is missing that you think should be present,
please skim the output of configure to find the missing
component.  Details are present in config.log.
COMMENT

  make
  make install
}

编译 IDL 文件

thrift -help

thrift -gen java user.thrift
thrift -gen cpp user.thrift
thrift -gen php user.thrift
thrift -gen js:node user.thrift

thrift -gen java -o target user.thrift

例子：简单 C/S 通信

代码： https://github.com/LawssssCat/blog/tree/master/code/demo-thrift/

生成接口文件

#!/bin/bash

SCRIPT_PATH=$(cd $(dirname $0); pwd)
PROJECT_PATH=$(cd $SCRIPT_PATH/../; pwd)

function copy_file() {
  local src="$1"
  local dst="$2"
  mkdir -pv ${dst%/*}
  cp -avf $src $dst
}

# java
thrift --gen java -o ${PROJECT_PATH}/target/ ${PROJECT_PATH}/user.thrift
copy_file "${PROJECT_PATH}/target/gen-java/*" "${PROJECT_PATH}/thrift-api/src/main/java/"

# python
thrift --gen py -o ${PROJECT_PATH}/target/ ${PROJECT_PATH}/user.thrift
copy_file "${PROJECT_PATH}/target/gen-py/*" "${PROJECT_PATH}/thrift-client-python/thrift_api/"

# tree thrift-api/
thrift-api/
├── pom.xml
└── src
    └── main
        └── java
            └── com
                └── example
                    └── thrift
                        ├── User.java
                        └── UserService.java

9 directories, 3 files

客户端/服务端代码 java/java

引入依赖

<dependency>
  <groupId>org.apache.thrift</groupId>
  <artifactId>libthrift</artifactId>
  <version>0.20.0</version>
</dependency>

对于开发人员而言，使用原生的 Thrift 框架，需要关注以下四个核心内部接口类：

Iface —— 服务端通过实现 UserService.Iface 接口，向客户端提供具体的同步业务逻辑。
AsyncIface —— 服务端通过实现 UserService.Iface 接口，向客户端提供具体的异步业务逻辑。
Client —— 客户端通过 UserService.Client 的实例对象，以同步的方式访问服务端提供的服务方法。
AsyncClient —— 客户端通过 UserService.Client 的实例对象，以异步的方式访问服务端提供的服务方法。

服务端 - 处理层

package org.example.service.processor;

import com.example.thrift.User;
import com.example.thrift.UserService;
import org.apache.thrift.TException;

import java.util.HashMap;
import java.util.Map;

public class UserServiceImpl implements UserService.Iface {

    final private Map<Integer, User> userMap = new HashMap<>();
    {
        User user = new User();
        user.setId(1);
        user.setName("Steven");
        // user.age = 0
        userMap.put(user.getId(), user);
    }

    @Override
    public User getById(int id) throws TException {
        System.out.println(" ==== 远程调用 getById 方法 ===");
        return userMap.get(id);
    }

    @Override
    public boolean isExist(String name) throws TException {
        return userMap.values().stream().anyMatch(p -> p.getName().equals(name));
    }
}

服务端 - 协议层/传输层

package org.example.service;

import com.example.thrift.UserService;
import org.apache.thrift.protocol.TBinaryProtocol;
import org.apache.thrift.server.TServer;
import org.apache.thrift.server.TSimpleServer;
import org.apache.thrift.transport.TServerSocket;
import org.apache.thrift.transport.TTransportException;
import org.example.service.processor.UserServiceImpl;

public class SimpleService {
    public static void main(String[] args) {
        try (TServerSocket socket = new TServerSocket(19090); // 传输层
        ){
            TBinaryProtocol.Factory protocolFactory = new TBinaryProtocol.Factory(); // 协议层
            UserService.Processor<UserServiceImpl> processor = new UserService.Processor<>(new UserServiceImpl()); // 处理层

            // 设置服务器参数
            TServer.Args serverArgs = new TServer.Args(socket); // 传输层
            serverArgs.protocolFactory(protocolFactory); // 协议层
            serverArgs.processor(processor); // 处理层
            // 启动服务器 （单线程，一般用于测试）
            TSimpleServer server = new TSimpleServer(serverArgs);
            server.serve();
        } catch (TTransportException e) {
            throw new RuntimeException(e);
        }
    }
}

客户端 - 协议层/传输层

package org.example.client;

import com.example.thrift.User;
import com.example.thrift.UserService;
import org.apache.thrift.TException;
import org.apache.thrift.protocol.TBinaryProtocol;
import org.apache.thrift.protocol.TProtocol;
import org.apache.thrift.transport.TSocket;
import org.apache.thrift.transport.TTransport;
import org.apache.thrift.transport.TTransportException;

public class SimpleClient {
    public static void main(String[] args) {
        String host = "localhost";
        int port = 19090;
        try (TTransport socket = new TSocket(host, port); // 传输层，阻塞io
        ) {
            TProtocol protocol = new TBinaryProtocol(socket); // 协议层，二进制编码格式
            UserService.Client client = new UserService.Client(protocol);
            // Connect!
            socket.open();
            try {
                User user = client.getById(1);
                System.out.println("user = " + user);
            } catch (TException e) {
                throw new RuntimeException(e);
            }
        } catch (TTransportException e) {
            throw new RuntimeException(e);
        }
    }
}

客户端/服务端代码 python/java

服务端用上面的 java，下面写 python 客户端代码。

首先，下载 thrift 的 python 模块

pip install thrift

客户端 - 传输层/协议层/处理层

from thrift.transport import TSocket, TTransport
from thrift.protocol import TBinaryProtocol

from thrift_api.user import UserService

host = "localhost"
port = 19090

# 传输层
socket = TSocket.TSocket(host, port)
socket.setTimeout(600)
# Buffering is critical. Raw sockets are very slow
socket = TTransport.TBufferedTransport(socket)

# 协议层
protocol = TBinaryProtocol.TBinaryProtocol(socket)

# Create a client to use the protocol encoder
client = UserService.Client(protocol)

# Connect!
socket.open()

user = client.getById(1)
print(user)