Guzzle原理解析

一、背景

在PHP后台开发过程中,经常会遇到模块间需要通过HTTP通信的情形。PHP语言本身只提供了socket操作的接口,并未提供HTTP相关操作的接口。许多现有的实现采用curl扩展充当HTTP Client与HTTP Server通信,但仍需自己封装curl的接口。有鉴于此,本文介绍一款流行的PHP HTTP Client客户端—Guzzle(https://github.com/guzzle/guzzle/)的用法,深入分析其底层实现原理。

二、Guzzle用法

例如使用Guzzle访问http://www.baidu.com的代码:

1
2
3
4
5
6
7
8
9
1. <?php
2.
3. $client = new \GuzzleHttp\Client();
4. $response = $client->request('GET', 'http://www.baidu.com', [
5. "timeout" => 3000
6. ]);
7.
8. echo $response->getStatusCode(), "\n";
9. echo $response->getBody();

接口封装是不是十分简单?只需要关心请求方法,目标url和请求的选项即可快速上手。同时,Guzzle还支持异步请求方式:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
1. <?php
2.
3. use GuzzleHttp\Exception\RequestException;
4. use Psr\Http\Message\ResponseInterface;
5.
6. $client = new \GuzzleHttp\Client();
7. $promise = $client->requestAsync('GET', 'http://www.baidu.com');
8. $promise->then(
9. function (ResponseInterface $res) {
10. echo $res->getStatusCode() . "\n";
11. echo $res->getBody();
12. return $res;
13. },
14. function (RequestException $e) {
15. echo $e->getMessage() . "\n";
16. echo $e->getRequest()->getMethod();
17. }
18. )->wait();

基于异步请求,Guzzle还实现了并发请求,关于Guzzle的具体使用方法可以参考其中文文档http://guzzle-cn.readthedocs.io/zh_CN/latest/index.html

三、Guzzle实现原理

1.client构造

GuzzleHttp\Client类构造函数声明为:

1
public function __construct(array $config = [])

$config配置使得用户可以根据需要配置一切可以配置的选项,包括allow_redirects、auth、connect_timeout、proxy等。除此之外,还可以自定义请求的处理函数handler,方便应用程序扩展,handler接口规范为:

1
function handler($request, array $options);

处理成功时,接口返回Psr\Http\Message\ResponseInterface;失败时返回GuzzleHttp\Exception\RequestException异常。 默认情形下,GuzzleHttp\HandlerStack::create会创建请求处理函数

1
2
3
4
5
6
7
8
9
10
1. public static function create(callable $handler = null)
2. {
3. $stack = new self($handler ?: choose_handler());
4. $stack->push(Middleware::httpErrors(), 'http_errors');
5. $stack->push(Middleware::redirect(), 'allow_redirects');
6. $stack->push(Middleware::cookies(), 'cookies');
7. $stack->push(Middleware::prepareBody(), 'prepare_body');
8.
9. return $stack;
10. }

create函数以堆栈的形式创建了一系列的处理函数,包括http异常、重定向、cookie和prepare_body。处理函数返回的函数闭包为:

1
2
3
4
5
1. return function (callable $handler) {
2. return function ($request, array $options) use ($handler) {
3. ...
4. };
5. };

函数入参为handler,返回一个新的handler,这样可以将所有的处理函数链接在一起,最终生成一个符合handler接口规范的函数. choose_handler函数选择stack中的起始handler,选择策略为:

  • 扩展自带curl_multi_exec和curl_exec函数则根据$options中的synchronous选项决定,empty(synchronous)为false则使用CurlHandler,否则使用CurlMultiHandler

  • 扩展只有curl_exec函数则使用CurlHandler

  • 扩展只有curl_multi_exec函数则使用CurlMultiHandler

最后,如果php.ini中开启了allow_url_fopen,则根据$options中的stream选项决定,empty(stream)为false则使用StreamHandler。

2.client调用request方法

request方法实现为:

1
2
3
4
5
1. public function request($method, $uri = '', array $options = [])
2. {
3. $options[RequestOptions::SYNCHRONOUS] = true;
4. return $this->requestAsync($method, $uri, $options)->wait();
5. }

由此可见,request事实上是采用了requestAsync异步方法+wait来完成的,也就是异步转同步。 2.1 requestAsync requestAsync将请求信息包装成Psr7\Request对象,然后调用

1
transfer(RequestInterface $request, array $options)

transfer函数最终返回Promise\promise_for($handler($request, $options)); 其中$handler即为构造函数中所设置的stack,stack中存放一系列的请求处理函数。 HandlerStack的处理函数为:

1
2
3
4
5
6
1. public function __invoke(RequestInterface $request, array $options)
2. {
3. $handler = $this->resolve();
4.
5. return $handler($request, $options);
6. }

resolve方法解析整个stack,返回一个包装后的handler,包装策略为按照出栈顺序包装,也就是

1
2
3
1. foreach (array_reverse($this->stack) as $fn) {
2. $prev = $fn[0]($prev);
3. }

典型的中间件模型,所有的处理函数串接在一起了。请求经由http_errors、allow_redirects等处理之后到达Curl,执行真正的网络交互。

  • 对于同步的handler如CurlHandler,在此处会执行curl_exec发起请求,最终返回的是FulfilledPromise对象或RejectedPromise对象,代表请求已经处理完毕。

  • 对于异步的handler比如CurlMultiHandler,在此处并不会执行curl_multi_exec,而是返回一个promise对象,里面注册了需要等待执行的curl_multi_exec。

Curl Handler处理完成之后,往上回溯,在Allow_redirects和Http_errors部分会进入then方法,最终返回的结果都是promise对象。 2.2 wait 请求发送完毕,进入promise的wait操作,最终会执行promise的$waitFn函数。

  • 对于CurlMultiHandler,$waitFn即执行curl__multi__exec进行网络交互,然后调用resolve方法将response对象传递到then方法的$onFulfilled函数。

  • 对于CurlHandler,直接利用resolve将response对象传递到$onFulfilled函数。

这样,异步的then方法设置的回调就可以接收到response了。 then方法最终返回response,这个对象又可以作为返回值返回,这样同步的wait就可以通过返回值来获取response对象了。

四、总结

本文重点介绍了Guzzle同步和异步请求的实现原理,除此之外,Guzzle还提供了并行请求,请求pool等实现,读者可以在此基础上继续深入。

有用就打赏一下作者吧!