Thrift Spring Boot Starter

Spring Boot starter module for Thrift framework.

参与贡献

我们始终欢迎您对项目作出任何贡献。 详见CONTRIBUTING.md。

简介

本项目主要为了提高 Thrift 在 Spring Boot 和 Spring Cloud 中的使用体验，简化其配置方式，提供开箱即用的体验，在 Spring Cloud 的环境中提供注册发现和负载均衡功能模块。

服务端：

1. 支持 Apache Thrift 的各种原生服务线程模型，包括单线程阻塞模型(TSimpleServer)、单线程非阻塞模型(TNonblockingServer)、线程池阻塞模型(TThreadPoolServer)、半同步半异步模型(THsHaServer) 和半同步半异步线程选择器模型(TThreadedSelectorServer)；
2. 可以灵活的配置一些协议和线程模型；
3. 在 Spring Cloud 环境可以进行服务注册和发现，在 Spring Boot 环境中可以通过 ip 访问；
4. 使用 @ThriftService 注解即可完成 Thrift Handler 的注册管理。其中注解应该是 Iface 接口的实现类；

示例代码如下：

@ThriftService("SharedService")
public class SharedServiceImpl implements SharedService.Iface {

  @Autowired
  private RandomComponent randomComponent;

  @Override
  public SharedStruct getStruct(int key) {
    return new SharedStruct(key, randomComponent.randomString(key));
  }
}

客户端：

1. 支持 Apache Thrift 的各种客户端配置；
2. 在 Spring Boot 环境中，可以指定 Server 端的 ip + port 进行访问；
3. 在 Spring Cloud 环境中，可以进行服务发现和负载均衡；
4. 使用 @ThriftClient 注解即可完成 Thrift Client 的注册管理。其中注解应该是 Iface 接口的子接口，提供降级功能，用法类似 FeignClient

示例代码

@ThriftClient(name = "SharedService", serviceId = "spring-boot-thrift-server", fallback = SharedClientFallback.class)
public interface SharedClient extends SharedService.Iface {

}

详细用法查看 wiki 或者 https://bug-wheels.github.io/

版本支持

Thrift Starter	Spring Boot	Spring Cloud	Apache Thrift

未列出不代表不支持，可以自行尝试

快速开始

详细用法见 Spring Boot | Spring Cloud

以下示例未做说明均在 Spring Boot 项目中，而非单纯的 Spring

Thrift IDL

这是使用官方示例代码中的两个 IDL 文件, 为了简化，这里删除了注释和版权声明部分

shared.thrift

namespace java io.github.bw.example.shared

struct SharedStruct {
  1: i32 key
  2: string value
}

service SharedService {
  SharedStruct getStruct(1: i32 key)
}

tutorial.thrift

include "shared.thrift"

namespace java io.github.bw.example.tutorial

typedef i32 MyInteger

const i32 INT32CONSTANT = 9853
const map<string,string> MAPCONSTANT = {'hello':'world', 'goodnight':'moon'}

enum Operation {
  ADD = 1,
  SUBTRACT = 2,
  MULTIPLY = 3,
  DIVIDE = 4
}

struct Work {
  1: i32 num1 = 0,
  2: i32 num2,
  3: Operation op,
  4: optional string comment,
}

exception InvalidOperation {
  1: i32 whatOp,
  2: string why
}

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),

   oneway void zip()

}

Thrift-api的安装

example的demo需要依赖thrift-api模块，模块中提供的是.thrift文件来定义的接口，需要根据使用的语言生成对应的文件。对于Java环境来说，我们需要将thrift-api编译成对应的jar。

这里使用thrift的maven插件进行编译，在pom文件中根据自己的开发环境简单改一下配置：

Windows：

<thriftExecutable>../thrift-api/thrift-0.9.3.exe</thriftExecutable>

MacOs:

<thriftExecutable>/usr/local/bin/thrift</thriftExecutable>

最后使用 mvn clean install 命令将jar包安装到本地。

服务端程序：

在 pom.xml 文件中引入服务端依赖 thrift-server-spring-boot-starter：

<dependency>
  <groupId>io.github.bug-wheels</groupId>
  <artifactId>thrift-server-spring-boot-starter</artifactId>
</dependency>

application.yml

server:
  port: 9999

thrift: # thrift 的相关配置，可以不配
  server:
    port: 10109  # thrift 服务的启动端口，默认值是 10109
    serverMode: THsHaServer  # thrift 的服务线程模型，默认 THsHaServer，可选 THsHaServer  TNonblockingServer  TSimpleServer   TThreadPoolServer TThreadedSelectorServer

Application.java

@SpringBootApplication
public class ThriftExampleAppApplication {

  public static void main(String[] args) {
    SpringApplication.run(ThriftExampleAppApplication.class, args);
  }
}

实现 Thrift IDL 生成的 SharedService 中的 Iface 接口：

SharedServiceImpl.java

package io.github.bw.example.service;

import io.github.bw.boot.thrift.server.ThriftService;
import RandomComponent;
import io.github.bw.example.shared.SharedService;
import io.github.bw.example.shared.SharedStruct;
import org.springframework.beans.factory.annotation.Autowired;

@ThriftService("SharedService") // 这里需要起个别名，Client 调用时，需要指定这个名字，如果不设置名字，则默认使用 classname
public class SharedServiceImpl implements SharedService.Iface {

  @Autowired
  private RandomComponent randomComponent;

  @Override
  public SharedStruct getStruct(int key) {
    return new SharedStruct(key, randomComponent.randomString(key));
  }
}

启动项目：

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::        (v2.3.7.RELEASE)

2022-01-22 16:11:50,493 DEBUG [main] io.github.bw.example.ThriftExampleAppApplication [StartupInfoLogger.java:56] Running with Spring Boot v2.3.7.RELEASE, Spring v5.2.12.RELEASE
2022-01-22 16:11:50,493 INFO [main] io.github.bw.example.ThriftExampleAppApplication [SpringApplication.java:651] No active profile set, falling back to default profiles: default
2022-01-22 16:11:51,264 INFO [main] org.apache.coyote.http11.Http11NioProtocol [DirectJDKLog.java:173] Initializing ProtocolHandler ["http-nio-9999"]
2022-01-22 16:11:51,265 INFO [main] org.apache.catalina.core.StandardService [DirectJDKLog.java:173] Starting service [Tomcat]
2022-01-22 16:11:51,265 INFO [main] org.apache.catalina.core.StandardEngine [DirectJDKLog.java:173] Starting Servlet engine: [Apache Tomcat/9.0.41]
2022-01-22 16:11:51,324 INFO [main] org.apache.catalina.core.ContainerBase.[Tomcat].[localhost].[/] [DirectJDKLog.java:173] Initializing Spring embedded WebApplicationContext
2022-01-22 16:11:51,596 INFO [main] org.apache.coyote.http11.Http11NioProtocol [DirectJDKLog.java:173] Starting ProtocolHandler ["http-nio-9999"]
2022-01-22 16:11:51,632 INFO [main] io.github.bw.boot.thrift.server.server.THsHaThriftServer [THsHaThriftServer.java:42] Thrift Starting ["THsHaServer-10109"]
2022-01-22 16:11:51,642 INFO [main] io.github.bw.example.ThriftExampleAppApplication [StartupInfoLogger.java:61] Started ThriftExampleAppApplication in 1.522 seconds (JVM running for 2.022)

日志中也可以显示 Thrift 启动的线程模型和端口号

客户端程序：