Redis集群环境下用Ruby gem 4.2.5扫描全量app:*键的方法咨询

问题场景 #

使用redis-ruby gem 4.2.5连接Redis集群，集群中存在以下键模式：

app:namespace1:{id}
app:namespace2:{id}
app:namespace1:{id}:nested1
app:namespace2:{id}:nested2
app:whatever1
app:whatever2

执行扫描app:*的逻辑时，仅能获取app:whatever1、app:whatever2这类顶层非嵌套键，无法获取所有嵌套键。排查确认问题源于Redis集群的键分布在多个节点，原有扫描代码仅能扫描单个节点的键。

原有扫描代码：

def match_keys(pattern)
  @redis ||= init_connection
  all_keys = []
  cursor = 0
  loop do
    cursor, keys = @redis.scan(cursor, match: pattern)
    all_keys += keys
    break if cursor == '0'
  end
  all_keys.uniq
end

match_keys 'app:*'
#=> ["app:whatever1", "app:whatever2"]

集群连接配置：

def init_connection
  config = {
    cluster: [
      "redis://#{ENV['REDIS_HOST_1']}",
      "redis://#{ENV['REDIS_HOST_2']}",
      "redis://#{ENV['REDIS_HOST_3']}"
    ],
    replica: true
  }
  @redis ||= ::Redis.new(config)
end

解决方案 #

Redis集群的SCAN命令默认仅在当前连接的节点执行，无法跨节点扫描。要获取所有匹配键，需遍历集群的每个节点，单独对每个节点执行SCAN操作。

修改后的扫描代码 #

def match_keys_cluster(pattern)
  @redis ||= init_connection
  all_keys = []

  # 遍历集群所有节点，逐个执行SCAN
  @redis.nodes.each do |node|
    cursor = 0
    loop do
      # 可选：添加count参数调整每次扫描的键数量，提升效率
      cursor, keys = node.scan(cursor, match: pattern, count: 1000)
      all_keys += keys
      break if cursor == '0'
    end
  end

  all_keys.uniq
end

# 调用示例
match_keys_cluster 'app:*'
# 返回所有匹配app:*的键，包含分布在各节点的嵌套键

关键说明 #

• @redis.nodes会返回集群中所有主节点的客户端实例；若需扫描从节点，可检查节点类型（node.role）后筛选，但通常主节点存储完整数据，扫描主节点即可覆盖所有键。
• 原有代码仅扫描单个节点，所以只能获取该节点上的键；遍历所有节点后，才能收集到集群中所有匹配的键。
• 若集群键数量庞大，建议在业务低峰期执行扫描，或通过count参数调整每次扫描的键数量，平衡扫描效率与Redis负载。

内容的提问来源于stack exchange，提问作者alilland