使用 StringRedisTemplate 批量删除指定前缀的 Redis Key

在使用 Redis 时，常常需要对具有相同前缀的键进行批量删除操作。Spring 提供的 StringRedisTemplate 是一种方便操作 Redis 的工具，本文将深入解析如何使用 StringRedisTemplate 实现批量删除指定前缀的键。

一、问题背景

在业务系统中，键的前缀通常用来区分不同类型的数据。例如，user:123 可能代表用户信息，order:456 可能代表订单信息。为了维护和管理 Redis 数据，有时需要删除所有匹配特定前缀的键，例如清除所有 user: 前缀的键。

Redis 不直接提供按前缀删除键的命令，因此我们需要先找到这些键，再进行删除操作。

二、基本思路

为了批量删除指定前缀的键，典型的操作步骤如下：

1. 扫描键：使用 SCAN 命令扫描 Redis 中所有匹配指定前缀的键。SCAN 是非阻塞的，适合在大数据量场景下使用。
2. 删除键：获取匹配到的键后，使用 DEL 命令将其删除。

1. 为什么使用 SCAN 而不是 KEYS？

• KEYS 命令虽然可以直接找到匹配的键，但它会阻塞 Redis，且在大规模数据集上使用效率较低。
• SCAN 命令则是渐进式的，不会阻塞 Redis，适合在生产环境中使用。

三、代码实现

以下是使用 StringRedisTemplate 实现批量删除指定前缀键的代码示例：

import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.stereotype.Service;

import java.util.ArrayList;
import java.util.List;
import java.util.Set;

@Service
public class RedisKeyDeletionService {

    private final StringRedisTemplate stringRedisTemplate;

    public RedisKeyDeletionService(StringRedisTemplate stringRedisTemplate) {
        this.stringRedisTemplate = stringRedisTemplate;
    }

    /**
     * 批量删除指定前缀的 Redis 键
     *
     * @param keyPrefix 键的前缀
     */
    public void deleteKeysByPrefix(String keyPrefix) {
        // 设置扫描匹配模式
        String pattern = keyPrefix + "*";
        // 初始化游标
        String cursor = "0";
        List<String> keysToDelete = new ArrayList<>();

        do {
            // 使用 SCAN 命令扫描符合条件的键
            var scanResult = stringRedisTemplate.execute((connection) -> 
                connection.scan(
                    redis.clients.jedis.ScanParams.scanParams().match(pattern).count(1000)
                ), true);

            if (scanResult != null) {
                scanResult.forEachRemaining(keysToDelete::add);
            }
        } while (!"0".equals(cursor) && !keysToDelete.isEmpty());

        // 批量删除扫描到的键
        if (!keysToDelete.isEmpty()) {
            stringRedisTemplate.delete(keysToDelete);
        }
    }
}

代码解释

1. 匹配模式：通过 keyPrefix + "*"构造 Redis 扫描的匹配模式。该模式用于匹配所有以指定前缀开头的键。
2. 游标管理：SCAN 命令使用游标进行迭代。初始游标值为 "0"，当 Redis 返回的游标值再次为 "0" 时，表示扫描结束。
3. 批量删除：扫描到所有匹配的键后，使用 StringRedisTemplate 的 delete 方法批量删除这些键。

优化与注意事项

1. 批量处理：SCAN 操作可以通过 COUNT 参数设置每次返回的键数量，适当调优可以提升性能。
2. 并发处理：如果键的数量较大，考虑将删除操作分批进行，或者使用多线程来并行处理，避免一次性删除过多键导致 Redis 性能下降。

四、最佳实践

1. 慎用 KEYS 命令：尽量避免在生产环境中使用 KEYS 命令来查找键，因为它可能导致 Redis 服务阻塞。
2. 使用合适的 Redis 集群：对于海量数据的 Redis 集群，使用 SCAN 时要考虑集群节点的数据分布情况，可能需要在不同节点上分别进行扫描操作。
3. 数据持久化和备份：在执行大规模删除操作前，确保 Redis 数据已持久化，并做好数据备份，以防止意外数据丢失。

五、总结

通过 StringRedisTemplate 和 Redis 的 SCAN 命令，我们可以实现批量删除具有指定前缀的键。这种方法既能保证操作的高效性，又不会像 KEYS 命令那样对 Redis 性能造成过大的影响。对于大规模 Redis 数据管理，使用 SCAN 是最佳选择，尤其是在需要批量操作的场景下。