hyperf使用rpc服务

一.服务端配置

1.1 设置rpc服务接口类

<?php

namespace App\JsonRpc;


interface CalculatorServiceInterface
{

    public function add(int $a, int $b):int ;

}

1.1 接口类的实现

<?php
namespace App\JsonRpc;
use Hyperf\RpcServer\Annotation\RpcService;

/**
 * Class CalculatorService
 * @package App\JsonRpc
 * @RpcService(name="CalculatorService", protocol="jsonrpc-http", server="jsonrpc-http",publishTo="consul")
 */
class CalculatorService implements CalculatorServiceInterface
{
    // 实现一个加法方法，这里简单的认为参数都是 int 类型
    public function add(int $a, int $b): int
    {
        // 这里是服务方法的具体实现
        return $a + $b;
    }
}

注解@RpcService 共有 4 个参数：
name 属性为定义该服务的名称，这里定义一个全局唯一的名字即可，Hyperf 会根据该属性生成对应的 ID 注册到服务中心去；
protocol 属性为定义该服务暴露的协议，目前仅支持 jsonrpc 和 jsonrpc-http，分别对应于 TCP 协议和 HTTP 协议下的两种协议，默认值为 jsonrpc-http，这里的值对应在 Hyperf\Rpc\ProtocolManager 里面注册的协议的 key，这两个本质上都是 JSON RPC 协议，区别在于数据格式化、数据打包、数据传输器等不同;

server 属性为绑定该服务类发布所要承载的 Server，默认值为 jsonrpc-http，该属性对应 config/autoload/server.php 文件内 servers 下所对应的 name，这里也就意味着我们需要定义一个对应的 Server;

publishTo 属性为定义该服务所要发布的服务中心，目前仅支持 consul 或为空，为空时代表不发布该服务到服务中心去.

1.3 server的配置 autoload/service.php

'servers' => [
        [
            'name' => 'jsonrpc-http',       //与上一步中的@RpcService中的server对应
            'type' => Server::SERVER_HTTP,
            'host' => '0.0.0.0',
            'port' => 9503,
            'sock_type' => SWOOLE_SOCK_TCP,
            'callbacks' => [
                SwooleEvent::ON_REQUEST => [\Hyperf\JsonRpc\HttpServer::class, 'onRequest'],
            ],
        ],
    ],

1.4 注册rpc接口类的对应关系,autoload/dependencies.php

return [
    App\JsonRpc\CalculatorServiceInterface::class => App\JsonRpc\CalculatorService::class,
];

如果注解@RpcService中使用了publishTo 属性,还需要加上consul的配置

return [
    'uri' => 'http://127.0.0.1:8500',    //consul的配置信息
];

至此,服务端的基本配置已完成;

二.消费端配置

2.1创建消费者类

<?php
namespace App\JsonRpc;

use Hyperf\RpcClient\AbstractServiceClient;
class CalculatorServiceConsumer extends AbstractServiceClient implements CalculatorServiceInterface
{
    /**
     * 定义对应服务提供者的服务名称
     * @var string
     */
    protected $serviceName = 'CalculatorService';

    /**
     * 定义对应服务提供者的服务协议
     * @var string
     */
    protected $protocol = 'jsonrpc-http';

    public function add(int $a, int $b): int
    {
        return $this->__request(__FUNCTION__, compact('a', 'b'));
    }
}

配置文件 autoload/services.php

<?php

return [
    'consumers' => [
        [
            // 对应消费者类的 $serviceName
            'name' => 'CalculatorService',
            // 这个消费者要从哪个服务中心获取节点信息，如不配置则不会从服务中心获取节点信息
            'registry' => [
                'protocol' => 'consul',
                'address' => 'http://192.168.7.162:8500',
            ],
            // 如果没有指定上面的 registry 配置，即为直接对指定的节点进行消费，通过下面的 nodes 参数来配置服务提供者的节点信息
            'nodes' => [
                ['host' => '192.168.7.162', 'port' => 9503],
            ],
        ]
    ],
];

rpc接口lei的对应关系

App\JsonRpc\CalculatorServiceInterface::class => App\JsonRpc\CalculatorServiceConsumer::class,

这样便可以通过注入 CalculatorServiceInterface 接口来使用客户端

/**
     * @Inject()
     * @var CalculatorServiceInterface
     */
    public $rpc;

    public function testRpc(){
        return $this->rpc->add(20,3);
    }

最后编辑于：2020.06.02 11:28:03