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）使用。