PHP使用Guzzle发起的异步请求示例详解

目录

• Guzzle中的异步请求
• 使用Guzzle发起异步请求
• PHP发起HTTP请求的几种方式
• curl
• stream
• 什么是URI？URI的组成
• 请求的组装
• 请求的发起
• 同步调用与异步调用
• wait的实现
• waitFn是什么
• queue() 是的入队时机

Guzzle中的异步请求

使用Guzzle发起异步请求

Guzzle是一个PHP的HTTP客户端，它在发起http请求时不仅可以同步发起，还可以异步发起。

$client = new Client();
$request = new Request(\’GET\’, \’http://www.baidu.com\’);
$promise = $client->sendAsync($request)->then(function ($response) {
echo $response->getBody();
});
// todo something
echo 1;
$promise->wait();

PHP发起HTTP请求的几种方式

curl

使用libcurl库，允许你与各种的服务器使用各种类型的协议进行连接和通讯。

stream

通过流的方式获取和发送远程文件，该功能需要ini配置allow_url_fopen=on。关于php的流更多参考PHP流（Stream）的概述与使用详解

在guzzle中可以兼容使用这两种的任意一种或者是用户自定义的http handler

function choose_handler()
{
$handler = null;
if (function_exists(\’curl_multi_exec\’) && function_exists(\’curl_exec\’)) {
$handler = Proxy::wrapSync(new CurlMultiHandler(), new CurlHandler());
} elseif (function_exists(\’curl_exec\’)) {
$handler = new CurlHandler();
} elseif (function_exists(\’curl_multi_exec\’)) {
$handler = new CurlMultiHandler();
}
if (ini_get(\’allow_url_fopen\’)) {
$handler = $handler
? Proxy::wrapStreaming($handler, new StreamHandler())
: new StreamHandler();
} elseif (!$handler) {
throw new \\RuntimeException(\’GuzzleHttp requires cURL, the \’
. \’allow_url_fopen ini setting, or a custom HTTP handler.\’);
}
return $handler;
}

可以看出，guzzle会优先使用curl，然后选择使用stream，Proxy::wrapStreaming($handler, new StreamHandler())是一个流包装器。

public static function wrapStreaming(
callable $default,
callable $streaming
) {
return function (RequestInterface $request, array $options) use ($default, $streaming) {
return empty($options[\’stream\’])
? $default($request, $options)
: $streaming($request, $options);
};
}

什么是URI？URI的组成

URI，Uniform Resource Identifier，统一资源标识符。

scheme:[//[user:password@]host[:port]][/]path[?query][#fragment]

请求的组装

Guzzle发起请求大致分为两个阶段，第一阶段负责将需要请求的uri组装成各种内部定义的类。

• Client类：这是一个发起客户端的调用者，后续所有的调用需要基于这个负责的类实现，它负责提供一个 handler ,这是一个客户端发起http请求的句柄，其中Guzzle实现curl和stream调用的无感知就是在这里实现的，同时开发者也可以自定义请求协议。

// 根据系统当前状态，选择一个发起Http请求的协议的方法句柄
function choose_handler()
{
$handler = null;
if (function_exists(\’curl_multi_exec\’) && function_exists(\’curl_exec\’)) {
$handler = Proxy::wrapSync(new CurlMultiHandler(), new CurlHandler());
} elseif (function_exists(\’curl_exec\’)) {
$handler = new CurlHandler();
} elseif (function_exists(\’curl_multi_exec\’)) {
$handler = new CurlMultiHandler();
}
if (ini_get(\’allow_url_fopen\’)) {
$handler = $handler
? Proxy::wrapStreaming($handler, new StreamHandler())
: new StreamHandler();
} elseif (!$handler) {
throw new \\RuntimeException(\’GuzzleHttp requires cURL, the \’
. \’allow_url_fopen ini setting, or a custom HTTP handler.\’);
}
return $handler;
}

• Request类：负责定义一个uri
• Promise类：这个类负责承载类请求发起前的各种准备工作完成后的结果，还包括两个回调（请求成功回调、请求失败回调）,同时请求发起中的队列，延迟等处理也是在这个类里。

其中组装阶段最重要的方法是私有方法private function transfer(RequestInterface $request, array $options)，它负责将用户通过各种方法传入的uri和client类的各种属性组合，然后使用这些属性生成一个新的类 Promise 类。

请求的发起

Client的各种属性组装完成后就可以使用得到的Promise类发起http请求了，这里主要是通过一个 wait() 方法。

同步调用与异步调用

在同步方法内部的调用，同步方法是在内部组装好一个Promise之后立刻发起wait()调用。

public function send(RequestInterface $request, array $options = [])
{
$options[RequestOptions::SYNCHRONOUS] = true;
return $this->sendAsync($request, $options)->wait();
}

wait的实现

wait() 方法的实现逻辑也很简单，递归调用wait()方法，直到result属性不是PromiseInterface实现类或者state不是pending，然后将结果逐层输出。这里说一下这个state的pending状态，这是一个PromiseInterface实现类的初始化状态，表示改实现类还没有完成，需要继续wait。

public function wait($unwrap = true)
{
$this->waitIfPending();
$inner = $this->result instanceof PromiseInterface
? $this->result->wait($unwrap)
: $this->result;
if ($unwrap) {
if ($this->result instanceof PromiseInterface
|| $this->state === self::FULFILLED
) {
return $inner;
} else {
// It\’s rejected so \”unwrap\” and throw an exception.
throw exception_for($inner);
}
}
}

waitIfPending() ： 如果promise类还处于pending状态就执行。主要是执行改实现类的waitFn方法。最外层promise执行完成后执行queue()->run()“这个方法内部循环执行队列内方法，直到队列为空。至此，Guzzle就能将组装进来的多个request，和各种方法执行完毕。

private function waitIfPending()
{
if ($this->state !== self::PENDING) {
return;
} elseif ($this->waitFn) {
$this->invokeWaitFn();
} elseif ($this->waitList) {
$this->invokeWaitList();
} else {
// If there\’s not wait function, then reject the promise.
$this->reject(\’Cannot wait on a promise that has \’
. \’no internal wait function. You must provide a wait \’
. \’function when constructing the promise to be able to \’
. \’wait on a promise.\’);
}
queue()->run();
if ($this->state === self::PENDING) {
$this->reject(\’Invoking the wait callback did not resolve the promise\’);
}
}
public function run()
{
/** @var callable $task */
while ($task = array_shift($this->queue)) {
$task();
}
}

waitFn是什么

回到前面提到的transfer()函数。

$handler = $options[\’handler\’];
// 返回一个promise类，这个类有一个属性是waitFn
return Promise\\promise_for($handler($request, $options));

这里我们看 $handler 是什么？它是一个HandleStack类，就是我们在new Client时选择的发起Http请求的协议的方法句柄，实例化的类。<br />之后的调用依次是HandleStack->__invoke、RedirectMiddleware->__invoke、PrepareBodyMiddleware->__invoke。执行$fn($request, $options);方法，经过前面的逐层处理，此时的$fn就是HandleStack内部的Proxy包装的方法，无论使用哪种协议都会在各自的实现里实例化一个拥有waitFn的Promise的实例。

// curl的实现
$promise = new Promise(
[$this, \’execute\’],
function () use ($id) {
return $this->cancel($id);
}
);

由此可以直到waitFn方法就是各自协议的实现类的请求发起方法。then() 方法会将promise本身再封装一层promise，并将原先的waitFn和then()的回调方法打包进waitFnList属性里。

queue() 是的入队时机

当请求执行完成后依次调用 processMessages()、promise->resolve()、settle()、FulfilledPromise->then()，将请求结果插入队列。

$queue->add(static function () use ($p, $value, $onFulfilled) {
if ($p->getState() === self::PENDING) {
try {
$p->resolve($onFulfilled($value));
} catch (\\Throwable $e) {
$p->reject($e);
} catch (\\Exception $e) {
$p->reject($e);
}
}
});

以上就是PHP使用Guzzle发起的异步请求示例详解的详细内容，更多关于PHP Guzzle异步请求的资料请关注悠久资源网其它相关文章！

您可能感兴趣的文章:

• PHP的HTTP客户端Guzzle简单使用方法分析
• 在PHP中实现使用Guzzle执行POST和GET请求
• 在Laravel中使用GuzzleHttp调用第三方服务的API接口代码
• 使用Zttp简化Guzzle 调用