README

📢 乌克兰开源社区更新

🇷🇺 致俄罗斯人民的信

快速入门

使用 composer 安装: composer require upgate/laravel-jsonrpc
在你的 RouteServiceProvider 中，做如下操作

// ...
use Upgate\LaravelJsonRpc\Contract\ServerInterface as JsonRpcServerContract;

class RouteServiceProvider extends ServiceProvider
{
    // ...
    public function map(Router $router)
    {
        $router->group(
            ['namespace' => $this->namespace],
            function (Router $router) {
                // Create an instance of JsonRpcServer
                $jsonRpcServer = $this->app->make(JsonRpcServerContract::class);
                // Set default controller namespace
                $jsonRpcServer->setControllerNamespace($this->namespace);
                // Register middleware aliases configured for Laravel router
                $jsonRpcServer->registerMiddlewareAliases($router->getMiddleware());
                
                require app_path('Http/routes.php');
            }
        );
    }
}

在 routes.php 中使用 $jsonRpcServer，如下所示

$router->post('/jsonrpc', function (Illuminate\Http\Request $request) use ($jsonRpcServer) {
    $jsonRpcServer->router()
        ->addMiddlewares(['fooMiddleware', 'barMiddleware', 'auth:rpcGuard']) // Middleware alias names or class names.
                                                                              // Parameters may be specified by separating
                                                                              // the middleware name and parameters with a :
        ->bindController('foo', 'FooController') // for 'foo.$method' methods invoke FooController->$method(),
                                                 // for 'foo' method invoke FooConroller->index()
        ->bind('bar', 'MyController@bar') // for 'bar' method invoke MyController->bar()
        ->group(
            ['bazMiddleware'], // add bazMiddleware for methods in this group
            function ($jsonRpcRouter) {
                // for 'bar.baz' method invoke MyController->bazz()
                $jsonRpcRouter->bind('bar.baz', 'MyController@bazz');
            }
        );

    // Run json-rpc server with $request passed to middlewares as a handle() method argument
    return $jsonRpcServer->run($request);
});

查看 ServerTest 和 RouterTest 获取更多示例。

异常处理

继承自 Upgate\LaravelJsonRpc\Exception\JsonRpcException 的异常代表根据规范定义的 JSON-RPC 错误（见 Upgate\LaravelJsonRpc\Server\ErrorCode）。

其他异常默认记录并转换为 INTERNAL_ERROR 响应。

使用 Upgate\LaravelJsonRpc\Server\Server::onException() 来注册自定义异常处理器

use Upgate\LaravelJsonRpc\Server;

$jsonRpcServer->onException(
    SomeExceptionClass::class,
    function (SomeExceptionClass $e, Server\Request $request = null) {
        $message = "Some Message";
        $code = -32099;
        return Server\RequestResponse::constructErrorResponse($request ? $request->getId() : null, $message, $code);
    }
);

$jsonRpcServer->onException(
    \Throwable::class, // catch-all
    function (\Throwable $e, Server\Request $request = null) {
        $message = "Some Other Message";
        $code = -32098;
        return Server\RequestResponse::constructErrorResponse($request ? $request->getId() : null, $message, $code);
    }
);

查看 ServerTest:: testSingleRequestWithExceptionHandler() 和 ServerTest::testExceptionHandlersPriority() 获取更多示例。

JSON-RPC 请求格式

(自 v0.3.0 版本起)

Upgate\LaravelJsonRpc\Server\FormRequest 与 Laravel 表单请求类似，但验证的是 JSON-RPC 参数。

示例

use Upgate\LaravelJsonRpc\Server\FormRequest as JsonRpcFormRequest;

class MyJsonRpcFormRequest extends JsonRpcFormRequest
{
    public function rules(): array
    {
        return [
            'id'    => 'required|numeric',
            'email' => 'required|email',
        ];
    }
}

class MyController
{
    public function myAction(MyJsonRpcFormRequest $jsonRpcRequest)
    {
        $email = $jsonRpcRequest->email; // or $jsonRpcRequest->get('email');
        $allParams = $jsonRpcRequest->all();
        // ...
    }
}

如果验证失败，将返回 INVALID_PARAMS 错误响应，其中包含验证错误详情在 data.violations 中。

查看 ServerFormRequestTest 获取更多示例。

upgate / laravel-jsonrpc

维护者

详细信息