异常教程

Redis SCAN 命令（一文讲透）

更新时间:

💡一则或许对你有用的小广告

欢迎加入小哈的星球 ，你将获得：专属的项目实战 / 1v1 提问 / Java 学习路线 / 学习打卡 / 每月赠书 / 社群讨论

  • 新项目:《从零手撸：仿小红书（微服务架构）》 正在持续爆肝中，基于 Spring Cloud Alibaba + Spring Boot 3.x + JDK 17...，点击查看项目介绍 ;
  • 《从零手撸：前后端分离博客项目（全栈开发）》 2 期已完结，演示链接： http://116.62.199.48/ ;

截止目前， 星球 内专栏累计输出 82w+ 字，讲解图 3441+ 张，还在持续爆肝中.. 后续还会上新更多项目，目标是将 Java 领域典型的项目都整一波，如秒杀系统, 在线商城, IM 即时通讯，权限管理，Spring Cloud Alibaba 微服务等等，已有 2900+ 小伙伴加入学习 ，欢迎点击围观

前言

在 Redis 开发中，我们常常需要遍历数据库中的键（Key），例如统计特定模式的键数量、清理过期数据或执行批量操作。然而，当数据量较大时，传统的 KEYS 命令可能因阻塞服务器而导致性能问题。此时，Redis SCAN 命令 便成为更高效、更安全的替代方案。本文将从基础概念到实战案例，深入解析 SCAN 命令的原理和使用方法，帮助开发者在实际项目中高效利用这一工具。

一、键空间遍历的痛点与传统方案的局限性

1.1 什么是键空间？

Redis 的键空间（Key Space）是指数据库中所有键的集合。每个键对应一个值（Value），例如字符串、哈希表、列表等。当需要对键空间进行操作时（如查找、删除或统计），开发者常会遇到以下挑战：

  • 数据量过大时的性能问题：当键数量达到百万级或更高时，遍历所有键可能耗时较长，甚至导致 Redis 服务卡顿。
  • 一致性需求：遍历过程中，其他客户端可能修改键（例如新增或删除键），导致遍历结果出现重复或遗漏。

1.2 传统命令 KEYS 的缺陷

KEYS 命令可以一次性返回所有匹配的键，例如：

KEYS *

但其致命缺点在于：

  • 阻塞性：命令执行期间会占用 Redis 主线程，导致其他操作被延迟。
  • 不可控性：当键数量较多时，可能返回海量数据，占用过多内存。

二、Redis SCAN 命令的核心原理

2.1 分布式遍历的思想：游标（Cursor）

SCAN 命令通过引入 游标（Cursor） 的概念，实现了对键空间的 渐进式遍历。其核心原理如下：

  1. 游标初始化：初始游标值设为 0，表示遍历的起点。
  2. 分批次处理：每次执行 SCAN 命令时，Redis 返回一批键和新的游标值。
  3. 循环迭代：开发者通过循环调用 SCAN，直到游标返回 0，表示遍历完成。

比喻：想象一个图书馆的书架，SCAN 命令就像逐页翻书，每次只查看一小部分书名（键），而无需一次性搬空所有书籍。

2.2 命令语法与参数详解

SCAN 命令的基本语法如下：

SCAN cursor [MATCH pattern] [COUNT count] [TYPE type]
  • cursor：初始值为 0，后续使用上一次返回的游标值。
  • MATCH pattern：可选参数，用于过滤符合特定模式的键（如 user:*）。
  • COUNT count：建议值，告知 Redis 单次返回键的大致数量（非精确）。
  • TYPE type：可选参数，限定遍历的键类型（如 string、hash）。

三、SCAN 命令的实战案例

3.1 基础用法示例

以下通过 Redis CLI 演示如何遍历键空间：

127.0.0.1:6379> SCAN 0  
1) "12345"    # 新的游标值  
2) ["key1", "key2", "key3"]  

127.0.0.1:6379> SCAN 12345  
1) "67890"  
2) ["key4", "key5"]  

127.0.0.1:6379> SCAN 67890  
1) "0"  
2) ["key6"]

3.2 结合 MATCH 参数过滤键

假设需要统计所有以 user:2023:* 开头的键：

127.0.0.1:6379> SCAN 0 MATCH user:2023:* COUNT 100  
1) "1000"  
2) ["user:2023:001", "user:2023:002", ...]

3.3 编程语言中的实现

在 Python 中，可以通过 redis-py 库循环调用 scan：

import redis  

r = redis.Redis(host='localhost', port=6379, db=0)  
cursor = '0'  
while cursor != 0:  
    cursor, keys = r.scan(cursor=cursor, match='user:*', count=100)  
    # 处理 keys 列表  
    print(keys)

四、SCAN 命令的注意事项

4.1 渐进一致性（Non-Blocking vs. Consistency）

SCAN 命令的遍历结果是 渐进一致 的，这意味着：

  • 可能 重复返回某些键（如键在遍历中被重新插入）。
  • 可能 遗漏某些键（如键在遍历中被删除）。

解决方案：在业务逻辑中处理重复或缺失的情况，例如使用集合（Set）记录已处理的键。

4.2 性能调优参数 COUNT

  • COUNT 的作用：控制每次返回键的数量，但实际返回值可能与之不同。
  • 调优建议：
    • 若需快速完成遍历，可设置较大的 COUNT（如 COUNT 1000）。
    • 若需减少对 Redis 的压力，可使用较小的 COUNT（如 COUNT 10）。

4.3 游标管理的细节

  • 游标不可重用：每次遍历必须使用上一次返回的游标值，否则可能跳过或重复部分键。
  • 游标生命周期：游标在遍历完成后会失效，无需手动清理。

五、SCAN 命令的进阶用法

5.1 结合 HSCAN 和 SSCAN 处理复杂数据

对于哈希表（Hash）和集合（Set），Redis 提供了专用的遍历命令：

HSCAN myhash 0 MATCH "user:*"  

SSCAN myset 0 COUNT 50

5.2 分布式场景下的应用

在 Redis 集群中，SCAN 命令会自动遍历所有节点的键空间，开发者无需手动分片。例如：

CLUSTER NODES  
SCAN 0 MATCH "session:*"

5.3 结合 Lua 脚本优化性能

若需批量处理键（如删除过期数据），可将 SCAN 与 Lua 脚本结合，减少网络开销：

-- 示例：删除所有以 "tmp:" 开头的键  
local cursor = "0"  
repeat  
    local result = redis.call("SCAN", cursor, "MATCH", "tmp:*")  
    cursor = result[1]  
    for _, key in ipairs(result[2]) do  
        redis.call("DEL", key)  
    end  
until cursor == "0"

结论

Redis SCAN 命令 是处理大规模键空间遍历的高效工具，其通过 渐进式、非阻塞 的设计，解决了传统 KEYS 命令的性能瓶颈问题。开发者需理解其核心原理（游标机制）和注意事项（渐进一致性），并结合实际场景选择合适的参数（如 MATCH、COUNT）。无论是单机环境还是分布式系统，SCAN 命令都能为键空间管理提供灵活且可靠的解决方案。

通过本文的讲解和案例，希望读者能够掌握 Redis SCAN 命令 的使用场景与最佳实践，在实际项目中避免因遍历操作引发的性能问题。

最新发布

查看更多文章