如何使用 scan 命令遍历 Redis 中的所有 Key？

推荐答案

SCAN cursor [MATCH pattern] [COUNT count]

• cursor：游标，初始值为 0，表示开始遍历。每次调用 SCAN 后，返回一个新的游标值，直到返回 0 表示遍历完成。
• MATCH pattern：可选参数，用于匹配符合指定模式的 Key。
• COUNT count：可选参数，指定每次遍历返回的 Key 数量，默认值为 10。

示例代码：

// www.javascriptcn.com code example
# 初始化游标
cursor = 0

# 开始遍历
while True:
    # 执行 SCAN 命令
    cursor, keys = redis.scan(cursor, match='*', count=100)
    
    # 处理返回的 Key
    for key in keys:
        print(key)
    
    # 如果游标为 0，表示遍历完成
    if cursor == 0:
        break

本题详细解读

1. SCAN 命令的作用

SCAN 命令用于增量式地遍历 Redis 数据库中的所有 Key。与 KEYS 命令不同，SCAN 不会一次性返回所有 Key，而是分批返回，避免阻塞 Redis 服务器。

2. 参数详解

• cursor：游标，用于标记遍历的进度。初始值为 0，表示从头开始遍历。每次调用 SCAN 后，返回一个新的游标值，直到返回 0 表示遍历完成。
• MATCH pattern：可选参数，用于匹配符合指定模式的 Key。例如，MATCH user:* 只会返回以 user: 开头的 Key。
• COUNT count：可选参数，指定每次遍历返回的 Key 数量。默认值为 10，但实际返回的数量可能会有所不同。

3. 使用场景

• 大数据集遍历：当 Redis 数据库中有大量 Key 时，使用 SCAN 可以避免一次性返回所有 Key 导致的性能问题。
• 模式匹配：通过 MATCH 参数，可以只遍历符合特定模式的 Key。
• 分批次处理：通过 COUNT 参数，可以控制每次返回的 Key 数量，适合需要分批次处理的场景。

4. 注意事项

• 非精确计数：COUNT 参数只是一个提示，实际返回的 Key 数量可能会有所不同。
• 重复 Key：在遍历过程中，可能会有 Key 被多次返回，因此需要根据业务场景进行去重处理。
• 并发修改：在遍历过程中，可能会有 Key 被添加或删除，因此 SCAN 不能保证返回的 Key 是完全一致的。

通过 SCAN 命令，可以高效、安全地遍历 Redis 中的所有 Key，适用于大数据集和需要模式匹配的场景。