title: EasySwoole RPC Custom Registration Center meta:

  • name: description content: Implementing RPC Custom Registration Center in EasySwoole
  • name: keywords content: swoole|swoole extension|swoole framework|Easyswoole|Rpc Service Registration Center|swoole RPC|RPC

EasySwoole RPC Custom Registration Center

EasySwoole defaults to unaware service discovery through UDP broadcast. However, in some cases, it is not convenient to use UDP broadcast, then EasySwoole supports you to customize a node manager to change the service discovery mode.

For example, using Redis to achieve

  1. <?php
  3. namespace EasySwoole\Rpc\NodeManager;
  5. use EasySwoole\Component\Pool\PoolConf;
  6. use EasySwoole\Component\Pool\PoolManager;
  7. use EasySwoole\Rpc\ServiceNode;
  8. use EasySwoole\Utility\Random;
  9. use Swoole\Coroutine\Channel;
  10. use Swoole\Coroutine\Redis;
  12. class RedisManager implements NodeManagerInterface
  13. {
  14.     protected $redisKey;
  15.     /** @var Channel */
  16.     protected $channel;
  18.     function __construct(string $host, $port = 6379, $auth = null, string $hashKey = '__rpcNodes', int $maxRedisNum = 10)
  19.     {
  20.         $this->redisKey = $hashKey;
  21.         //Register anonymous connection pool
  22.         PoolManager::getInstance()->registerAnonymous('__rpcRedis', function (PoolConf $conf) use ($host, $port, $auth, $maxRedisNum) {
  23.             $conf->setMaxObjectNum($maxRedisNum);
  24.             $redis = new Redis();
  25.             $redis->connect($host, $port);
  26.             if ($auth) {
  27.                 $redis->auth($auth);
  28.             }
  29.             $redis->setOptions(['serialize' => true, 'compatibility_mode' => true]);
  30.             return $redis;
  31.         });
  32.     }
  34.     /**
  35.     *  Get all available nodes of a service 
  36.     */
  37.     function getServiceNodes(string $serviceName, ?string $version = null): array
  38.     {
  39.         /** @var \Redis $redis */
  40.         $redis = PoolManager::getInstance()->getPool('__rpcRedis')->getObj(15);//Connection pool to take redis object
  41.         try {
  42.             $nodes = $redis->hGetAll($this->redisKey . md5($serviceName));
  43.             $nodes = $nodes ?: [];
  44.             $ret = [];
  45.             foreach ($nodes as $nodeId => $node) {
  46.                 /**
  47.                  * @var  $nodeId
  48.                  * @var  ServiceNode $node
  49.                  */
  50.                 if (time() - $node->getLastHeartBeat() > 30) {//Check the node's last heartbeat time
  51.                     $this->deleteServiceNode($node);
  52.                 }
  53.                 if ($version && $version != $node->getServiceVersion()) {
  54.                     continue;
  55.                 }
  56.                 $ret[$nodeId] = $node;
  57.             }
  58.             return $ret;
  59.         } catch (\Throwable $throwable) {
  60.             //If the redis is disconnected, it is destroyed.
  61.             PoolManager::getInstance()->getPool('__rpcRedis')->unsetObj($redis);
  62.         } finally {
  63.             //Here you need to test whether an object can be recycled after it is unset.
  64.             PoolManager::getInstance()->getPool('__rpcRedis')->recycleObj($redis);
  65.         }
  66.         return [];
  67.     }
  69.     /**
  70.     *  Get a random node available for a service 
  71.     */
  72.     function getServiceNode(string $serviceName, ?string $version = null): ?ServiceNode
  73.     {
  74.         $list = $this->getServiceNodes($serviceName, $version);
  75.         if (empty($list)) {
  76.             return null;
  77.         }
  78.         return Random::arrayRandOne($list);
  79.     }
  81.     /**
  82.     *  Delete node 
  83.     */
  84.     function deleteServiceNode(ServiceNode $serviceNode): bool
  85.     {
  86.         /** @var \Redis $redis */
  87.         $redis = PoolManager::getInstance()->getPool('__rpcRedis')->getObj(15);
  88.         try {
  89.             $redis->hDel($this->redisKey . md5($serviceNode->getServiceName()), $serviceNode->getNodeId());
  90.             return true;
  91.         } catch (\Throwable $throwable) {
  92.             PoolManager::getInstance()->getPool('__rpcRedis')->unsetObj($redis);
  93.         } finally {
  94.             PoolManager::getInstance()->getPool('__rpcRedis')->recycleObj($redis);
  95.         }
  96.         return false;
  97.     }
  99.     /**
  100.     *  Refresh node(
  101.     *  Ps: refreshed by the tick process process timer (this node) | listen for broadcast messages (other nodes) to refresh node information, redis node manager can)
  102.     */
  103.     function serviceNodeHeartBeat(ServiceNode $serviceNode): bool
  104.     {
  105.         if (empty($serviceNode->getLastHeartBeat())) {
  106.             $serviceNode->setLastHeartBeat(time());
  107.         }
  108.         /** @var \Redis $redis */
  109.         $redis = PoolManager::getInstance()->getPool('__rpcRedis')->getObj(15);
  110.         try {
  111.             $redis->hSet($this->redisKey . md5($serviceNode->getServiceName()), $serviceNode->getNodeId(), $serviceNode);
  112.             return true;
  113.         } catch (\Throwable $throwable) {
  114.             //If the redis is disconnected, it is destroyed.
  115.             PoolManager::getInstance()->getPool('__rpcRedis')->unsetObj($redis);
  116.         } finally {
  117.             //Here you need to test whether an object can be recycled after it is unset.
  118.             PoolManager::getInstance()->getPool('__rpcRedis')->recycleObj($redis);
  119.         }
  120.         return false;
  121.     }
  122. }

::: warning Note that once the custom node manager is set, it is no longer necessary to enable the UDP scheduled broadcast process. After creating an RPC instance, create a ServiceNode object and refresh it to the registry. The same is true for the node offline. When your service is closed, the node manager is taken offline. :::