Spring Data 操作 Redis 时，key值出现 \xac\xed\x00\x05t\x00

使用 spring-data-redis RedisTemplate 操作 redis 时发现存储在 redis 中的 key 不是设置的 string 值，前面还多出了许多类似 \xac\xed\x00\x05t\x00 这种字符串，如下：

127.0.0.1:6379> keys *
1) "\xac\xed\x00\x05t\x00\x04pass"
2) "\xac\xed\x00\x05t\x00\x04name"
3) "name"

分析

分析 spring-data 的 org.springframework.data.redis.core.RedisTemplate 源代码以后发现：

private RedisSerializer<?> defaultSerializer = new JdkSerializationRedisSerializer();

private RedisSerializer keySerializer = null;
private RedisSerializer valueSerializer = null;
private RedisSerializer hashKeySerializer = null;
private RedisSerializer hashValueSerializer = null;
private RedisSerializer<String> stringSerializer = new StringRedisSerializer();

因为 spring 操作 redis 是在 jedis 客户端基础上进行的，而 jedis 客户端与 redis 交互的时候协议中定义是用 byte 类型交互，jedis 中提供了 string 类型转为 byte[] 类型，但是看到 spring-data-redis 中 RedisTemplate<K, V> 在操作的时候 k，v 是泛型的，所以 RedisTemplate 中有了上面那段代码。

在没有特殊定义的情况下，spring 默认采用 defaultSerializer = new JdkSerializationRedisSerializer(); 来对 key，value 进行序列化操作，在经过查看 JdkSerializationRedisSerializer 中对序列化的一系列操作，发现如下代码：

private Converter<Object, byte[]> serializer = new SerializingConverter();
public byte[] serialize(Object object) {
    if (object == null) {
        return SerializationUtils.EMPTY_ARRAY;
    }
    try {
        return serializer.convert(object);
    } catch (Exception ex) {
        throw new SerializationException("Cannot serialize", ex);
    }
}

序列化支持的是 Object 对象，调用了 SerializingConverter 类下的 convert 方法转换对象，转换对象的方法是：

private final Serializer<Object> serializer;
/**
 * Serializes the source object and returns the byte array result.
 */
public byte[] convert(Object source) {
    ByteArrayOutputStream byteStream = new ByteArrayOutputStream(128);
    try  {
        this.serializer.serialize(source, byteStream);
        return byteStream.toByteArray();
    }
    catch (Throwable ex) {
        throw new SerializationFailedException("Failed to serialize object using " +
                this.serializer.getClass().getSimpleName(), ex);
    }
}

原因其实就出现在这里，解决的办法就是手动定义序列化的方法。

xml 配置

spring-data-redis 中还提供了一个序列化的类专门针对 string 类型的序列化 org.springframework.data.redis.serializer.StringRedisSerializer 这个类，可以在 xml 里面指定：

<bean id="redisTemplate" class="org.springframework.data.redis.core.RedisTemplate"
    p:connection-factory-ref="jedisConnectionFactory">
    <property name="keySerializer">
        <bean class="org.springframework.data.redis.serializer.StringRedisSerializer" />
    </property>
    <property name="valueSerializer">
        <bean class="org.springframework.data.redis.serializer.StringRedisSerializer" />
    </property>
    <property name="hashKeySerializer">
        <bean class="org.springframework.data.redis.serializer.StringRedisSerializer" />
    </property>
    <property name="hashValueSerializer">
        <bean class="org.springframework.data.redis.serializer.StringRedisSerializer" />
    </property>
</bean>

其中将 redis 中基础类型的 key，value 和 hash 类型的 key，value 都指定为 StringRedisSerializer 类来进行序列化，然后发现又报错了，找了一会发现代码中：

public void setBank(final Bank bank) {
    // TODO setBank
    final String key = String.format("bank:%s", bank.getId());
    final Map<String, Object> properties = new HashMap<String, Object>();

    properties.put("id", bank.getId());
    properties.put("name", bank.getBank_name());

    redisTemplate.opsForHash().putAll(key, properties);
}

bank.getId 是 Integer 类型的，因为 Hashmap 中的 key 和 value 也会进行序列化操作，而 StringRedisSerializer 中的 serialize 方法只接收 String 类型的值，如下：

public byte[] serialize(String string) {
    return (string == null ? null : string.getBytes(charset));
}

所以这里的类型转换报错了，直接 bank.getId().toString()，执行成功，然后进入 redis 控制台打开查看发现 \xac\xed\x00\x05t\x00 没有了。

java config 配置

XML 配置还是有一定局限性的，目前很多项目开发其实也不用 XML 配置了。我们可以在 redis config 中重新指定序列化方式。

private RedisTemplate redisTemplate;

@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;
}