Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/Yurunsoft/YurunHttp

YurunHttp 是开源的 PHP HTTP 客户端,支持链式操作,简单易用。完美支持Curl、Swoole 协程。QQ群:17916227
https://github.com/Yurunsoft/YurunHttp

coroutine curl guzzle httpclient httplib php swoole swoole-http

Last synced: 25 days ago
JSON representation

YurunHttp 是开源的 PHP HTTP 客户端,支持链式操作,简单易用。完美支持Curl、Swoole 协程。QQ群:17916227

Lists

README

        

# YurunHttp

[![Latest Version](https://poser.pugx.org/yurunsoft/yurun-http/v/stable)](https://packagist.org/packages/yurunsoft/yurun-http)
![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/Yurunsoft/YurunHttp/ci.yml?branch=v5)
[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg)](https://secure.php.net/)
[![IMI Doc](https://img.shields.io/badge/docs-passing-green.svg)](http://doc.yurunsoft.com/YurunHttp)
[![IMI License](https://img.shields.io/github/license/Yurunsoft/YurunHttp.svg)](https://github.com/Yurunsoft/YurunHttp/blob/master/LICENSE)

## 简介

YurunHttp,支持智能识别 Curl/Swoole 场景的高性能 Http Client。

支持链式操作,简单易用。支持并发批量请求、HTTP2、WebSocket 全双工通信协议。

非常适合用于开发通用 SDK 包,不必再为 Swoole 协程兼容而头疼!

YurunHttp 的目标是做最好用的 PHP HTTP Client 开发包!

### 特性

* GET/POST/PUT/DELETE/UPDATE 等请求方式
* 浏览器级别 Cookies 管理
* 上传及下载
* 请求头和响应头
* 失败重试
* 自动重定向
* HTTP 代理方式请求
* SSL 证书(HTTPS)
* 并发批量请求
* HTTP2
* WebSocket
* Curl & Swoole 环境智能兼容
* 连接池

---

开发手册文档:

API 文档:[https://apidoc.gitee.com/yurunsoft/YurunHttp](https://apidoc.gitee.com/yurunsoft/YurunHttp)

欢迎各位加入技术支持群17916227[![点击加群](https://pub.idqqimg.com/wpa/images/group.png "点击加群")](https://jq.qq.com/?_wv=1027&k=5wXf4Zq),如有问题可以及时解答和修复。

更加欢迎各位来提交PR([码云](https://gitee.com/yurunsoft/YurunHttp)/[Github](https://github.com/Yurunsoft/YurunHttp)),一起完善YurunHttp,让它能够更加好用。

## 重大版本更新日志

> 每个小版本的更新日志请移步到 Release 查看

v5.0.1 支持 WebSocket 压缩及指定 Opcode

v5.0.0 支持 `psr/http-message` `~2.0` 版本 (PHP >= 7.1)

v4.3.0 新增支持连接池

v4.2.0 重构 Swoole 处理器,并发请求性能大幅提升 (PHP 版本依赖降为 >= 5.5)

v4.1.0 实现智能识别场景,自动选择适合 Curl/Swoole 环境的处理器

v4.0.0 新增支持 `Swoole` 并发批量请求 (PHP >= 7.1)

v3.5.0 新增支持 `Curl` 并发批量请求 (PHP >= 5.5)

v3.4.0 新增支持 `Http2` 全双工用法

v3.3.0 新增支持 `Http2` 兼容用法

v3.2.0 新增支持 `Swoole WebSocket` 客户端

v3.1.0 引入浏览器级别 `Cookies` 管理

v3.0.0 新增支持 `Swoole` 协程

v2.0.0 黑历史,不告诉你

v1.3.1 支持 `Composer`

v1.0-1.3 初期版本迭代

## Composer

本项目可以使用composer安装,遵循psr-4自动加载规则,在你的 `composer.json` 中加入下面的内容

```json
{
"require": {
"yurunsoft/yurun-http": "~5.0"
}
}
```

然后执行 `composer update` 安装。

之后你便可以使用 `include "vendor/autoload.php";` 来自动加载类。(ps:不要忘了namespace)

## 用法

更加详细的用法请看 `examples` 目录中的示例代码

### 简单调用

```php
header('aaa', 'value1')
->headers([
'bbb' => 'value2',
'ccc' => 'value3',
])
->rawHeader('ddd:value4')
->rawHeaders([
'eee:value5',
'fff:value6',
]);

// 请求
$response = $http->ua('YurunHttp')
->get('http://www.baidu.com');

echo 'html:', PHP_EOL, $response->body();
```

### 并发批量请求

```php
use \Yurun\Util\YurunHttp\Co\Batch;
use \Yurun\Util\HttpRequest;

$result = Batch::run([
(new HttpRequest)->url('https://www.imiphp.com'),
(new HttpRequest)->url('https://www.yurunsoft.com'),
]);

var_dump($result[0]->getHeaders(), strlen($result[0]->body()), $result[0]->getStatusCode());

var_dump($result[1]->getHeaders(), strlen($result[1]->body()), $result[1]->getStatusCode());
```

> 只有 Swoole 并发请求会受到连接池限制,Curl 不受影响

### Swoole 协程模式

```php
get('http://www.baidu.com');
echo 'html:', PHP_EOL, $response->body();
}
```

### 连接池

在 YurunHttp 中,连接池是全局的,默认不启用。

每个不同的 `host`、`port`、`ssl` 都在不同的连接池中,举个例子,下面两个 url 对应的连接池不是同一个:

`http://www.imiphp.com`(`host=www.imiphp.com, port=80, ssl=false`)

`https://www.imiphp.com`(`host=www.imiphp.com, port=443, ssl=true`)

**启用全局连接池:**

```php
\Yurun\Util\YurunHttp\ConnectionPool::enable();
```

**禁用全局连接池:**

```php
\Yurun\Util\YurunHttp\ConnectionPool::disable();
```

**写入连接池设置:**

```php
// 最大连接数=16个,连接数满等待超时时间(仅 Swoole 有效)=30s
// url 最后不要带斜杠 /
\Yurun\Util\YurunHttp\ConnectionPool::setConfig('https://imiphp.com', 16, 30);
```

> YurunHttp 不会限制未设置的域名的连接数

**特殊请求不启用连接池:**

```php
$http = new HttpRequest;
$http->connectionPool(false);
```

**获取连接池对象及数据:**

```php
use Yurun\Util\YurunHttp\Handler\Curl\CurlHttpConnectionManager;
use Yurun\Util\YurunHttp\Handler\Swoole\SwooleHttpConnectionManager;

// 获取 Curl 连接池管理器,选择你所处环境对应的类,其实一般 Curl 不太需要连接池
// $manager = CurlHttpConnectionManager::getInstance();

// 获取 Swoole 连接池管理器,选择你所处环境对应的类
$manager = SwooleHttpConnectionManager::getInstance();

// 获取连接池对象集合
$pool = $manager->getConnectionPool('https://imiphp.com');

// 获取连接总数
$pool->getCount();

// 获取空闲连接总数
$pool->getFree();

// 获取正在使用的连接总数
$pool->getUsed();

// 获取连接池配置
$config = $pool->getConfig();
```

### WebSocket Client

```php
go(function(){
$url = 'ws://127.0.0.1:1234/';
$http = new HttpRequest;
// 启用压缩
// $http->websocketCompression(true);
$client = $http->websocket($url);
if(!$client->isConnected())
{
throw new \RuntimeException('Connect failed');
}
// 文本
$client->send('data');
// 二进制
$client->send('data', \Yurun\Util\YurunHttp\WebSocket\Opcode::BINARY);
// 更多 Opcode 预定义在:\Yurun\Util\YurunHttp\WebSocket\Opcode
// 也支持 WebSocket 标准中的其它 Opcode
$recv = $client->recv();
var_dump('recv:', $recv);
$client->close();
});
```

### Http2 兼容用法

```php
$http = new HttpRequest;
$http->protocolVersion = '2.0'; // 这句是关键
$response = $http->get('https://wiki.swoole.com/');
```

Curl、Swoole Handler 都支持 Http2,但需要注意的是编译时都需要带上启用 Http2 的参数。

查看是否支持:

Curl: `php --ri curl`

Swoole: `php --ri swoole`

### Http2 全双工用法

> 该用法仅支持 Swoole

```php
$uri = new Uri('https://wiki.swoole.com/');

// 客户端初始化和连接
$client = new \Yurun\Util\YurunHttp\Http2\SwooleClient($uri->getHost(), Uri::getServerPort($uri), 'https' === $uri->getScheme());
$client->connect();

// 请求构建
$httpRequest = new HttpRequest;
$request = $httpRequest->header('aaa', 'bbb')->buildRequest($uri, [
'date' => $i,
], 'POST', 'json');

for($i = 0; $i < 10; ++$i)
{
go(function() use($client, $request){
// 发送(支持在多个协程执行)
$streamId = $client->send($request);
var_dump('send:' . $streamId);

// 接收(支持在多个协程执行)
$response = $client->recv($streamId, 3);
$content = $response->body();
var_dump($response);
});
}
```

> 具体用法请看 `examples/http2Client.php`

### PSR-7 请求构建

```php

## 商业合作

现在使用 Swoole 的项目越来越多,使用 YurunHttp 开发的代码,可以原生兼容 php-fpm 和 Swoole 两种环境。

YurunHttp 相比 Guzzle 性能更强,功能更加强大!

现承接使用 PHP 开发相关系统、SDK 等业务,有需要的请联系 QQ: 369124067

## 捐赠

开源不求盈利,多少都是心意,生活不易,随缘随缘……