Redis中的Scan命令的使用

骑猪看日落 2023-06-25 06:02 21阅读 0赞

## 1、背景 ##

Redis中有一个经典的问题，在巨大的数据量的情况下，做类似于查找符合某种规则的Key的信息，这里就有两种方式：

*  一是keys命令，简单粗暴，由于Redis单线程这一特性，keys命令是以阻塞的方式执行的，keys是以遍历的方式实现的复杂度是 O(n），Redis库中的key越多，查找实现代价越大，产生的阻塞时间越长。
 *  二是scan命令，以非阻塞的方式实现key值的查找，绝大多数情况下是可以替代keys命令的，可选性更强。

## 2、示例 ##

### 2.1、scan命令 ###

scan执行方法，执行结果是Cursor<Entry<HK, HV>>

public static Cursor<Map.Entry<Object, Object>> scan(String key) { 
        if (!StringUtils.isEmpty(key)) { 
            return redisTemplate.opsForHash().scan(key, ScanOptions.NONE);
        }
        return null;
    }

Cursor游标每次会返回一个对象Map.Entry<Object, Object> entry = cursor.next()，entry 对象包含key和value，通过以下方式可以读取键值：

String key = String.valueOf(entry.getKey())
    String.valueOf(entry.getValue())

debug截图如下，展示了每次游标获取的数据：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xvb25nc2hhd24_size_16_color_FFFFFF_t_70]

### 2.2、scan命令实例 ###

比如一段遍历redis缓存的代码，不过该逻辑依据不同的场景存在优化空间。

@Override
    public void traversalMessage() throws Exception { 
        Cursor<Map.Entry<Object,Object>> cursor = RedisCacheUtils.scan(CacheConsts.SOMETHING_KEY);
        if (cursor == null) { 
            logger.info("通过scan(H key, ScanOptions options)方法获取匹配键值对记录为空");
            return;
        }
        while (cursor.hasNext()) { 
            Map.Entry<Object, Object> entry = cursor.next();
            String key = String.valueOf(entry.getKey()); 
            Object value = entry.getValue();
        }
    }

待优化点：

*  若数据量小，但处理逻辑复杂，建议先缓存遍历数据，再对数据进行处理。
 *  若数据量大，遍历时需要考虑范围条件，对遍历数据量进行有效控制。

### 2.3、scan命令有坑 ###

使用redis scan方法无法获取connection，导致线程锁死。  
scan操作后，主动关闭游标，使用try(resource) catch(exception)方式编码。  
1、redis scan操作记住需要主动关闭cursor，即cursor.close;  
2、加强规范编码;

try (Cursor<Map.Entry<Object, Object>> cursor = RedisCacheUtils.scan(key)) { 
    
        if (cursor == null) { 
            logger.info("通过scan(H key, ScanOptions options)方法获取匹配键值对记录为空");
            return;
        }
    
        while (cursor.hasNext()) { 
            // 遍历缓存
            Map.Entry<Object, Object> entry = cursor.next();
            String key = String.valueOf(entry.getKey());
        }
    } catch (Exception ex) { 
        logger.info(ex.toString());
    }

请参考后续写的一篇文章，记录该异常详情-《[redis scan命令导致redis连接耗尽，线程上锁][redis scan_redis]》

## 3、引用 ##

*  [SCAN命令][SCAN]
 *  [w3cschool-redis 列出key][w3cschool-redis _key]
 *  [Redis中的Scan命令的使用][Redis_Scan]
 *  [redis scan命令导致redis连接耗尽，线程上锁(请重点关注)][redis scan_redis]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xvb25nc2hhd24_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20191230205904180.PNG?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xvb25nc2hhd24=,size_16,color_FFFFFF,t_70
[redis scan_redis]: https://blog.csdn.net/loongshawn/article/details/109071791
[SCAN]: http://doc.redisfans.com/key/scan.html
[w3cschool-redis _key]: https://www.w3cschool.cn/redis_all_about/redis_all_about-pf4826ua.html
[Redis_Scan]: https://www.cnblogs.com/wy123/p/10955153.html