HTTP 客户端

框架提供统一抽象的 HttpClient 来实现 HTTP 调用,客户端会自动根据当前环境在协程异步客户端驱动同步阻塞客户端驱动中作出选择

安装

通过 Composer 安装 swoft/http-client 组件
在项目 composer.json 所在目录执行 composer require swoft/http-client 即可

依赖

  1. PHP 7.0 +
  2. Swoft Framework 1.0 beta +
  3. Swoole 2.0.11 +
  4. cURL 扩展 (用于同步阻塞的请求,在非协程环境下会自动退化为 cURL 驱动)

贡献组件代码

  1. HttpClient 使用 PSR-1, PSR-2, PSR-4 和 PSR-7 标准;
  2. HttpClient 应该是精简和快速的,并且尽可能的减少依赖,这意味着并不是每个 Pull Request 都会被接受;
  3. HttpClient 有 PHP 7.0 的最低版本限制,除非有条件地使用该特性,否则 Pull Request 不允许有比 PHP 7.0 更大的PHP版本的语言特性;
  4. HttpClient 将以协程客户端为主,仅在非协程环境下才去使用其它驱动,若存在协程客户端暂时无法实现的特性,必须存在条件让用户来启用;
  5. 所有的 Pull Request 都必须包含相对于的单元测试,以确保更改能够正常工作。

运行测试

HttpClient 使用 PHPUnit 来作为单元测试的支持,可以直接使用 PHPUnit 本身的命令来运行测试,或使用组件提供的 Composer 命令来执行

通过 Composer 命令运行测试

composer test

通过 PHPUnit 命令运行测试

./vendor/bin/phpunit -c phpunit.xml

使用 HTTP 客户端

创建一个请求

use Swoft\HttpClient\Client;

$client = new Client([
    // 基础的 URI,将用于此对象后续发起的请求
    'base_uri' => 'http://www.swoft.org',
    // 请求的默认超时时间
    'timeout' => 2,
]);

Client 的构造方法接受一个 Options 数组,用于配置客户端,以为为各个参数的说明。

base_uri ( string | UriInterface ) 基础的 URI,将用户后续的请求,将与 request($uri) 的 $uri 合并成一个完整的 URI

timeout ( int | float ) 设置请求的超时时间,单位为秒

adapter ( string ) 设置指定的客户端适配器,可选参数包括 co, curlco 指使用 Swoole 提供的协程 HTTP 客户端作为驱动,curl 指使用 CURL扩展 作为驱动

发送一个请求

use Swoft\HttpClient\Client;

$client = new Client();
$response = $client->get('http://www.swoft.org')->getResponse();
$response = $client->post('http://www.swoft.org')->getResponse();
$response = $client->head('http://www.swoft.org')->getResponse();
$response = $client->options('http://www.swoft.org')->getResponse();
$response = $client->patch('http://www.swoft.org')->getResponse();
$response = $client->put('http://www.swoft.org')->getResponse();
$response = $client->delete('http://www.swoft.org')->getResponse();

所有请求都基于 request(string $method, string|UriInterface $uri, array $options) 方法,如有非预置自定义方法请求,可以使用此方法自行构造

$method = 'GET';
/** @var Response $response */
$response = $client->request($method, '/', [
    'base_uri' => 'http://www.swoft.org',
])->getResponse();

并发请求

注意并发请求仅作用于co适配器下,若在curl驱动下此操作会退化为同步阻塞操作

$request1 = $client->get('http://www.swoft.org');
$request2 = $client->get('http://www.swoft.org');
$request3 = $client->get('http://www.swoft.org');

$response1 = $request1->getResponse();
$response2 = $request2->getResponse();
$response3 = $request3->getResponse();

HttpResult 对象

\Swoft\HttpClient\HttpResult 为请求后的返回结果,该结果不是请求返回的内容,注意调用后需统一调用 getResponse()getResult() 方法获取Response 对象,框架将默认定义为延迟收包,调用这一方法才进行收包处理,当在协程驱动下,可实现 defer 特性和并发调用具体可参考 Swoole 关于并发操作的说明 https://wiki.swoole.com/wiki/page/p-coroutine_multi_call.html
这里需要注意的是 getResponse()getResult() 的返回值是不一样的,getResponse() 返回的是一个Response 对象,而 getResult() 返回的则是 Response 对象的 Content 属性,是一个字符串类型

Response 对象

\Swoft\Core\Response 基于 PSR-7 实现,继承于 Psr\Http\Message\ResponseInterface,使用方法在此不做过多的阐述,可直接参考相关规范

Raw 请求

通过对 Options 设置 body 参数设置发送请求的 Body,此参数仅允许字符串格式

/** @var Response $response */
$response = $client->post('/', [
    'base_uri' => 'http://www.swoft.org',
    'body' => 'value',
])->getResponse();

Form 请求

在表单提交下我们提供了form_params参数,该参数会自动在Header带上application/x-www-form-urlencodedContent-Type

/** @var Response $response */
$response = $client->post('/', [
    'base_uri' => 'http://www.swoft.org',
    'form_params' => [
        'key' => 'value',
    ],
])->getResponse();

Json 请求

在表单提交下我们提供了json参数,该参数会自动在Header带上application/jsonContent-Type,并格式化数组为json结构

/** @var Response $response */
$response = $client->post('/', [
    'base_uri' => 'http://www.swoft.org',
    'json' => [
        'key' => 'value',
    ],
])->getResponse();

请求参数

你可以在实例化 Client 时往 $options 参数传递该客户端的配置,比如根域名,超时时间等配置,在实例化时设置的参数将会被后续请求继承

timeout

概述:请求超时时间
类型:int
默认值:无

上一页
下一页