解決SpringBoot下Redis序列化亂碼的問題

Posted on by

SpringBoot下Redis序列化亂碼

項目最初的序列化方案用的是JDK序列化類，但保存到redis裡會產生亂碼不方便查看管理。

public void setRedisTemplate(RedisTemplate<String, Object> redisTemplate) {
        redisTemplate.setKeySerializer(new JdkSerializationRedisSerializer(Object.class.getClassLoader()));
        redisTemplate.setValueSerializer(new JdkSerializationRedisSerializer(Object.class.getClassLoader()));
        redisTemplate.setHashKeySerializer(new JdkSerializationRedisSerializer(Object.class.getClassLoader()));
        redisTemplate.setHashValueSerializer(new JdkSerializationRedisSerializer(Object.class.getClassLoader()));
        this.redisTemplate = redisTemplate;
    }

經過上網查看是由於序列化類的問題，我們不用jdk的序列化方法，采用json的格式

public void setRedisTemplate(RedisTemplate<String, Object> redisTemplate) {
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        redisTemplate.setValueSerializer(new GenericJackson2JsonRedisSerializer());
        redisTemplate.setHashKeySerializer(new StringRedisSerializer());
        redisTemplate.setHashValueSerializer(new GenericJackson2JsonRedisSerializer());
        this.redisTemplate = redisTemplate;
    }

註意問題

采用上述序列化器時需保證實體類裡的所有get方法都有屬性字段，否則反序列話時會出現問題，若沒有需要加@JsonIgnore註解，序列化時會進行忽略。

SpringBoot配置Redis序列化規則,防止亂碼

SpringBoot引入Redis很簡單，添加以下註解：

然後在application.yml中添加Redis配置：

註：此處有一些額外的配置，比如password等，我這裡為省事就不寫瞭。

下面我們可以編寫測試類瞭

測試後發現一個問題，test:1這樣的key，亂碼瞭。比如我用

Another.Redis.Desktop.Manager工具去查看時，發現變成瞭一串奇奇怪怪的字符串。

亂碼瞭。

這是因為Redis默認序列化規則導致的。RedisTemplate默認的所有序列化規則都是JDKSerializer，而StringRedisTemplate默認的序列化規則是StringRedisSerializer。

具體可以看下圖

我們需要對它進行配置

package com.eknown.config; 
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
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.RedisTemplate;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;
 
/**
 * redis配置
 * 主要是配置Redis的序列化規則，用Jackson2JsonRedisSerializer替換默認的jdkSerializer
 * @author zhangfanghao
 * @version 1.0
 * @date 2019-07-21 21:04
 */
@Configuration
public class RedisConfig { 
 
    @Bean
    public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory connectionFactory) {
        RedisTemplate<Object, Object> redisTemplate = new RedisTemplate<>();
        redisTemplate.setConnectionFactory(connectionFactory);
 
        // 使用Jackson2JsonRedisSerialize替換默認序列化
        Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
 
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
 
        jackson2JsonRedisSerializer.setObjectMapper(objectMapper);
 
        // 設置key和value的序列化規則
        redisTemplate.setValueSerializer(jackson2JsonRedisSerializer);
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        redisTemplate.afterPropertiesSet(); 
        return redisTemplate;
    }
}

註：此處僅重新設置瞭Key和Value的序列化規則，hash-key和hash-value的序列化規則可以參考進行設置。

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：