Redis序列化、RedisTemplate序列化方式大解读，介绍Genericjackson2jsonredisserializer序列化器的坑

前言

上一篇已经介绍了优雅的操作Redis：

【小家Spring】Spring Boot中使用RedisTemplate优雅的操作Redis，并且解决RedisTemplate泛型注入的问题。本篇着重介绍一

下几种常用的序列化方式

最近在做一个项目，由于并发量大，大量使用到了RedisTemplate来操作Redis。但使用过程中，遇到了不少的坑，各种翻看源码

来跟踪，也总结出了不少的经验。

因此今天专门做一篇专文来记录这些坑，也具体说说RedisTemplate的各种序列化方式的差异性。希望对大家也能有所帮助，帮

助大家解决一些疑惑

序列化问题

RedisTemplate在遇到复杂类型的返序列化时，即使加了泛型，获取到的实际类型为LinedHashMap，需要得到结果后再次反序列

化，不然会报类型转换异常。

如下：这样处理才是安全的：

在执行序列化的时候，操作的如果是Bean，必须有默认构造器，否则报错

redis集群问题（关于集群的这几个问题，后续在专门演示和解释）

如果连接的为Redis集群，则不能用管道的方法，除非改写管道的类

模糊查询的时候需要获取到所有的node信息，依次查询

Spring提供的序列化方式

从源码里看：

我们可以很清晰的看到，Spring为我们提供了6种不同的序列化方式。

特别说明一下：如果你是在Spring Boot1.5.x环境下使用，你可能看到是9种实现或者是7种实现，如下图所示

解释：

关于前面两个，并非Spring官方提供，而是由alibaba的FastJson自己实现的。我们看看FastJson的包结构，发现它很友好的提供了一些常用的转化器：

因此此处暂时不做过多描述，后面再说。

另外还有一个JacksonJsonRedisSerializer类，被标记为过期。而这个类在SpringBoot2.0就直接被移除掉了，因此以后的版本不用理会了。

下面主要介绍一下，Spring官方现在还存在的6大序列化器：

Generic单词意思：一般的; 通用的；类的，属性的;

• OxmSerializer

以xml格式存储（但还是String类型~），解析起来也比较复杂，效率也比较低。因此几乎没有人再使用此方式了

• JdkSerializationRedisSerializer

