Added sentinel mode for redis. (#1868)

Co-authored-by: tiantao <[email protected]>
Co-authored-by: 李铭昕 <[email protected]>

Author: 3 people

composer.json

@@ -31,7 +31,8 @@
         "friendsofphp/php-cs-fixer": "^2.9"
     },
     "suggest": {
-        "hyperf/di": "Create the RedisPool via dependency injection."
+        "hyperf/di": "Create the RedisPool via dependency injection.",
+        "ext-redis": "Required to use sentinel mode (>=5.2)."
     },
     "autoload": {
         "psr-4": {

publish/redis.php

@@ -23,6 +23,13 @@
             'name' => null,
             'seeds' => [],
         ],
+        'sentinel' => [
+            'enable' => (bool) env('REDIS_SENTINEL_ENABLE', false),
+            'master_name' => env('REDIS_MASTER_NAME', 'mymaster'),
+            'nodes' => explode(';', env('REDIS_SENTINEL_NODE', '')),
+            'persistent' => '',
+            'read_timeout' => 0,
+        ],
         'pool' => [
             'min_connections' => 1,
             'max_connections' => 10,

src/RedisConnection.php

@@ -44,6 +44,13 @@ class RedisConnection extends BaseConnection implements ConnectionInterface
             'name' => null,
             'seeds' => [],
         ],
+        'sentinel' => [
+            'enable' => false,
+            'master_name' => '',
+            'nodes' => [],
+            'persistent' => '',
+            'read_timeout' => 0,
+        ],
         'options' => [],
     ];
 
@@ -93,15 +100,19 @@ public function reconnect(): bool
         $db = $this->config['db'];
         $timeout = $this->config['timeout'];
         $cluster = $this->config['cluster']['enable'] ?? false;
+        $sentinel = $this->config['sentinel']['enable'] ?? false;
 
         $redis = null;
-        if ($cluster !== true) {
-            $redis = new \Redis();
-            if (! $redis->connect($host, $port, $timeout)) {
-                throw new ConnectionException('Connection reconnect failed.');
-            }
-        } else {
-            $redis = $this->createRedisCluster();
+        switch (true) {
+            case $cluster:
+                $redis = $this->createRedisCluster();
+                break;
+            case $sentinel:
+                $redis = $this->createRedisSentinel();
+                break;
+            default:
+                $redis = $this->createRedis($host, $port, $timeout);
+                break;
         }
 
         $options = $this->config['options'] ?? [];
@@ -178,4 +189,55 @@ protected function retry($name, $arguments, \Throwable $exception)
 
         return $result;
     }
+
+    protected function createRedisSentinel()
+    {
+        try {
+            $nodes = $this->config['sentinel']['nodes'] ?? [];
+            $timeout = $this->config['timeout'] ?? 0;
+            $persistent = $this->config['sentinel']['persistent'] ?? null;
+            $retryInterval = $this->config['retry_interval'] ?? 0;
+            $readTimeout = $this->config['sentinel']['read_timeout'] ?? 0;
+            $masterName = $this->config['sentinel']['master_name'] ?? '';
+
+            $host = '';
+            $port = 0;
+            foreach ($nodes as $node) {
+                [$sentinelHost, $sentinelPort] = explode(':', $node);
+                $sentinel = new \RedisSentinel(
+                    $sentinelHost,
+                    intval($sentinelPort),
+                    $timeout,
+                    $persistent,
+                    $retryInterval,
+                    $readTimeout
+                );
+                $masterInfo = $sentinel->getMasterAddrByName($masterName);
+                if (is_array($masterInfo) && count($masterInfo) >= 2) {
+                    [$host, $port] = $masterInfo;
+                    break;
+                }
+            }
+            $redis = $this->createRedis($host, $port, $timeout);
+        } catch (\Throwable $e) {
+            throw new ConnectionException('Connection reconnect failed ' . $e->getMessage());
+        }
+
+        return $redis;
+    }
+
+    /**
+     * @param string $host
+     * @param int $port
+     * @param float $timeout
+     * @return \Redis
+     */
+    protected function createRedis($host, $port, $timeout)
+    {
+        $redis = new \Redis();
+        if (! $redis->connect((string) $host, (int) $port, $timeout)) {
+            throw new ConnectionException('Connection reconnect failed.');
+        }
+        return $redis;
+    }
 }

tests/RedisConnectionTest.php

@@ -51,6 +51,13 @@ public function testRedisConnectionConfig()
                 'name' => null,
                 'seeds' => [],
             ],
+            'sentinel' => [
+                'enable' => false,
+                'master_name' => '',
+                'nodes' => [],
+                'persistent' => '',
+                'read_timeout' => 0,
+            ],
             'options' => [],
             'pool' => [
                 'min_connections' => 1,