RedisTemplate的key默认序列化器问题

本文解决了一个在Spring Boot应用中使用Redis时遇到的奇怪问题:当在同一方法内先后调用HSet和HGet操作时一切正常,但在不同方法间执行同样的操作时却无法获取数据。通过对RedisTemplate序列化器的深入分析,最终找到了解决方案。

redis的客户端换成了spring-boot-starter-data-redis,碰到了一个奇怪的问题,

在同一个方法中

1.先hset,再hget,正常获得数据。

在不同的方法中 先hset,再hget获取不到数据,通过redis的monitor监控发现了命令的问题:


实际我的key为JK_HASH:csrk,hashkey为user,但是根据上图所示,实际执行的命令多了好多其他字符,这是什么原因呢?

在服务器端先确认发现实际有这个Hash,通过hset可以得到正确的数据,所以第一次执行hset的时候命令是正常的,问题可能出现在hget上面,先打开源码看一下

	@SuppressWarnings("unchecked")
	public HV get(K key, Object hashKey) {
		final byte[] rawKey = rawKey(key);
		final byte[] rawHashKey = rawHashKey(hashKey);

		byte[] rawHashValue = execute(new RedisCallback<byte[]>() {

			public byte[] doInRedis(RedisConnection connection) {
				return connection.hGet(rawKey, rawHashKey);
			}
		}, true);

		return (HV) deserializeHashValue(rawHashValue);
	}

从这里可以看到实际上传给redis的都是byte数据,而byte数组是rawKey和rawHashKey生成的,先看下rawKey方法

	@SuppressWarnings("unchecked")
	byte[] rawKey(Object key) {
		Assert.notNull(key, "non null key required");
		if (keySerializer() == null && key instanceof byte[]) {
			return (byte[]) key;
		}
		return keySerializer().serialize(key);
	}
然后进一步跟踪keySerializer()方法
	RedisSerializer keySerializer() {
		return template.getKeySerializer();
	}
	public RedisSerializer<?> getKeySerializer() {
		return keySerializer;
	}

最后跟踪到是RedisTemplate中的属性keySerializer导致的,而通过打印keySerializer的class发现 默认使用的是org.springframework.data.redis.serializer.JdkSerializationRedisSerializer,但它是如何进行初始化的呢,默认的构造函数中并没有对该属性进行初始化。

根据RedisTemplate的类关系发现它是继承RedisAccessor的,而此类是实现的org.springframework.beans.factory.InitializingBean接口,这个接口有个特性,凡是继承该接口的类,在初始化bean的时候会执行afterPropertiesSet方法。

而afterPropertiesSet方法中,确实对keySerializer进行了初始化:

public void afterPropertiesSet() {
super.afterPropertiesSet();
boolean defaultUsed = false;
if (defaultSerializer == null) {
defaultSerializer = new JdkSerializationRedisSerializer(
classLoader != null ? classLoader : this.getClass().getClassLoader());
}
if (enableDefaultSerializer) {
if (keySerializer == null) {
keySerializer = defaultSerializer;
defaultUsed = true;
}
if (valueSerializer == null) {
valueSerializer = defaultSerializer;
defaultUsed = true;
}
if (hashKeySerializer == null) {
hashKeySerializer = defaultSerializer;
defaultUsed = true;
}
if (hashValueSerializer == null) {
hashValueSerializer = defaultSerializer;
defaultUsed = true;
}
}
if (enableDefaultSerializer && defaultUsed) {
Assert.notNull(defaultSerializer, "default serializer null and not all serializers initialized");
}


if (scriptExecutor == null) {
this.scriptExecutor = new DefaultScriptExecutor<K>(this);
}
initialized = true;
}

在这里可以看到默认使用的正是org.springframework.data.redis.serializer.JdkSerializationRedisSerializer,而问题正在这里,通过查询可以发现序列化器有这些,而在这里我们需要使用的是StringRedisSerializer


