powernic/guzzle-jsonrpc

Guzzle的JSON-RPC 2.0客户端,感谢graze/guzzle-jsonrpc

4.0.1 2024-02-22 15:01 UTC

This package is auto-updated.

Last update: 2024-08-29 14:38:00 UTC


README

Coverage Status Quality Score Published version PHP ~5.5 MIT Licensed

此库实现了JSON-RPC 2.0,用于Guzzle HTTP客户端。我们尝试支持Guzzle的所有常用版本,包括

您可以选择任何安装方式,但我们推荐使用Composer

{
    "require": {
        "powernic/guzzle-jsonrpc": "~3.0"
    }
}

文档

<?php
use Graze\GuzzleHttp\JsonRpc\Client;

// Create the client
$client = Client::factory('https://:8000');

// Send a notification
$client->send($client->notification('method', ['key'=>'value']));

// Send a request that expects a response
$client->send($client->request(123, 'method', ['key'=>'value']));

// Send a batch of requests
$client->sendAll([
    $client->request(123, 'method', ['key'=>'value']),
    $client->request(456, 'method', ['key'=>'value']),
    $client->notification('method', ['key'=>'value'])
]);

异步请求

通过使用Guzzle Promises库(Promises/A+的实现)支持异步请求。

<?php
use Graze\GuzzleHttp\JsonRpc\Client;

// Create the client
$client = Client::factory('https://:8000');

// Send an async notification
$promise = $client->sendAsync($client->notification('method', ['key'=>'value']));
$promise->then(function () {
    // Do something
});

// Send an async request that expects a response
$promise = $client->sendAsync($client->request(123, 'method', ['key'=>'value']));
$promise->then(function ($response) {
    // Do something with the response
});

// Send a batch of requests
$client->sendAllAsync([
    $client->request(123, 'method', ['key'=>'value']),
    $client->request(456, 'method', ['key'=>'value']),
    $client->notification('method', ['key'=>'value'])
])->then(function ($responses) {
    // Do something with the list of responses
});

在RPC错误时抛出异常

如果您收到RPC错误响应,可以在客户端构造函数中添加选项[rpc_error => true]来抛出异常。

<?php
use Graze\GuzzleHttp\JsonRpc\Client;
use Graze\GuzzleHttp\JsonRpc\Exception\RequestException;

// Create the client with the `rpc_error`
$client = Client::factory('https://:8000', ['rpc_error'=>true]);

// Create a request
$request = $client->request(123, 'method', ['key'=>'value']);

// Send the request
try {
    $client->send($request);
} catch (RequestException $e) {
    die($e->getResponse()->getRpcErrorMessage());
}

贡献

我们接受通过Pull Request提交的贡献,但在合并之前必须包括单元测试。

~ $ make deps
~ $ make lint test

许可证

本库内容由Nature Delivered Ltd根据MIT许可证发布。

您可以在mitLICENSE中找到此许可证的副本。