Spring Cache自定义序列化解决乱码问题

Spring Cache数据缓存到 Redis中的 value是乱码问题（包含日期格式转换），主要是因为序列化方式导致的。

Spring Cache使用 Redis缓存管理器时，默认 value使用的是 JDK序列化值的方式，所以导致缓存的 value乱码的问题。

查看 RedisCacheManager和RedisCacheConfiguration源码：

解决方案：设置我们自定义的序列化方式。

一、Spring Cache自定义序列化

在上一篇文章的基础上配置序列化方式。

Spring Cache自定义缓存key和过期时间：https://blog.csdn.net/qq_42402854/article/details/139299549

1、创建自定义序列化方式

这里使用 Jackson2JsonRedisSerializer序列化方式实现，你也可以使用其他序列化方式。

    /**
     * 自定义 Jackson2JsonRedisSerializer序列化
     *
     * @return
     */
    private static RedisSerializer<Object> customJackson2JsonRedisSerializer() {
        ObjectMapper objectMapper = new ObjectMapper();
        // 指定要序列化的域，field,get和set,以及修饰符范围，ANY是都有,包括private和public
        objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        // 必须设置序列化输入的类型，否则无法将JSON转化为对象，会转化成Map类型。类必须是非final修饰的，如果final修饰的类，比如String,Integer等会抛出异常
        objectMapper.activateDefaultTyping(LaissezFaireSubTypeValidator.instance, ObjectMapper.DefaultTyping.NON_FINAL);

        // 自定义ObjectMapper的时间处理模块
        JavaTimeModule javaTimeModule = new JavaTimeModule();

        javaTimeModule.addSerializer(LocalDateTime.class, new LocalDateTimeSerializer(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")));
        javaTimeModule.addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")));

        javaTimeModule.addSerializer(LocalDate.class, new LocalDateSerializer(DateTimeFormatter.ofPattern("yyyy-MM-dd")));
        javaTimeModule.addDeserializer(LocalDate.class, new LocalDateDeserializer(DateTimeFormatter.ofPattern("yyyy-MM-dd")));

        javaTimeModule.addSerializer(LocalTime.class, new LocalTimeSerializer(DateTimeFormatter.ofPattern("HH:mm:ss")));
        javaTimeModule.addDeserializer(LocalTime.class, new LocalTimeDeserializer(DateTimeFormatter.ofPattern("HH:mm:ss")));

        objectMapper.registerModule(javaTimeModule);

        // 禁用将日期序列化为时间戳的行为
        objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);

        Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<>(Object.class);
        jackson2JsonRedisSerializer.setObjectMapper(objectMapper);
        return jackson2JsonRedisSerializer;
    }

2、配置自定义序列化方式

通过源码发现缓存的 key使用的是 StringRedisSerializer序列化方式。你可以设置，也可以不设置。因为，对于 key的序列化，StringRedisSerializer也是我们常用的。

Spring Cache序列化配置赋值 SerializationPair对象。可以通过它构建。

RedisSerializationContext.SerializationPair.fromSerializer(RedisSerializer<T> serializer);

在我们自定义的 CustomRedisCacheManager类中添加下面代码。

    /**
     * @param name        must not be {@literal null}. 业务 Cache注解的value|cacheNames
     * @param cacheConfig can be {@literal null}.
     * @return
     */
    @Override
    protected RedisCache createRedisCache(String name, RedisCacheConfiguration cacheConfig) {
        Duration ttl = getTtlByCustomName(name);
        if (ttl == null) {
            // 如果自定义 TTL为空，则设置全局 TTL为7天。
            ttl = Duration.ofDays(7);
        }
        /**
         * Cache缓存配置
         */
        cacheConfig = cacheConfig
                .computePrefixWith(CUSTOM_CACHE_KEY_PREFIX) // 设置缓存key
                .entryTtl(ttl)  // 设置缓存的过期时间，查询不会更新过期时间
                .serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(RedisSerializer.string())) // 缓存 key的序列化方式
                .serializeValuesWith(CUSTOM_JACKSON2JSON_REDIS_SERIALIZER_PAIR) // 缓存 value的序列化方式
        ;
        return super.createRedisCache(name, cacheConfig);
    }

    /**
     * 自定义序列化方式为json
     */
    private static final RedisSerializationContext.SerializationPair<Object> CUSTOM_JACKSON2JSON_REDIS_SERIALIZER_PAIR =
            RedisSerializationContext.SerializationPair
                    //.fromSerializer(new GenericJackson2JsonRedisSerializer());
                    .fromSerializer(customJackson2JsonRedisSerializer());

3、业务使用

    @Cacheable(value = "userCache_#120", key = "#id", unless = "#result==null")
    //@Cacheable(value = "userCache_", key = "#id", unless = "#result==null")
    //@Cacheable(value = "userCache_#0asa", key = "#id", unless = "#result==null")
    @Override
    public UserDTO getById(Long id) {
        if (id == null || id <= 0L) {
            return null;
        }
        UserDO userDO = userMapper.selectById(id);
        return do2DTO(userDO);
    }

– 求知若饥，虚心若愚。