Redis的SCAN命令是一种非阻塞的迭代器，用于逐步遍历数据库中的键，特别适合处理大数据库。下面详细介绍其使用方法及在Spring框架中的集成方式。

SCAN命令基础

SCAN命令的基本语法：

SCAN cursor [MATCH pattern] [COUNT count]

• cursor：迭代游标，初始为0，每次迭代返回新的游标值。
• MATCH pattern：可选，用于过滤键的模式（如user:*）。
• COUNT count：可选，提示每次迭代返回的键数量（默认10）。

示例：遍历所有键

SCAN 0          # 第一次调用，返回新游标和部分键
SCAN 123        # 使用上次返回的游标继续迭代，直到返回0

SCAN与KEYS的对比

特性	SCAN	KEYS
阻塞性	非阻塞，分批处理	阻塞，一次性返回
数据一致性	可能遗漏迭代中新增的键	快照式遍历，无遗漏
适用场景	生产环境大数据量	测试环境小数据量

在Spring中使用SCAN

在Spring中，可以通过RedisTemplate或StringRedisTemplate结合ScanOptions实现SCAN功能。

依赖配置

确保pom.xml包含以下依赖：

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

示例代码

以下是一个使用StringRedisTemplate实现SCAN的Service：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.connection.RedisConnection;
import org.springframework.data.redis.connection.ScanOptions;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.stereotype.Service;import java.util.ArrayList;
import java.util.List;@Service
public class RedisScanService {@Autowiredprivate StringRedisTemplate redisTemplate;/*** 使用SCAN命令遍历所有符合条件的键* @param pattern 键匹配模式，如 "user:*"* @return 符合条件的键列表*/public List<String> scanKeys(String pattern) {List<String> keys = new ArrayList<>();RedisConnection connection = redisTemplate.getConnectionFactory().getConnection();// 设置ScanOptions，指定匹配模式和COUNT值ScanOptions options = ScanOptions.scanOptions().match(pattern).count(100)  // 每次迭代的建议数量.build();// 使用Cursor迭代try (Cursor<byte[]> cursor = connection.scan(options)) {while (cursor.hasNext()) {keys.add(new String(cursor.next()));}} catch (Exception e) {// 处理异常e.printStackTrace();} finally {// 关闭连接（try-with-resources已自动处理）}return keys;}
}

高级用法：分页遍历

如果需要实现分页功能，可以封装SCAN的游标管理：

public class RedisPagedScanner {private final StringRedisTemplate redisTemplate;private String cursor = "0";  // 初始游标public RedisPagedScanner(StringRedisTemplate redisTemplate) {this.redisTemplate = redisTemplate;}/*** 获取下一页的键* @param pattern 匹配模式* @param pageSize 每页大小* @return 键列表及是否有下一页*/public PageResult scanNextPage(String pattern, int pageSize) {List<String> keys = new ArrayList<>();boolean hasNext = false;RedisConnection connection = redisTemplate.getConnectionFactory().getConnection();ScanOptions options = ScanOptions.scanOptions().match(pattern).count(pageSize).build();try (Cursor<byte[]> cursor = connection.scan(options)) {while (cursor.hasNext()) {keys.add(new String(cursor.next()));}// 更新游标状态this.cursor = cursor.getCursorId();hasNext = !cursor.isClosed();} catch (Exception e) {e.printStackTrace();}return new PageResult(keys, hasNext);}public static class PageResult {private final List<String> keys;private final boolean hasNext;public PageResult(List<String> keys, boolean hasNext) {this.keys = keys;this.hasNext = hasNext;}// getters}
}

使用注意事项

1. COUNT参数的意义：

   • COUNT只是一个提示，实际返回的键数量可能多于或少于该值。
   • 对于哈希、集合等复杂数据结构，COUNT指的是元素而非键的数量。

2. 性能考虑：

   • 避免在MATCH中使用前置通配符（如*key），会导致全量扫描。
   • 合理设置COUNT值，过大可能导致单次操作耗时过长。

3. 事务与管道：

   • SCAN是非原子操作，迭代过程中键可能被修改。
   • 如需原子性，可结合Redis管道（Pipeline）使用。