先決條件

安裝 thrift

$ brew install thrift
$ thrift -version
Thrift version 0.11.0

如果需要安裝 0.10.0, 請執行如下命令

brew install https://raw.githubusercontent.com/Homebrew/homebrew-core/16ebe5f1843e6cb54856311ff0f676be53007329/Formula/thrift.rb

建立 Maven 專案

建立 Maven 專案 thrift-server, 包含兩個模組 thrift-api 和thrift-service, 前者定義 API 介面, 後者是具體的實現.

父專案

父專案 thrift-server 的 POM 檔案定義

<parent>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-parent</artifactId>
  <version>1.5.9.RELEASE</version>
</parent>
<modelVersion>4.0.0</modelVersion>

<groupId>com.example</groupId>
<artifactId>thrift-server</artifactId>
<packaging>pom</packaging>
<version>1.0-SNAPSHOT</version>

<modules>
  <module>thrift-api</module>
  <module>thrift-service</module>
</modules>

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-compiler-plugin</artifactId>
      <version>3.6.1</version>
      <configuration>
        <source>1.8</source>
        <target>1.8</target>
      </configuration>
    </plugin>
  </plugins>
</build>
 

介面子專案

API 介面子專案 thrift-api 的 POM 檔案主要定義

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.thrift</groupId>
      <artifactId>thrift-maven-plugin</artifactId>
      <version>0.10.0</version>
      <configuration>
        <thriftExecutable>/usr/local/bin/thrift</thriftExecutable>
      </configuration>
      <executions>
        <execution>
          <id>thrift-sources</id>
          <phase>generate-sources</phase>
          <goals>
            <goal>compile</goal>
          </goals>
        </execution>
        <execution>
          <id>thrift-test-sources</id>
          <phase>generate-test-sources</phase>
          <goals>
            <goal>testCompile</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

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

注意, 這裡使用的是 thrift-maven-plugin 外掛, 而不是 maven-thrift-plugin, 該外掛將在編譯之前, 將 thrift 檔案生成 Java 程式碼.

新建檔案 thrift-api/src/main/thrift/service.thrift, 內容如下

namespace java com.example.thrift.api
service HelloService {
    string greet(1:string name)
}

實現子專案

服務實現子專案 thrift-service 的 POM 檔案主要定義

<build>
  <plugins>
    <plugin>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-maven-plugin</artifactId>
    </plugin>
  </plugins>
</build>

<dependencies>
  <dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
  </dependency>
  <dependency>
    <groupId>com.example</groupId>
    <artifactId>thrift-api</artifactId>
    <version>1.0-SNAPSHOT</version>
  </dependency>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
  </dependency>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
  </dependency>
</dependencies>

新建入口類檔案 thrift-service/src/main/java/com/example/Application.java, 內容如下

@Slf4j
@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

建立 HelloService.Iface 的實現類com.example.service.HelloServiceImpl, 內容如下

@Service("helloService")
public class HelloServiceImpl implements HelloService.Iface {
    @Override
    public String greet(String para) throws TException {
        return String.format("Hello %s!", para);
    }
}

編寫抽象測試類 com.example.AbstractTest, 內容如下

@RunWith(SpringRunner.class)
@SpringBootTest
public abstract class AbstractTest {
}

建立服務測試類 com.example.service.HelloServiceTest, 首先測試本地呼叫

@Autowired
private HelloService.Iface helloService;

@Test
public void testLocal() {
    try {
        log.info("本地呼叫服務...{}", helloService.greet("Local"));
    } catch (TException e) {
        log.error("本地呼叫異常.", e);
    }
}

執行測試輸出 本地呼叫服務...Hello Local!, 說明介面實現沒有問題.

遠端呼叫

服務端

在 Application.java 的 main 方法中增加如下邏輯

try {
    TProcessor tprocessor = new HelloService.Processor<>(new HelloServiceImpl());
    TServerSocket serverTransport = new TServerSocket(9898);
    TServer.Args tArgs = new TServer.Args(serverTransport);
    tArgs.processor(tprocessor);
    tArgs.protocolFactory(new TBinaryProtocol.Factory());
    TServer server = new TSimpleServer(tArgs);
    server.serve();
    log.info("服務端開啟....");
} catch (TTransportException e) {
    log.error("服務端開啟異常.", e);
}

將專案構建打包 mvn clean package, 將生成的 thrift-service-1.0-SNAPSHOT.jar 可執行 jar 包移到專案以外, 比如 /tmp 目錄, 然後用 java -jar xxx.jar 啟動服務端.

客戶端

在測試類 HelloServiceTest 中增加遠端呼叫測試

@Test
public void testRemote() {
    try (TTransport transport = new TSocket("localhost", 9898, 30000)) {
        TProtocol protocol = new TBinaryProtocol(transport);
        HelloService.Client helloService = new HelloService.Client(protocol);
        transport.open();
        log.info("遠端呼叫服務...{}", helloService.greet("Remote"));
    } catch (TException e) {
        log.error("遠端呼叫異常.", e);
    }
}

執行測試輸出 遠端呼叫服務...Hello Remote!, 說明遠端呼叫服務也沒有問題. 以上我們就構建了一個簡單的單執行緒微服務模型.

參考文獻