【bugfix】解决Redis缓存键清理问题

前言

在Spring Boot应用中集成Redis作为缓存存储时，合理配置RedisTemplate是确保数据正确存储和检索的关键。本文将通过对比分析一段初始存在问题的Redis配置代码及其修正后的版本，探讨如何正确处理Redis键前缀，以避免清理缓存时遇到的问题。

初始问题代码

// 省略了注释和包声明以聚焦关键代码
private static class KeySerializer extends StringRedisSerializer {
    private final String keyPrefix;

    public KeySerializer(String redisKeyPrefix) {
        if (isNotEmpty(redisKeyPrefix)) {
            keyPrefix = redisKeyPrefix + "::";
        } else {
            keyPrefix = "";
        }
    }

    @Override
    public String deserialize(byte[] bytes) {
        String key = super.deserialize(bytes);
        return keyPrefix + key;
    }

    // serialize 方法省略以聚焦问题
}

问题分析

该段代码存在的问题是，在deserialize方法中直接将键前缀添加到了解序列化得到的键值上。这意味着，当从Redis中获取键值对时，会将已经存在于键中的前缀再次添加，导致实际使用的键与存储时的键不一致，进而影响到后续的缓存管理和清理操作，比如使用KEYS命令或者CacheEvict注解进行清除时，可能因为键名不匹配而无法正确清理缓存。
在执行缓存清理操作时，由于反序列化Key时错误地再次添加了前缀，系统无法正确识别并定位到实际的Redis Key，进而导致清理操作失效。

修正方案

修正后的代码如下，重点在于调整了deserialize方法的逻辑，确保正确地去除前缀而非重复添加。

private static class KeySerializer extends StringRedisSerializer {
    private final String keyPrefix;

    public KeySerializer(String redisKeyPrefix) {
        if (isNotEmpty(redisKeyPrefix)) {
            keyPrefix = redisKeyPrefix + "::";
        } else {
            keyPrefix = "";
        }
    }

    @Override
    public String deserialize(byte[] bytes) {
        String s = bytes == null ? null : new String(bytes);
        if (StringUtils.isBlank(s)) {
            return s;
        }
        int index = s.indexOf(keyPrefix);
        if (index != -1) {
            return s.substring(keyPrefix.length());
        }
        return s; // 如果没有找到前缀，则原样返回
    }

    // serialize 方法保持不变
}

解决方案分析

• 修正deserialize方法：在解序列化时，首先检查键是否以设定的前缀开始，如果是，则移除前缀后再返回。这样确保了从Redis读取的键值能准确匹配到业务逻辑中使用的键。
• 保持键值一致性：通过在序列化和反序列化过程中统一处理键前缀，确保了存入和取出的键值对在结构上保持一致，从而解决了清理缓存时的键名不匹配问题。
• 在修正后的版本中，deserialize方法首先检查获取到的字符串是否包含前缀，如果是，则移除该前缀再返回Key，确保了当从Redis检索Key用于匹配或删除时，能够正确无误地识别每一个Key。

总结

在Spring Boot应用中配置Redis作为缓存服务时，正确处理键的序列化和反序列化至关重要。通过上述案例的对比分析，我们了解了不当处理键前缀可能导致的问题及其实现上的修正策略。修正后的代码确保了Redis缓存的键值在序列化与反序列化过程中的精确匹配，有效避免了缓存清理时可能遭遇的障碍，提升了应用的稳定性和运维效率。在进行类似配置时，务必注意此类细节处理，以保证系统的健壮性和易维护性。