Added *scan functions to Redis component.

Author: yangliulnn

src/Redis.php

@@ -63,6 +63,34 @@ public function __call($name, $arguments)
         return $result;
     }
 
+    public function scan(&$cursor, $pattern = null, $count = 0)
+    {
+        $hasContextConnection = Context::has($this->getContextKey());
+        $connection = $this->getConnection($hasContextConnection);
+        return $connection->scan($cursor, $pattern, $count);
+    }
+
+    public function hScan($key, &$cursor, $pattern = null, $count = 0)
+    {
+        $hasContextConnection = Context::has($this->getContextKey());
+        $connection = $this->getConnection($hasContextConnection);
+        return $connection->hScan($key, $cursor, $pattern, $count);
+    }
+
+    public function zScan($key, &$cursor, $pattern = null, $count = 0)
+    {
+        $hasContextConnection = Context::has($this->getContextKey());
+        $connection = $this->getConnection($hasContextConnection);
+        return $connection->zScan($key, $cursor, $pattern, $count);
+    }
+
+    public function sScan($key, &$cursor, $pattern = null, $count = 0)
+    {
+        $hasContextConnection = Context::has($this->getContextKey());
+        $connection = $this->getConnection($hasContextConnection);
+        return $connection->sScan($key, $cursor, $pattern, $count);
+    }
+
     /**
      * Define the commands that needs same connection to execute.
      * When these commands executed, the connection will storage to coroutine context.

src/RedisConnection.php

@@ -16,6 +16,7 @@
 use Hyperf\Pool\Connection as BaseConnection;
 use Hyperf\Pool\Exception\ConnectionException;
 use Hyperf\Pool\Pool;
+use Hyperf\Utils\Str;
 use Psr\Container\ContainerInterface;
 
 class RedisConnection extends BaseConnection implements ConnectionInterface
@@ -56,6 +57,64 @@ public function __call($name, $arguments)
         return $this->connection->{$name}(...$arguments);
     }
 
+    /**
+     * @param null|int $cursor
+     * @param string $pattern
+     * @param int $count
+     *
+     * @return array|bool
+     */
+    public function scan(&$cursor, $pattern = null, $count = 0)
+    {
+        $ret = $this->connection->scan($cursor, $this->applyPrefix($pattern), $count);
+        if ($ret !== false) {
+            $prefix = $this->applyPrefix('');
+            array_walk($ret, function (&$key) use ($prefix) {
+                $key = Str::replaceFirst($prefix, '', $key);
+            });
+        }
+        return $ret;
+    }
+
+    /**
+     * @param string $key
+     * @param int $cursor
+     * @param null|string $pattern
+     * @param int $count
+     *
+     * @return array
+     */
+    public function hScan($key, &$cursor, $pattern = null, $count = 0)
+    {
+        return $this->connection->hScan($key, $cursor, $pattern, $count);
+    }
+
+    /**
+     * @param string $key
+     * @param int $cursor
+     * @param null|string $pattern
+     * @param int $count
+     *
+     * @return array|bool
+     */
+    public function zScan($key, &$cursor, $pattern = null, $count = 0)
+    {
+        return $this->connection->zScan($key, $cursor, $pattern, $count);
+    }
+
+    /**
+     * @param string $key
+     * @param int $cursor
+     * @param null|string $pattern
+     * @param int $count
+     *
+     * @return array|bool
+     */
+    public function sScan($key, &$cursor, $pattern = null, $count = 0)
+    {
+        return $this->connection->sScan($key, $cursor, $pattern, $count);
+    }
+
     public function getActiveConnection()
     {
         if ($this->check()) {
@@ -125,4 +184,17 @@ public function setDatabase(?int $database): void
     {
         $this->database = $database;
     }
+
+    /**
+     * Apply prefix to the given key if necessary.
+     *
+     * @param string $key
+     *
+     * @return string
+     */
+    private function applyPrefix($key = ''): string
+    {
+        $prefix = (string) $this->connection->getOption(\Redis::OPT_PREFIX);
+        return $prefix . $key;
+    }
 }