RPC框架-Thrift的使用
阿新 • • 發佈：2019-02-06
Apache Thrift
Thrift 是一種介面描述語言,通過二進位制通訊協議為多種程式語言定義和建立服務。Thrift是一種可擴充套件的跨語言服務的RPC框架,由Facebook開發並且開源。
應用
安裝
MAC
brew install thrift
其他安裝方式
解壓後進入目錄執行:./configure && make
編寫IDL檔案
安裝好Thrift之後需要建立一個.thrift結尾的檔案。該檔案定義了thrift中的型別和服務。這些被定義的服務將被實現且能夠被客戶端呼叫。
IDL即:Interface definition language 介面描述語言,它是Thrift自己的一套介面定義語法。官方語法定義如下:
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/ 根據語法,編寫簡單的IDL檔案如下:
檔名: exampleService.thrift
介面定義如下:
namespace java example
namespace php example
/**
* 異常程式碼
*/
enum ErrorCode {
/**
* 成功
*/
SUCCESS = 0,
/**
* 失敗
*/
FAILED = -1,
}
/**
* 異常程式碼含義
*/
const map<i16,string> ERROR_CODE_MESSAGE = {
ErrorCode.SUCCESS: 'success',
ErrorCode.FAILED: 'failed',
}
/**
* 返回資料結構
*/
struct Data {
/**
* 加數
*/
1: i32 data_one,
/**
* 被加數
*/
2: i32 data_two,
/**
* 和
*/
3: i32 sum,
}
/**
* 服務返回結果
*/
struct Result {
1: i32 code;
2: string message;
3: optional Data data;
}
/**
* 服務
*/
service CalcService {
/**
* 計算兩個數的和
*/
Result sum(1:i32 data_one, 2:i32 data_two),
}
介面定義完成之後生成響應語言的程式碼,執行:thrift -r -gen php:server -v -strict -out /path/to/code/ /path/to/exampleService.thrift
服務實現
服務定義好之後,需要實現服務,實現服務的檔名稱:PhpService.php,內容如下:
<?php
namespace example;
error_reporting(E_ALL);
require __DIR__ . '/../vendor/autoload.php';
require_once __DIR__ . '/CalcService.php';
require_once __DIR__ . '/Types.php';
use Thrift\ClassLoader\ThriftClassLoader;
$loader = new ThriftClassLoader();
$loader->registerNamespace('Thrift', __DIR__ . '/../vendor/apache/thrift/lib/php/lib');
$loader->register();
if (php_sapi_name() == 'cli') {
ini_set("display_errors", "stderr");
}
use Thrift\Protocol\TBinaryProtocol;
use Thrift\Transport\TPhpStream;
use Thrift\Transport\TBufferedTransport;
class CalculatorHandler implements CalcServiceIf
{
/**
* 計算兩個數的和
*
* @param int $data_one
* @param int $data_two
* @return \example\Result 服務返回結果
*
*/
public function sum($data_one, $data_two)
{
if (!is_numeric($data_one) || !is_numeric($data_two)) {
$error_code = ErrorCode::FAILED;
$messages = Constant::get('ERROR_CODE_MESSAGE');
$msg = $messages[$error_code];
$result = new Result();
$result->code = $error_code;
$result->message = $msg;
return $result;
}
$code = ErrorCode::SUCCESS;
$messages = Constant::get('ERROR_CODE_MESSAGE');
$msg = $messages[$code];
$result = new Result();
$result->code = $code;
$result->message = $msg;
$result_data = new Data();
$result_data->data_one = $data_one;
$result_data->data_two = $data_two;
$result_data->sum = $data_one + $data_two;
$result->data = $result_data;
return $result;
}
}
header('Content-Type', 'application/x-thrift');
if (php_sapi_name() == 'cli') {
echo "\r\n";
}
$handler = new CalculatorHandler();
$processor = new CalcServiceProcessor($handler);
$transport = new TBufferedTransport(new TPhpStream(TPhpStream::MODE_R | TPhpStream::MODE_W));
$protocol = new TBinaryProtocol($transport, true, true);
$transport->open();
$processor->process($protocol, $protocol);
$transport->close();
啟動服務
在nginx配置中新增如下配置,監聽服務:
server {
listen 8080;
server_name localhost;
location ~* ^/php/PhpServer {
rewrite . /index.php last;
}
location = /index.php {
internal;
fastcgi_pass localhost:9000;
fastcgi_param SCRIPT_FILENAME /path/to/PhpService.php;
include fastcgi_params;
}
}其中的fastcgi_param引數的值是PhpService.php檔案的絕對路徑.
執行nginx -s reload重啟nginx。
客戶端程式碼
客戶端檔名:PhpClient.php,內容如下:
<?php
namespace example;
error_reporting(E_ALL);
require __DIR__ . '/../vendor/autoload.php';
require_once __DIR__ . '/CalcService.php';
require_once __DIR__ . '/Types.php';
use Thrift\ClassLoader\ThriftClassLoader;
$loader = new ThriftClassLoader();
$loader->registerNamespace('Thrift', __DIR__ . '/../thrift/lib/php/lib');
$loader->register();
use Thrift\Protocol\TBinaryProtocol;
use Thrift\Transport\THttpClient;
use Thrift\Transport\TBufferedTransport;
use Thrift\Exception\TException;
try {
$socket = new THttpClient('localhost', 8080, '/php/PhpServer');
$transport = new TBufferedTransport($socket, 1024, 1024);
$protocol = new TBinaryProtocol($transport);
/**
* @var CalcServiceIf
*/
$client = new CalcServiceClient($protocol);
$transport->open();
$sum = $client->sum(1, 2);
var_dump($sum);
$transport->close();
echo '<br /> DONE <br />';
} catch (TException $tx) {
print 'TException: ' . $tx->getMessage() . "\n";
}
執行客戶端
執行客戶端程式碼,請求服務。
在PhpStorm中執行PhpClient.php檔案,會自動開啟預設瀏覽器,通過瀏覽器執行POST請求,將請求傳送到nginx。
列印輸出如下:
object(example\Result)#9 (3) {
["code"]=> int(0)
["message"]=> string(7) "success"
["data"]=> object(example\Data)#10 (3) {
["data_one"]=> int(1)
["data_two"]=> int(2)
["sum"]=> int(3)
}
}可以看到返回的資料結構和我們的thrift檔案中定義的資料結構是一模一樣的。
遠端部署與訪問
上面的服務端程式碼和客戶端程式碼可以部署到不通的主機上,實現遠端呼叫。而且,客戶端程式碼可以有多種實現方式,比如JAVA,Python等。
問題
- 多個客戶端如何保證服務端解析程式碼的一致性呢?
- 服務端程式碼和客戶端程式碼該如何在應用中管理呢?
等等一致性問題都可以通過composer來管理。