从源码里可以看出，这是RestTemplate类默认的序列化方式。若你没有自定义，那就是它了。

    @Override
    public void afterPropertiesSet() {
        super.afterPropertiesSet();

        boolean defaultUsed = false;
        if (defaultSerializer == null) {
            defaultSerializer = new JdkSerializationRedisSerializer(
                    classLoader != null ? classLoader : this.getClass().getClassLoader());
        }
        ...

使用JDK自带的序列化方式，有明显的缺点：

首先它要求存储的对象都必须实现java.io.Serializable接口，比较笨重

其次，他存储的为二进制数据，这对开发者是不友好的

再次，因为他存储的为二进制。但是有时候，我们的Redis会在一个项目的多个project中共用，这样如果同一个可以缓存的对象

在不同的project中要使用两个不同的key来分别缓存，既麻烦，又浪费。

使用JDK提供的序列化功能。 优点是反序列化时不需要提供（传入）类型信息(class)，但缺点是需要实现Serializable接口，还有

序列化后的结果非常庞大，是JSON格式的5倍左右，这样就会消耗redis服务器的大量内存。

    @Autowired
    private RedisTemplate redisTemplate;

    @Test
    public void contextLoads() {
        ValueOperations valueOperations = redisTemplate.opsForValue();
        valueOperations.set("aaa", new Person("fsx", 24));

        Person p = valueOperations.get("aaa"); //Person(name=fsx, age=24)
        System.out.println(p);
    }

存储的为二进制，根本开不出来是什么，对开发者调试也很不友好

• StringRedisSerializer

也是StringRedisTemplate默认的序列化方式，key和value都会采用此方式进行序列化，是被推荐使用的，对开发者友好，轻量

级，效率也比较高。

（例子略）

• GenericToStringSerializer

他需要调用者给传一个对象到字符串互转的Converter（相当于转换为字符串的操作交给转换器去做），个人觉得使用起来其比较麻烦，还不如直接用字符串呢。所以不太推荐使用

后面两种序列化方式是重点

• Jackson2JsonRedisSerializer

从名字可以看出来，这是把一个对象以Json的形式存储，效率高且对调用者友好

优点是速度快，序列化后的字符串短小精悍，不需要实现Serializable接口。

但缺点也非常致命：那就是此类的构造函数中有一个类型参数，必须提供要序列化对象的类型信息(.class对象)。 通过查看源代

码，发现其在反序列化过程中用到了类型信息（必须根据此类型信息完成反序列化）。

• GenericJackson2JsonRedisSerializer

基本和上面的Jackson2JsonRedisSerializer功能差不多，使用方式也差不多，**但是是推荐使用的**

需要注意：（使用区别）

    @Test
    public void contextLoads() {
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        redisTemplate.setValueSerializer(new StringRedisSerializer());
        //ValueOperations valueOperations = stringRedisTemplate.opsForValue();
        //此处泛型 因为编译器无法校验  所以如果value序列化方式是字符串 下面就会报错了
        ValueOperations valueOperations = redisTemplate.opsForValue();
        valueOperations.set("key", new Person("fsx", 24)); //java.lang.ClassCastException: com.fsx.run2.bean.Person cannot be cast to java.lang.String

        Person value = valueOperations.get("key");
        System.out.println(value);
    }

如上，假如我value的序列化方式设置为String序列化器。但是set值的时候放对象了。这个时候就直接报错了，并不会自动调用

toString()方法，此处一定要注意。还需要特别是初始化RestTemplate的时候，value的序列化方式禁止使用有类型偏向的

StringRedisSerializer。若有需要，你直接使用StringRedisTemplate操作即可

Jackson2JsonRedisSerializer和GenericJackson2JsonRedisSerializer的异同

Jackson2JsonRedisSerializer：为我们提供了两个构造方法，一个需要传入序列化对象Class，一个需要传入对象的JavaType:

    public Jackson2JsonRedisSerializer(Class type) {
        this.javaType = getJavaType(type);
    }

    public Jackson2JsonRedisSerializer(JavaType javaType) {
        this.javaType = javaType;
    }

这种的坏处，很显然，我们就不能全局使用统一的序列化方式了，而是每次调用RedisTemplate前，都需要类似这么处理：

redisTemplate.setKeySerializer(RedisSerializerType.StringSerializer.getRedisSerializer());
        redisTemplate.setValueSerializer(new Jackson2JsonRedisSerializer<>(Person.class));

但因为redisTemplate我们都是单例的，所以这样设置显然是非常不可取的行为。虽然它有好处~~~~~~~~~~

这种序列化方式的好处：他能实现不同的Project之间数据互通（因为没有@class信息，所以只要字段名相同即可），因为其实就

是Json的返序列化，只要你指定了类型，就能反序列化成功（因为它和包名无关）

使用这种Json序列化方式果然是可以成功的在不同project中进行序列化和反序列化的。但是，但是，但是：在实际的使用中，我们希望职责单一和高内聚的，所以并不希望我们存在的对象，其它服务可以直接访问，那样就非常不好控制了，因此此种方式也不建议使用~

GenericJackson2JsonRedisSerializer：这种序列化方式不用自己手动指定对象的Class。所以其实我们就可以使用一个全局通用

的序列化方式了。使用起来和JdkSerializationRedisSerializer基本一样。

同样的JdkSerializationRedisSerializer不能序列化和反序列化不同包路径对象的毛病它也有。因为它序列化之后的内容，是存储

了对象的class信息的：

========> Jackson2JsonRedisSerializer的坑：

存储普通对象的时候没有问题，但是当我们存储带泛型的List的时候，反序化就会报错了：

    @Test
    public void contextLoads() {
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        redisTemplate.setValueSerializer(new Jackson2JsonRedisSerializer<>(List.class));
        ValueOperations> valueOperations = redisTemplate.opsForValue();
        valueOperations.set("aaa", Arrays.asList(new Person("fsx", 24), new Person("fff", 30)));

        List p = valueOperations.get("aaa");
        System.out.println(p); //[{name=fsx, age=24}, {name=fff, age=30}]

        List aaa = (List) redisTemplate.opsForValue().get("aaa");
        System.out.println(aaa); //[{name=fsx, age=24}, {name=fff, age=30}]
    }

结论：网上很多帖子都说这样会出问题，但我实验过后发现不会有问题。时间有限，我这个是基于Spring Boot2.1进行测试的，

若你们测试的版本有问题，欢迎告知我，我再做进一步的验证，多谢。

========> GenericJackson2JsonRedisSerializer的坑：

    @Test
    public void contextLoads() {
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        redisTemplate.setValueSerializer(new GenericJackson2JsonRedisSerializer());
        ValueOperations valueOperations = redisTemplate.opsForValue();
        valueOperations.set("aaa", 1L);

        //Long p = valueOperations.get("aaa"); //转换异常 java.lang.Integer cannot be cast to java.lang.Long
        Object p = valueOperations.get("aaa");
        System.out.println(p);
    }

**坑1：**泛型里明明返回的就是Long类型，但你用Long接，就直接抛出转换异常了

从上图中我们可以清晰的看见，get出来返回的真实类型竟然是Integer类型，所以强转肯定报错啊

再看一例：set类型

    @Test
    public void contextLoads() {
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        redisTemplate.setValueSerializer(new GenericJackson2JsonRedisSerializer());
        SetOperations setOperations = redisTemplate.opsForSet();
        setOperations.add("bbb", 1L);
        setOperations.add("bbb", 2L);

        Set p = setOperations.members("bbb");
        System.out.println(p);
    }

我们发现，里面装的竟然，竟然是Integer类型。这种Java泛型的bug我们在之前的博文里有讲述过，特别坑。这个时候这个变量

就是个地雷，只要一碰，就报错

另外，就算你获取的并不是List类型，而是一个值，也必须要转换一下，否则类型转换异常。像下面这么操作才是安全的：

            Object teaIdObj = setOperLong.pop(teaCategoryKey);
            if (teaIdObj != null) {
                log.info("从redis老师仓库{}里拿到了一个老师{}", teaCategoryKey, teaIdObj);
                teacherIds.add(Long.parseLong(teaIdObj.toString()));
            }

类型转换异常原因分析

因为GenericJackson2JsonRedisSerializer这种序列化方式实在是太通用了，所以我还是希望找出原因，解决这个问题的。因此

我就跟踪源码，看看到底是哪里出了问题：

执行setOperations.members("bbb")这句最终都到了RedisTemplate的execute方法：

public  T execute(RedisCallback action, boolean exposeConnection, boolean pipeline) {...}

方法体的这一行，解析了返回的value值：

T result = action.doInRedis(connToExpose);

tips：Spring Boot1.x此处connToExpose使用的是jedis的，而Boot2.x使用的是Lettuce的了。但是对调用者是透明的，可谓非常友好

继续跟踪发现，最终会调用我们配置好的序列化器进行序列化：

    V deserializeValue(byte[] value) {
        if (valueSerializer() == null) {
            return (V) value;
        }
        return (V) valueSerializer().deserialize(value);
    }

因此啥都不说了，到GenericJackson2JsonRedisSerializer去看看它的deserialize方法吧，就在这一句话：

// 调用了jackson的ObjectMapper方法进行返序列化  但是type为Object.class
return mapper.readValue(source, type);

为何我的泛型类型丢失了呢？向上追溯一步，我们发现：

    static > T deserializeValues(@Nullable Collection rawValues, Class type,
            @Nullable RedisSerializer redisSerializer) {
        // connection in pipeline/multi mode
        if (rawValues == null) {
            return (T) CollectionFactory.createCollection(type, 0);
        }

        Collection