Hyperf JSON RPC 服务 Demo

系列文章目录

提示：JSON RPC 是一种基于 JSON 格式的轻量级的 RPC 协议标准，易于使用和阅读。在 Hyperf 里由 hyperf/json-rpc 组件来实现，可自定义基于 HTTP 协议来传输，或直接基于 TCP 协议来传输。

---

提示：以下例子使用TCP服务，例子经过作者验证

---

前言

服务有两种角色，一种是 服务提供者(ServiceProvider)，即为其它服务提供服务的服务，另一种是 服务消费者(ServiceConsumer)，即依赖其它服务的服务。两者直接可以通过 服务契约 来定义和约束接口的调用，在 Hyperf 里，可直接理解为就是一个 接口类(Interface)，通常来说这个接口类会同时出现在提供者和消费者下。

提示：推荐使用docker容器进行实验，毕竟模拟分布式可以更加直观

---

一、使用搭建环境

本次我搭建了一个服务提供者 hyperf_server，为其他服务提供计算逻辑功能；一个消费者hyperf_client，通过 jsonrpc 协议调用 hyperf_server提供的计算功能。搭建过程如下：

1. 搭建 hyperf_server 服务提供者

# composer 下载全新的hyperf
composer create-project hyperf/hyperf-skeleton hyperf_server

## composer 安装相关需要的扩展
composer require hyperf/json-rpc
composer require hyperf/service-governance # consul 服务中心扩展
composer require hyperf/rpc-server # JSON RPC 服务端

2. 搭建hyperf_client服务消费者

# composer 下载全新的hyperf
composer create-project hyperf/hyperf-skeleton hyperf_client

## composer 安装相关需要的扩展
composer require hyperf/json-rpc
composer require hyperf/service-governance # consul 服务中心扩展
composer require hyperf/rpc-client # JSON RPC 服务端

二、JSON RPC 服务提供者 功能开发与配置

1. hyperf_server功能开发
   app 目录结构

app
    Constants
    Controller
    Exception
    JsonRpc *
        CalculatorService.php *
        CalculatorServiceInterface.php *
    Listener
    Model
    Process

app\JsonRpc\CalculatorService.php

<?php
namespace App\JsonRpc;
use Hyperf\RpcServer\Annotation\RpcService;
/**
 * 注意，如希望通过服务中心来管理服务，需在注解内增加 publishTo 属性
 * @RpcService(name="CalculatorService", protocol="jsonrpc", server="jsonrpc", publishTo="consul")
 */
class CalculatorService implements CalculatorServiceInterface
{
   
    public function sum(int $v1, int $v2): int
    {
   
        return $v1 + $v2;
    }
}

app\JsonRpc\CalculatorServiceInterface.php

<?php
namespace App\JsonRpc;
/**
 * Class CalculatorService
 * @package App\JsonRpc
 */
interface CalculatorServiceInterface
{
   
    public function sum(int $a, int $b): int;
}

2. hyperf_server 服务配置
   config\autoload\server.php

<?php

declare(strict_types=1);
/**
 * This file is part of Hyperf.
 *
 * @link     https://www.hyperf.io
 * @document https://hyperf.wiki
 * @contact  group@hyperf.io
 * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
 */
use Hyperf\Server\Server;
use Hyperf\Server\SwooleEvent;

return [
    'mode' => SWOOLE_PROCESS,
    'servers' => [
//        [
//            'name' => 'http',
//            'type' => Server::SERVER_HTTP,
//            'host' => '0.0.0.0',
//            'port' => 9501,
//            'sock_type' => SWOOLE_SOCK_TCP,
//            'callbacks' => [
//                SwooleEvent::ON_REQUEST => [Hyperf\HttpServer\Server::class, 'onRequest'],
//            ],
//        ],
        [