Redis高级操作:scan实现模糊查询

简介

在巨大的数据量的情况下，做查找符合某种规则的Key的信息，这里就有两种方式:

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

1. scan相关命令

都是用于增量迭代集合元素。

SCAN 命令用于迭代当前数据库中的数据库键。
SSCAN 命令用于迭代集合键中的元素。
HSCAN 命令用于迭代哈希键中的键值对。
ZSCAN 命令用于迭代有序集合中的元素（包括元素成员和元素分值）。

之后的例子会以sscan为例

2. 命令参数

redis 127.0.0.1:6379> SSCAN key cursor [MATCH pattern] [COUNT count]

Key：查询的相关集合名称

cursor: 游标值，第一次迭代使用 0 作为游标，表示开始一次新的迭代

[MATCH pattern] ：模糊匹配

[COUNT count] :每次的查询条数，默认值为 10

2.1 创建数组

在上面这个例子中，第一次迭代使用 0 作为游标，表示开始一次新的迭代。

第二次迭代使用的是第一次迭代时返回的游标，也即是命令回复第一个元素的值 —— 3 。

以 0 作为游标开始一次新的迭代，一直调用 SCAN 命令，直到命令返回游标 0 ，我们称这个过程为一次完整遍历（full iteration）。

在同一时间，可以有任意多个客户端对同一数据集进行迭代，客户端每次执行迭代都需要传入一个游标，并在迭代执行之后获得一个新的游标，而这个游标就包含了迭代的所有状态，因此，服务器无须为迭代记录任何状态，同样也不会阻塞线程

2.2 解读match

match: 通过提供一个 glob 风格的模式参数，让命令只返回和给定模式相匹配的元素。

前方高能预警：match的底层操作是在从数据集中取出元素之后，向客户端返回元素之前的这段时间内进行的，如果返回的结果集中没有匹配，那么可能会在多次执行中都不返回任何元素。

所以单次返回的结果是空的并不意味着遍历结束，而要看返回的游标值是否为零;

2.3 解读count

count:可以控制每次返回结果的最大条数，count只是一个 hint，返回的结果可多可少.

注意

返回的结果可能会有重复，需要客户端去重复，这点非常重要;
遍历的过程中如果有数据修改，改动后的数据能不能遍历到是不确定的;

3. 实操

在线上有时候需要对大量key进行删除操作，有几个风险点：

一次性查询所指定的key, 数量较大可能造成redis服务卡顿，Redis是单线程程序，顺序执行所有指令，其它指令必须等到当前的 keys 指令执行完了才可以继续。
如何从海量的 key 中找出满足特定前缀的 key?

但是通过用scan，我们就可以指定有共性的key，并指定一次性查询条件。

for (String cacheName : cacheNames) {
        String keyPrefix = new String(cachePrefix.prefix(cacheName)); //拼接我们的
        ScanParams scanParams = new ScanParams().match(keyPrefix.concat("*")).count(200);  //指定规则
        String cur = ScanParams.SCAN_POINTER_START; //游标初始值为0
        boolean hasNext = true;
        int count = 0;
        while (hasNext) {
            count++;
            ScanResult<String> scanResult = jedisCluster.scan(cur, scanParams); //key的正则表达式
            List<String> keys = scanResult.getResult();
            for (String key : keys) {
                jedisCluster.del(key);
            }
            cur = scanResult.getStringCursor();  //返回用于下次遍历的游标
            if (StringUtils.equals("0", cur)) { //说明遍历已结束
                hasNext = false;
            }
        }
        log.info("redis cache evict {} {}", cacheName, count);
    }
}