加入如下代码:

	@Autowired(required = false)
	public void setRedisTemplate(RedisTemplate redisTemplate) {
	    RedisSerializer stringSerializer = new StringRedisSerializer();
	    redisTemplate.setKeySerializer(stringSerializer);
	    redisTemplate.setValueSerializer(stringSerializer);
	    redisTemplate.setHashKeySerializer(stringSerializer);
	    redisTemplate.setHashValueSerializer(stringSerializer);
	    this.redisTemplate = redisTemplate;
	}
重新进行测试,方法1hset,方法2hget,方法2能拿到正确的数据,完毕。


`RedisTemplate` 是 Spring Data Redis 提供的用于操作 Redis 的核心类,它默认使用以下**序列化方式**: --- ### 🔍 RedisTemplate 默认的序列化方式 | 操作对象 | 默认使用的序列化器 | 类型 | |----------|---------------------|------| | Key(键) | `JdkSerializationRedisSerializer` | 序列化 `byte[]` | | Value(值) | `JdkSerializationRedisSerializer` | 序列化 `byte[]` | | Hash Key(哈希键) | `JdkSerializationRedisSerializer` | 序列化 `byte[]` | | Hash Value(哈希值) | `JdkSerializationRedisSerializer` | 序列化 `byte[]` | --- ### ❓ 为什么会导致 key 出现乱码? 因为 `JdkSerializationRedisSerializer` 是使用 Java 原生序列化机制(`ObjectInputStream` / `ObjectOutputStream`)将对象序列化为字节数组(`byte[]`)存储的。 当你使用 `RedisTemplate` 存储字符串 key 时,例如: ```java redisTemplate.opsForValue().set("name", "Tom"); ``` - 默认会将 `"name"` 这个字符串使用 `JdkSerializationRedisSerializer` 序列化为字节数组。 - 存入 Redis 的 key 并不是 `"name"`,而是一串类似 `xAC\xED\x00\x05t\x00\x04name` 的二进制数据。 - 在 Redis 客户端(如 `redis-cli`)中查看时,就显示为乱码。 --- ### ✅ 示例代码(使用默认配置) ```java @Autowired private RedisTemplate redisTemplate; public void testDefaultSerialization() { redisTemplate.opsForValue().set("username", "john_doe"); } ``` - 在 Redis 中实际存储的 key 是经过 JDK 序列化的字节数组。 - 使用 `redis-cli keys *` 查看时,key 会显示为乱码,例如:`xac\xed\x00\x05t\x00\x08username`。 --- ### ✅ 如何解决乱码问题? 你需要将 key序列化器设置为 `StringRedisSerializer`,它会将字符串直接转换为 `byte[]` 而不进行 Java 原生序列化。 --- ### ✅ 推荐配置(解决乱码) ```java @Bean public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) { RedisTemplate<String, Object> template = new RedisTemplate<>(); template.setConnectionFactory(factory); // 设置 key 的序列化方式为 StringRedisSerializer template.setKeySerializer(new StringRedisSerializer()); template.setHashKeySerializer(new StringRedisSerializer()); // 设置 value 的序列化方式为 GenericJackson2JsonRedisSerializer(将对象转为 JSON) template.setValueSerializer(new GenericJackson2JsonRedisSerializer()); template.setHashValueSerializer(new GenericJackson2JsonRedisSerializer()); template.afterPropertiesSet(); return template; } ``` --- ### ✅ 配置后效果 ```java redisTemplate.opsForValue().set("username", "john_doe"); ``` - 此时 Redis 中存储的 key 就是 `"username"` 字符串。 - 使用 `redis-cli` 查看时不会出现乱码。 --- ### 🧠 总结 | 内容 | 说明 | |------|------| | 默认序列化器 | `JdkSerializationRedisSerializer` | | 问题 | 导致 key 和 value 出现乱码(如 `xac\xed\x00\x05t\x00\x04name`) | | 原因 | 使用了 Java 原生序列化机制,将字符串包装成 `Serializable` 对象进行序列化 | | 解决方案 | 使用 `StringRedisSerializer` 序列化 key,使用 `GenericJackson2JsonRedisSerializer` 或 `Jackson2JsonRedisSerializer` 序列化 value | ---
评论 1
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值