Thrift使用-php

简介

Thrift是一个跨语言的服务部署框架，最初由Facebook于2007年开发，2008年进入Apache开源项目。Thrift通过一个中间语言(IDL, 接口定义语言)来定义RPC的接口和数据类型，然后通过一个编译器生成不同语言的代码（目前支持C++,Java, Python, PHP, Ruby, Erlang, Perl, Haskell, C#, Cocoa, Smalltalk和OCaml）,并由生成的代码负责RPC协议层和传输层的实现。

支持的数据传输格式、数据传输方式和服务模型

支持的传输格式

TBinaryProtocol – 二进制格式.
TCompactProtocol – 压缩格式
TJSONProtocol – JSON格式
TSimpleJSONProtocol –提供JSON只写协议, 生成的文件很容易通过脚本语言解析。
TDebugProtocol – 使用易懂的可读的文本格式，以便于debug

支持的数据传输方式

TSocket -阻塞式socker
TFramedTransport – 以frame为单位进行传输，非阻塞式服务中使用。
TFileTransport – 以文件形式进行传输。
TMemoryTransport – 将内存用于I/O. java实现时内部实际使用了简单的ByteArrayOutputStream。
TZlibTransport – 使用zlib进行压缩， 与其他传输方式联合使用。当前无java实现。

支持的服务模型

TSimpleServer – 简单的单线程服务模型，常用于测试
TThreadPoolServer – 多线程服务模型，使用标准的阻塞式IO。
TNonblockingServer – 多线程服务模型，使用非阻塞式IO（需使用TFramedTransport数据传输方式）

使用方法

Thrift实际上是实现了C/S模式，通过代码生成工具将接口定义文件生成服务器端和客户端代码（可以为不同语言），从而实现服务端和客户端跨语言的支持。用户在Thirft描述文件中声明自己的服务，这些服务经过编译后会生成相应语言的代码文件，然后用户实现服务（客户端调用服务，服务器端提服务）便可以了。

编写thrift接口文件

首先根据thrift的 IDL语言进行编写接口文件，文件后缀为thrift。例如：

//HelloWorld.thrift
namespace php Services.HelloWorld service HelloWorld {
    string sayHello(1:string name);
}

生成依赖文件

生成Client和Server端的依赖文件。生成方法

thrift --gen php HelloWorld.thrift   //生成Client依赖文件 
thrift --gen php:server HelloWorld.thrift //生成Server依赖文件
//如果HelloWorld还包含其他××.thrift文件，需要加上参数-r

可以看到出现一个gen-php文件夹，其中的文件为对应依赖的文件。
客户端与服务端生成的依赖文件不同之处是，Server对应的文件中包含××Processor类。

class CalculatorProcessor extends \shared\SharedServiceProces {
    public ......
    public ......
}

编写Client和Server文件

服务端编码基本步骤

实现服务处理接口impl
创建TProcessor
创建TServerTransport
创建TProtocol
创建TServer
启动Server

Server代码
#!/usr/bin/env php
<?php

namespace Services\HelloWorld;

error_reporting(E_ALL);

require_once __DIR__.'/../lib/php/lib/Thrift/ClassLoader/ThriftClassLoader.php';

use Thrift\ClassLoader\ThriftClassLoader;

$GEN_DIR = realpath(dirname(__FILE__).'/..').'/gen-php';

$loader = new ThriftClassLoader();
$loader->registerNamespace('Thrift', __DIR__ . '/../lib/php/lib');
$loader->registerDefinition('Services', $GEN_DIR);
$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 HelloWorldHandler implements \Services\HelloWorld\HelloWorldIf {
    public function sayhello($name) {
        return 'server return: '.$name;
    }
}

header('Content-Type', 'application/x-thrift');
if (php_sapi_name() == 'cli') {
  echo "cli\r\n";
}

$handler = new HelloWorldHandler();
$processor = new HelloWorldProcessor($handler); //创建TProcessor

//创建TServerTransport 选择传输类型，socket
$transport = new TBufferedTransport(new TPhpStream(TPhpStream::MODE_R | TPhpStream::MODE_W));
//创建TProtocol 选择数据传输方式，二进制
$protocol = new TBinaryProtocol($transport, true, true);

$transport->open();
//创建TServer 启动Server
$processor->process($protocol, $protocol);
$transport->close();

客户端编码基本步骤

创建Transport
创建TProtocol
基于TTransport和TProtocol创建 Client
调用Client的相应方法

Client代码 #!/usr/bin/env php <?php namespace Services\HelloWorld; error_reporting(E_ALL); require_once __DIR__.'/../lib/php/lib/Thrift/ClassLoader/ThriftClassLoader.php'; use Thrift\ClassLoader\ThriftClassLoader; $GEN_DIR = realpath(dirname(__FILE__).'/..').'/gen-php'; $loader = new ThriftClassLoader(); $loader->registerNamespace('Thrift', __DIR__ . '/../lib/php/lib'); $loader->registerDefinition('Services', $GEN_DIR); $loader->register(); use Thrift\Protocol\TBinaryProtocol; use Thrift\Transport\TSocket; use Thrift\Transport\THttpClient; use Thrift\Transport\TBufferedTransport; use Thrift\Exception\TException; try { if (array_search('--http', $argv)) { //域名，端口，文件 $socket = new THttpClient('thrift.test.com', 80, '/HelloServer.php'); } else { $socket = new TSocket('localhost', 9090); } //创建Transport $transport = new TBufferedTransport($socket, 1024, 1024); //创建TProtocol $protocol = new TBinaryProtocol($transport); 基于TTransport和TProtocol创建 Client $client = new HelloWorldClient($protocol); $transport->open(); $name = 'jason'; //调用Client的相应方法 $ret = $client->sayhello( $name ); var_dump($ret); $transport->close(); } catch (TException $tx) { print 'TException: '.$tx->getMessage()."\n"; } a ?>