系列文章目录

提示：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  [email protected]
 * @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'],
//            ],
//        ],
        [
        	// 这里是HTTP通讯形式
            'name' => 'jsonrpc-http',
            'type' => Server::SERVER_HTTP,
            'host' => '0.0.0.0',
            'port' => 9504,
            'sock_type' => SWOOLE_SOCK_TCP,
            'callbacks' => [
                SwooleEvent::ON_REQUEST => [\Hyperf\JsonRpc\HttpServer::class, 'onRequest'],
            ],
        ],
        [
        	// 这里是TCP通讯形式
            'name' => 'jsonrpc',
            'type' => Server::SERVER_BASE,
            'host' => '0.0.0.0',
            'port' => 9501,
            'sock_type' => SWOOLE_SOCK_TCP,
            'callbacks' => [
                SwooleEvent::ON_RECEIVE => [\Hyperf\JsonRpc\TcpServer::class, 'onReceive'],
            ],
            'settings' => [
                'open_eof_split' => true,
                'package_eof' => "\r\n",
            ],
        ],
    ],
    'settings' => [
        'enable_coroutine' => true,
        'worker_num' => swoole_cpu_num(),
        'pid_file' => BASE_PATH . '/runtime/hyperf.pid',
        'open_tcp_nodelay' => true,
        'max_coroutine' => 100000,
        'open_http2_protocol' => true,
        'max_request' => 100000,
        'socket_buffer_size' => 2 * 1024 * 1024,
        'buffer_output_size' => 2 * 1024 * 1024,
    ],
    'callbacks' => [
        SwooleEvent::ON_WORKER_START => [Hyperf\Framework\Bootstrap\WorkerStartCallback::class, 'onWorkerStart'],
        SwooleEvent::ON_PIPE_MESSAGE => [Hyperf\Framework\Bootstrap\PipeMessageCallback::class, 'onPipeMessage'],
        SwooleEvent::ON_WORKER_EXIT => [Hyperf\Framework\Bootstrap\WorkerExitCallback::class, 'onWorkerExit'],
    ],
];

三、JSON RPC 服务消费者 功能开发与配置

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

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

app\JsonRpc\CalculatorServiceInterface.php

<?php
declare(strict_types=1);
namespace App\JsonRpc;
interface CalculatorServiceInterface
{
    
    public function sum(int $v1, int $v2): int;
}

app\Controller\IndexController.php

<?php

declare(strict_types=1);
/**
 * This file is part of Hyperf.
 *
 * @link     https://www.hyperf.io
 * @document https://hyperf.wiki
 * @contact  [email protected]
 * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
 */
namespace App\Controller;

use App\JsonRpc\CalculatorServiceInterface;
use Hyperf\HttpServer\Annotation\Controller;
use Hyperf\HttpServer\Annotation\GetMapping;
use Hyperf\Utils\ApplicationContext;
use Hyperf\Di\Annotation\Inject;

/**
 * @Controller()
 * Class IndexController
 * @package App\Controller
 */
class IndexController extends AbstractController
{
    
    /**
     * @GetMapping(path="sum")
     * @return int
     */
    public function sum()
    {
    
        $client = ApplicationContext::getContainer()->get(CalculatorServiceInterface::class);
        $value = $client->sum(1, 2);
        return $value;
    }
	/**
     * //在这里我们注入了一个接口类，并直接调用接口的sum方法，但在本项目并没有add
    方法的实现，真正的add方法在服务提供者里已经实现了，hyperf会帮我们找到相应服务并使用
     * @Inject()
     * @var CalculatorServiceInterface
     */
    private $calculatorService;
    /**
     * @GetMapping(path="sum2")
     * @return int
     */
    public function sum2(){
    
        return $this->calculatorService->sum(1,2);
    }
}

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

<?php
declare(strict_types=1);
/**
 * This file is part of Hyperf.
 *
 * @link     https://www.hyperf.io
 * @document https://doc.hyperf.io
 * @contact  [email protected]
 * @license  https://github.com/hyperf-cloud/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' => 9500, // 修改http端口 免得端口占用
            'sock_type' => SWOOLE_SOCK_TCP,
            'callbacks' => [
                SwooleEvent::ON_REQUEST => [Hyperf\HttpServer\Server::class, 'onRequest'],
            ],
        ],
    ],
    'settings' => [
        'enable_coroutine' => true,
        'worker_num' => swoole_cpu_num(),
        'pid_file' => BASE_PATH . '/runtime/hyperf.pid',
        'open_tcp_nodelay' => true,
        'max_coroutine' => 100000,
        'open_http2_protocol' => true,
        'max_request' => 100000,
        'socket_buffer_size' => 2 * 1024 * 1024,
    ],
    'callbacks' => [
        SwooleEvent::ON_BEFORE_START => [Hyperf\Framework\Bootstrap\ServerStartCallback::class, 'beforeStart'],
        SwooleEvent::ON_WORKER_START => [Hyperf\Framework\Bootstrap\WorkerStartCallback::class, 'onWorkerStart'],
        SwooleEvent::ON_PIPE_MESSAGE => [Hyperf\Framework\Bootstrap\PipeMessageCallback::class, 'onPipeMessage'],
    ],
];

config\autoload\services.php
没有这个配置文件则新建

<?php
declare(strict_types=1);
/**
 * This file is part of Hyperf.
 *
 * @link     https://www.hyperf.io
 * @document https://doc.hyperf.io
 * @contact  [email protected]
 * @license  https://github.com/hyperf-cloud/hyperf/blob/master/LICENSE
 */
return [
    'consumers' => [
        [
            // name 需与服务提供者的 name 属性相同
            'name' => 'CalculatorService',
            // 服务接口名，可选，默认值等于 name 配置的值，如果 name 直接定义为接口类则可忽略此行配置，如 name 为字符串则需要配置 service 对应到接口类
            'service' => \App\JsonRpc\CalculatorServiceInterface::class,
            // 对应容器对象 ID，可选，默认值等于 service 配置的值，用来定义依赖注入的 key
            'id' => \App\JsonRpc\CalculatorServiceInterface::class,
            // 服务提供者的服务协议，可选，默认值为 jsonrpc-http
            'protocol' => 'jsonrpc',
            // 负载均衡算法，可选，默认值为 random
            'load_balancer' => 'random',
            // 这个消费者要从哪个服务中心获取节点信息，如不配置则不会从服务中心获取节点信息
            'registry' => [
                'protocol' => 'consul',
                'address' => 'http://127.0.0.1:8500',
            ],
            // 如果没有指定上面的 registry 配置，即为直接对指定的节点进行消费，通过下面的 nodes 参数来配置服务提供者的节点信息
//            'nodes' => [
//                ['host' => '127.0.0.1', 'port' => 9501],
//            ],
        ]
    ],
];

四、服务启动与通信演示

1. 启动 consul 服务中心

consul agent -server -bootstrap-expect 1 -data-dir /tmp/consul -node=Dome -bind=127.0.0.1 -ui -client=0.0.0.0

2. 启动 hyperf_client 服务

php hyperf_client/bin/hyperf.php start

3. 启动 hyperf_server 服务

php hyperf_server/bin/hyperf.php start

4. 通信演示

curl http://127.0.0.1:9500/sum
# 返回3 则正确