Thrift PHP 示例

2023年7月9日 351次阅读 来源: zshanjun

Apache Thrift是一个跨语言的服务部署框架，通过一个中间语言(IDL, 接口定义语言)来定义RPC的接口和数据类型，然后通过一个编译器生成不同语言的代码（支持C++，Java，Python，PHP, GO，Javascript，Ruby，Erlang，Perl， Haskell， C#等）,并由生成的代码负责RPC协议层和传输层的实现。

Thrift的PHP类库位于thrift/lib/php/lib/Thrift目录下面（这里就是下面代码中定义的THRIFT_ROOT路径），Thrift对于数据传输格式、数据传输方式，服务器模型均做了定义，方便自行扩展。

数据传输格式（protocol）是定义的了传输内容，对Thrift Type的打包解包，包括

  • TBinaryProtocol，二进制格式，TBinaryProtocolAccelerated则是依赖于thrift_protocol扩展的快速打包解包。
  • TCompactProtocol，压缩格式
  • TJSONProtocol，JSON格式
  • TMultiplexedProtocol，利用前三种数据格式与支持多路复用协议的服务端（同时提供多个服务，TMultiplexedProcessor）交互

数据传输方式（transport），定义了如何发送（write）和接收（read）数据，包括

  • TBufferedTransport，缓存传输，写入数据并不立即开始传输，直到刷新缓存。
  • TSocket，使用socket传输
  • TFramedTransport，采用分块方式进行传输，具体传输实现依赖其他传输方式，比如TSocket
  • TCurlClient，使用curl与服务端交互
  • THttpClient，采用stream方式与HTTP服务端交互
  • TMemoryBuffer，使用内存方式交换数据
  • TPhpStream，使用PHP标准输入输出流进行传输
  • TNullTransport，关闭数据传输
  • TSocketPool在TSocket基础支持多个服务端管理（需要APC支持），自动剔除无效的服务器
  • TNonblockingSocket，非官方实现非阻塞socket

服务模型，定义了当PHP作为服务端如何监听端口处理请求

  • TForkingServer，采用子进程处理请求
  • TSimpleServer，在TServerSocket基础上处理请求
  • TNonblockingServer，基于libevent的非官方实现非阻塞服务端，与TNonblockingServerSocket，TNonblockingSocket配合使用

另外还定义了一些工厂，以便在Server模式下对数据传输格式和传输方式进行绑定

  • TProtocolFactory，数据传输格式工厂类，对protocol的工厂化生产，包括TBinaryProtocolFactory，TCompactProtocolFactory，TJSONProtocolFactory
  • TTransportFactory，数据传输方式工厂类，对transport的工厂化生产，作为server时，需要自行实现
  • TStringFuncFactory，字符串处理工厂类

其他文件便是异常，字符串处理，自动加载器的定义等等。

现在开始编写一个简单接IDL文件HelloWorld.thrift

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

然后通过生成器生成PHP文件

thrift --gen php:server HelloWorld.thrift（不指明:server不生成processor）
生成文件在gen-php目录下面的Services/HelloWord/HelloWorld.php（目录与namesapce定义一致），这是个公共文件，服务端和客户端都需要包括它。

而服务端的服务实现代码则需要继承HelloWorldIf 实现代码HelloWorldHandler.php

<?php
namespace Services\HelloWorld;
 
class HelloWorldHandler implements HelloWorldIf {
  public function sayHello($name)
  {
      return "Hello $name";
  }
}

编写服务端代码Server.php

<?php
namespace Services\HelloWorld;

error_reporting(E_ALL);

define("THRIFT_ROOT", "/root/thrift/lib/php/lib/");
define("ROOT", "/root/zshanjun/thrift_scripts/");
require_once THRIFT_ROOT . "Thrift/ClassLoader/ThriftClassLoader.php";

use Thrift\ClassLoader\ThriftClassLoader;

$loader = new ThriftClassLoader();
$loader->registerNamespace('Thrift', THRIFT_ROOT);
$loader->registerDefinition('Service', ROOT . 'hello/gen-php');
$loader->register();

use Thrift\Exception\TException;
use Thrift\Factory\TTransportFactory;
use Thrift\Factory\TBinaryProtocolFactory;
 
use Thrift\Server\TServerSocket;
use Thrift\Server\TSimpleServer;

try {
    require_once 'HelloWorldHandler.php';
    $handler = new \Services\HelloWorld\HelloWorldHandler();
    $processor = new \Services\HelloWorld\HelloWorldProcessor($handler);
     
    $transportFactory = new TTransportFactory(); 
    $protocolFactory = new TBinaryProtocolFactory(true, true);
     
    //作为cli方式运行，监听端口，官方实现
    $transport = new TServerSocket('localhost', 9090);
    $server = new TSimpleServer($processor, $transport, $transportFactory, $transportFactory, $protocolFactory, $protocolFactory);
    $server->serve();
} catch (TException $tx) {
    print 'TException: '.$tx->getMessage()."\n";
}

服务端创建的步骤：

  • 首先初始化服务提供者handler
  • 然后利用该handler初始化自动生成的processor
  • 初始化数据传输方式transport
  • 利用该传输方式初始化数据传输格式protocol
  • 开始服务

编写客户端代码Client.php


<?php
namespace Services\HelloWorld;

error_reporting(E_ALL);

define('THRIFT_ROOT', '/root/thrift/lib/php/lib/');
define('ROOT', '/root/zshanjun/thrift_scripts/');
require_once THRIFT_ROOT . 'Thrift/ClassLoader/ThriftClassLoader.php';

use Thrift\ClassLoader\ThriftClassLoader;

$loader = new ThriftClassLoader();
$loader->registerNamespace('Thrift', THRIFT_ROOT);
$loader->registerDefinition('Service', ROOT . 'hello/gen-php');
$loader->register();

use Thrift\Protocol\TBinaryProtocol;
use Thrift\Transport\TSocket;
use Thrift\Transport\TBufferedTransport;
use Thrift\Exception\TException;
 
try {
    //仅在与服务端处于同一输出输出流有用
    //使用方式：php Client.php | php Server.php 
    //$transport = new TBufferedTransport(new TPhpStream(TPhpStream::MODE_R | TPhpStream::MODE_W));
     
    //socket方式连接服务端
    //数据传输格式和数据传输方式与服务端一一对应
    //如果服务端以http方式提供服务，可以使用THttpClient/TCurlClient数据传输方式
    $transport = new TBufferedTransport(new TSocket('localhost', 9090));
    $protocol = new TBinaryProtocol($transport);
    $client = new \Services\HelloWorld\HelloWorldClient($protocol);

    $transport->open();

    //同步方式进行交互
    $recv = $client->sayHello('Courages');
    echo "\n sayHello11dd:".$recv." \n";

    //异步方式进行交互
    $client->send_sayHello('Us');
    echo "\n send_sayHello \n";
    $recv = $client->recv_sayHello();
    echo "\n recv_sayHello:".$recv." \n";

    $transport->close();
} catch (TException $tx) {
    print 'TException: '.$tx->getMessage()."\n";
}

客户端调用的步骤：

  • 初始化数据传输方式transport，与服务端对应
  • 利用该传输方式初始化数据传输格式protocol，与服务端对应
  • 实例化自动生成的Client对象
  • 开始调用

在终端上运行

php Server.php
 
#在另外一个终端运行
php Client.ph

----
输出：


 sayHello11dd:Hello Courages 

 send_sayHello 

 recv_sayHello:Hello Us

参考网站：

    原文作者：zshanjun
    原文地址: https://www.jianshu.com/p/2532056dd494
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