workerman/http-client
説明
workerman/http-clientは非同期のHTTPクライアントコンポーネントです。すべてのリクエストレスポンスは非同期でブロッキングされず、内部接続プールがあり、メッセージリクエストとレスポンスはPSR7準拠です。
インストール:
composer require workerman/http-client
サンプル:
getとpostリクエストの使用法
use Workerman\Worker;
require_once __DIR__ . '/vendor/autoload.php';
$worker = new Worker();
$worker->onWorkerStart = function () {
$http = new Workerman\Http\Client();
$http->get('https://example.com/', function ($response) {
var_dump($response->getStatusCode());
echo $response->getBody();
}, function ($exception) {
echo $exception;
});
$http->post('https://example.com/', ['key1' => 'value1', 'key2' => 'value2'], function ($response) {
var_dump($response->getStatusCode());
echo $response->getBody();
}, function ($exception) {
echo $exception;
});
$http->request('https://example.com/', [
'method' => 'POST',
'version' => '1.1',
'headers' => ['Connection' => 'keep-alive'],
'data' => ['key1' => 'value1', 'key2' => 'value2'],
'success' => function ($response) {
echo $response->getBody();
},
'error' => function ($exception) {
echo $exception;
}
]);
};
Worker::runAll();
ファイルのアップロード
<?php
use Workerman\Worker;
require_once 'vendor/autoload.php';
$worker = new Worker();
$worker->onWorkerStart = function () {
$http = new Workerman\Http\Client();
// ファイルをアップロード
$multipart = new \Workerman\Psr7\MultipartStream([
[
'name' => 'file',
'contents' => fopen(__FILE__, 'r')
],
[
'name' => 'json',
'contents' => json_encode(['a'=>1, 'b'=>2])
]
]);
$boundary = $multipart->getBoundary();
$http->request('http://127.0.0.1:8787', [
'method' => 'POST',
'version' => '1.1',
'headers' => ['Connection' => 'keep-alive', 'Content-Type' => "multipart/form-data; boundary=$boundary"],
'data' => $multipart,
'success' => function ($response) {
echo $response->getBody();
},
'error' => function ($exception) {
echo $exception;
}
]);
};
Worker::runAll();
progressストリームレスポンス
<?php
require_once __DIR__ . '/vendor/autoload.php';
use Workerman\Connection\TcpConnection;
use Workerman\Http\Client;
use Workerman\Protocols\Http\Chunk;
use Workerman\Protocols\Http\Request;
use Workerman\Protocols\Http\Response;
use Workerman\Worker;
$worker = new Worker('http://0.0.0.0:1234');
$worker->onMessage = function (TcpConnection $connection, Request $request) {
$http = new Client();
$http->request('https://api.ai.com/v1/chat/completions', [
'method' => 'POST',
'data' => json_encode([
'model' => 'gpt-3.5-turbo',
'temperature' => 1,
'stream' => true,
'messages' => [['role' => 'user', 'content' => 'hello']],
]),
'headers' => [
'Content-Type' => 'application/json',
'Authorization' => 'Bearer sk-xxx',
],
'progress' => function($buffer) use ($connection) {
$connection->send(new Chunk($buffer));
},
'success' => function($response) use ($connection) {
$connection->send(new Chunk('')); // 空のチャンクを送信してレスポンスの終了を示す
},
]);
$connection->send(new Response(200, [
//"Content-Type" => "application/octet-stream",
"Transfer-Encoding" => "chunked",
], ''));
};
Worker::runAll();
Optinons オプション
<?php
require __DIR__ . '/vendor/autoload.php';
use Workerman\Worker;
$worker = new Worker();
$worker->onWorkerStart = function(){
$options = [
'max_conn_per_addr' => 128, // 各ドメインで維持する同時接続の最大数
'keepalive_timeout' => 15, // 接続を維持する通信ゼロ時間
'connect_timeout' => 30, // 接続タイムアウト時間
'timeout' => 30, // リクエストを発行してからレスポンスを待つタイムアウト時間
];
$http = new Workerman\Http\Client($options);
$http->get('http://example.com/', function($response){
var_dump($response->getStatusCode());
echo $response->getBody();
}, function($exception){
echo $exception;
});
};
Worker::runAll();
コルーチンの使用法
注意
コルーチンの使用にはworkerman>=5.1、http-client>=3.0が必要で、swooleまたはswow拡張をインストールするか、composer require revolt/event-loopをインストールしてFiberドライバをサポートする必要があります。
use Workerman\Worker;
require_once __DIR__ . '/vendor/autoload.php';
$worker = new Worker();
$worker->eventLoop = \Workerman\Events\Swoole::class; // または \Workerman\Events\Swow::class または \Workerman\Events\Fiber::class
$worker->onWorkerStart = function () {
$http = new Workerman\Http\Client();
$response = $http->get('https://example.com/');
var_dump($response->getStatusCode());
echo $response->getBody();
$response = $http->post('https://example.com/', ['key1' => 'value1', 'key2' => 'value2']);
var_dump($response->getStatusCode());
echo $response->getBody();
$response = $http->request('https://example.com/', [
'method' => 'POST',
'version' => '1.1',
'headers' => ['Connection' => 'keep-alive'],
'data' => ['key1' => 'value1', 'key2' => 'value2'],
]);
echo $response->getBody();
};
Worker::runAll();
コールバック関数を設定しない場合、クライアントは同期的な方法で非同期リクエストの結果を返し、リクエストプロセスは現在のプロセスをブロックしません。つまり、リクエストを並行して処理できます。
注意:
1、プロジェクトはまずrequire __DIR__ . '/vendor/autoload.php';を読み込む必要があります。
2、すべての非同期コードはworkerman起動後の実行環境で実行する必要があります。
3、workermanに基づくすべてのプロジェクトをサポートします。Webman、GatewayWorker、PHPSocket.ioなど。
4、クライアントオブジェクトを可能な限り保存して再利用し、接続プールを十分に活用してパフォーマンスを向上させてください。毎回new Workerman\Http\Client()でオブジェクトを繰り返し作成しないでください。
webmanでの使用法
webmanで非同期HTTPリクエストを使用して結果をフロントエンドに返す必要がある場合、以下の使用法を参照してください。
<?php
namespace app\controller;
use support\Request;
use support\Response;
use Workerman\Protocols\Http\Chunk;
class IndexController
{
public function index(Request $request)
{
// clientオブジェクトを保存して再利用することでパフォーマンスを大幅に向上
static $http;
$connection = $request->connection;
$http = $http ?: new \Workerman\Http\Client();
$http->get('https://example.com/', function ($response) use ($connection) {
$connection->send(new Chunk($response->getBody()));
$connection->send(new Chunk('')); // 空のチャンクを送信してレスポンスの終了を示す
});
return response()->withHeaders([
"Transfer-Encoding" => "chunked",
]);
}
}
上記の使用法は、クライアントにchunkedなHTTPヘッダーを返した後、データをchunkの形式でクライアントに送信します。また、上記のコルーチン使用法を参考にすることもできます。
注意
上記のコードでは、クライアントオブジェクトを再利用するためにメソッドスコープの静的変数に保存していますが、実際にはクラスの静的メンバーまたはグローバルオブジェクトに保存することもできます。