org.springframework.data.redis 是 Spring 框架对 Redis 的默认集成,我们在实际项目中,也经常使用它的 RedisTemplate 去操作 Redis,一般来说没什么问题,但是细心一点的同学会发现,经过这种方法写入 redis 的数据会出现乱码问题
问题复现
项目依赖
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> </dependency>
Redis 配置
- yaml 文件配置
spring: application: name: booklet-redis redis: host: 127.0.0.1 port: 6379 password: adminadmin timeout: 5000ms
- Redis 配置类
package com.liumapp.booklet.redis.config; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.data.redis.connection.RedisConnectionFactory; import org.springframework.data.redis.core.*; import org.springframework.data.redis.serializer.JdkSerializationRedisSerializer; import org.springframework.data.redis.serializer.StringRedisSerializer; @Configuration public class RedisConfig { /** * 注入 RedisConnectionFactory */ @Autowired RedisConnectionFactory redisConnectionFactory; @Bean public RedisTemplate<String,Object> functionDomainRedisTemplate() { RedisTemplate<String,Object> redisTemplate = new RedisTemplate<>(); initDomainRedisTemplate(redisTemplate, redisConnectionFactory); return redisTemplate; } /** * 设置数据存入 redis 的序列化方式 * * @param redisTemplate * @param factory */ private void initDomainRedisTemplate(RedisTemplate<String,Object> redisTemplate, RedisConnectionFactory factory) { redisTemplate.setKeySerializer(new StringRedisSerializer()); redisTemplate.setHashKeySerializer(new StringRedisSerializer()); redisTemplate.setHashValueSerializer(new JdkSerializationRedisSerializer()); redisTemplate.setValueSerializer(new JdkSerializationRedisSerializer()); redisTemplate.setConnectionFactory(factory); } /** * 实例化 HashOperations 对象,可以使用 Hash 类型操作 * * @param redisTemplate * @return */ @Bean public HashOperations<String, String, Object> hashOperations(RedisTemplate<String, Object> redisTemplate) { return redisTemplate.opsForHash(); } /** * 实例化 ValueOperations 对象,可以使用 String 操作 * * @param redisTemplate * @return */ @Bean public ValueOperations<String, Object> valueOperations(RedisTemplate<String, Object> redisTemplate) { return redisTemplate.opsForValue(); } /** * 实例化 ListOperations 对象,可以使用 List 操作 * * @param redisTemplate * @return */ @Bean public ListOperations<String, Object> listOperations(RedisTemplate<String, Object> redisTemplate) { return redisTemplate.opsForList(); } /** * 实例化 SetOperations 对象,可以使用 Set 操作 * * @param redisTemplate * @return */ @Bean public SetOperations<String, Object> setOperations(RedisTemplate<String, Object> redisTemplate) { return redisTemplate.opsForSet(); } /** * 实例化 ZSetOperations 对象,可以使用 ZSet 操作 * * @param redisTemplate * @return */ @Bean public ZSetOperations<String, Object> zSetOperations(RedisTemplate<String, Object> redisTemplate) { return redisTemplate.opsForZSet(); } }
测试代码
package com.liumapp.booklet.redis; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.data.redis.core.ListOperations; import org.springframework.test.context.junit4.SpringRunner; import javax.annotation.Resource; import java.util.ArrayList; import java.util.List; @SpringBootTest(classes = BookletRedisMain.class) @RunWith(SpringRunner.class) public class BookletRedisMainTest { @Resource private ListOperations<String, Object> listOperations; @Test public void leftPushTest () { List<String> list = new ArrayList<>(); list.add("hello world"); listOperations.leftPush("listKey", list); } }
运行上述测试代码后,我们会在 redis 中插入一组 list 类型的数据,其 key 为 listKey,value 为只有一个元素的 list 对象
接下来我们通过 redis-cli 去获取 listKey 这个值,可以看到乱码的出现:
127.0.0.1:6379> LRANGE listKey 0 10 1) "\xac\xed\x00\x05sr\x00\x13java.util.ArrayListx\x81\xd2\x1d\x99\xc7a\x9d\x03\x00\x01I\x00\x04sizexp\x00\x00\x00\x01w\x04\x00\x00\x00\x01t\x00\x0bhello worldx"
当然,这对于我们项目的实际使用没有什么影响,在程序中再次获取 listKey 也不会出现乱码,只有通过 redis-cli 等工具直接取值的时候,才会出现乱码
问题出现原因
问题原因在于我们对 Redis 进行配置的这一段代码(事实上这也是 redisTemplate 的默认配置代码):
private void initDomainRedisTemplate(RedisTemplate<String,Object> redisTemplate, RedisConnectionFactory factory) { redisTemplate.setKeySerializer(new StringRedisSerializer()); redisTemplate.setHashKeySerializer(new StringRedisSerializer()); redisTemplate.setHashValueSerializer(new JdkSerializationRedisSerializer()); redisTemplate.setValueSerializer(new JdkSerializationRedisSerializer()); redisTemplate.setConnectionFactory(factory); }
在这里,redisTemplate 对 HashValue 和 Value 的序列化类采用的是 JDK 默认的序列化策略,而不是 String 类型的序列化策略,所以我们在 redis-cli 中看到的 value 会因为序列化策略的问题,出现乱码
解决办法
将 JDK 默认的序列化策略更换为 String 类型的序列化策略
redisTemplate.setHashValueSerializer(new StringRedisSerializer()); redisTemplate.setValueSerializer(new StringRedisSerializer());
但是这样做的话,我们在进行存储的时候,也只能存储 String 类型的数据,所以测试代码要进行如下修改
@Test public void leftPushTest () { List<String> list = new ArrayList<>(); list.add("hello world2"); listOperations.leftPush("listKey", list.toString()); }
再一次去 redis-cli 中取值,得到如下结果:
127.0.0.1:6379> LRANGE listKey 0 10 1) "[hello world2]" 2) "\xac\xed\x00\x05sr\x00\x13java.util.ArrayListx\x81\xd2\x1d\x99\xc7a\x9d\x03\x00\x01I\x00\x04sizexp\x00\x00\x00\x01w\x04\x00\x00\x00\x01t\x00\x0bhello worldx"
可以发现乱码问题已经解决
总结
不建议更换 redisTemplate 默认的序列化策略,有乱码就让它乱着吧,反正知道正确的解码策略就不会影响程序的正常运行(不过通过 php 等其他语言去获取 redis 的值貌似不太好解决)
如果一定要更换策略,那么前往要注意,存储数据的类型要根据所选择的序列化策略去进行切换
项目案例源代码:github/booklet-redis
欢迎来到这里!
我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。
注册 关于