Guzzle HTTP 客户端

hyperf/guzzle 组件基于 Guzzle 进行协程处理，通过 Swoole HTTP 客户端作为协程驱动替换到 Guzzle 内，以达到 HTTP 客户端的协程化。

安装

  1. composer require hyperf/guzzle

使用

只需要该组件内的 Hyperf\Guzzle\CoroutineHandler 作为处理器设置到 Guzzle 客户端内即可转为协程化运行，为了方便创建协程的 Guzzle 对象，我们提供了一个工厂类 Hyperf\Guzzle\ClientFactory 来便捷的创建客户端，代码示例如下：

  1. <?php 
  2. use Hyperf\Guzzle\ClientFactory;
  4. class Foo {
  5.     /**
  6.      * @var \Hyperf\Guzzle\ClientFactory
  7.      */
  8.     private $clientFactory;
  10.     public function __construct(ClientFactory $clientFactory)
  11.     {
  12.         $this->clientFactory = $clientFactory;
  13.     }
  15.     public function bar()
  16.     {
  17.         // $options 等同于 GuzzleHttp\Client 构造函数的 $config 参数
  18.         $options = [];
  19.         // $client 为协程化的 GuzzleHttp\Client 对象
  20.         $client = $this->clientFactory->create($options);
  21.     }
  22. }

使用Swoole配置

有时候我们想直接修改 Swoole 配置，所以我们也提供了相关配置项，不过这项配置在 Curl Guzzle 客户端 中是无法生效的，所以谨慎使用。

这项配置会替换原来的配置，比如以下 timeout 会被 10 替换。

  1. <?php
  2. use GuzzleHttp\Client;
  3. use Hyperf\Guzzle\CoroutineHandler;
  4. use GuzzleHttp\HandlerStack;
  6. $client = new Client([
  7.     'base_uri' => 'http://127.0.0.1:8080',
  8.     'handler' => HandlerStack::create(new CoroutineHandler()),
  9.     'timeout' => 5,
  10.     'swoole' => [
  11.         'timeout' => 10,
  12.         'socket_buffer_size' => 1024 * 1024 * 2,
  13.     ],
  14. ]);
  16. $response = $client->get('/');

连接池

Hyperf 除了实现了 Hyperf\Guzzle\CoroutineHandler 外，还基于 Hyperf\Pool\SimplePool 实现了 Hyperf\Guzzle\PoolHandler。

原因

简单来说，主机 TCP连接数 是有上限的，当我们并发大到超过这个上限值时，就导致请求无法正常建立。另外，TCP连接结束后还会有一个 TIME-WAIT 阶段，所以也无法实时释放连接。这就导致了实际并发可能远低于 TCP 上限值。所以，我们需要一个连接池来维持这个阶段，尽量减少 TIME-WAIT 造成的影响，让TCP连接进行复用。

使用

<?php
use GuzzleHttp\Client;
use Hyperf\Utils\Coroutine;
use GuzzleHttp\HandlerStack;
use Hyperf\Guzzle\PoolHandler;
use Hyperf\Guzzle\RetryMiddleware;

$handler = null;
if (Coroutine::inCoroutine()) {
    $handler = make(PoolHandler::class, [
        'option' => [
            'max_connections' => 50,
        ],
    ]);
}

// 默认的重试Middleware
$retry = make(RetryMiddleware::class, [
    'retries' => 1,
    'delay' => 10,
]);

$stack = HandlerStack::create($handler);
$stack->push($retry->getMiddleware(), 'retry');

$client = make(Client::class, [
    'config' => [
        'handler' => $stack,
    ],
]);

另外，框架还提供了 HandlerStackFactory 来方便创建上述的 $stack。

<?php
use Hyperf\Guzzle\HandlerStackFactory;
use GuzzleHttp\Client;

$factory = new HandlerStackFactory();
$stack = $factory->create();

$client = make(Client::class, [
    'config' => [
        'handler' => $stack,
    ],
]);