RedisTemplate与Jackson序列化配置详解

在使用Redis进行数据存储和访问的场景中，常常需要通过配置RedisTemplate来定义键值的序列化方式以及连接的基本设置，这样做可以确保数据在Redis中存储时的可读性和一致性，并且方便对复杂对象进行序列化和反序列化。使用合适的序列化方式可以提高性能、降低存储空间的占用，并且避免在读取数据时遇到不必要的兼容性问题。。本文将详细解析RedisConfig类的配置，帮助你更好地理解每一部分的实现。

1. 代码整体描述

我们采用Spring Boot配置Redis连接和序列化方式。以下是RedisConfig类的完整代码：

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.DeserializationFeature;
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.RedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;

@Configuration
public class RedisConfig {

    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
        RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
        RedisSerializer<String> redisSerializer = new StringRedisSerializer();
        redisTemplate.setConnectionFactory(redisConnectionFactory);
        redisTemplate.setKeySerializer(redisSerializer);
        redisTemplate.setHashKeySerializer(redisSerializer);
        redisTemplate.setValueSerializer(jackson2JsonRedisSerializer());
        redisTemplate.setHashValueSerializer(jackson2JsonRedisSerializer());
        return redisTemplate;
    }

    private Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer() {
        Jackson2JsonRedisSerializer<Object> jsonRedisSerializer = new Jackson2JsonRedisSerializer<>(Object.class);
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL, JsonTypeInfo.As.PROPERTY);
        jsonRedisSerializer.setObjectMapper(objectMapper);
        return jsonRedisSerializer;
    }

}

2. 代码详细解析

2.0 方法的作用说明

在RedisConfig类中，有两个主要的方法：

1. redisTemplate(RedisConnectionFactory redisConnectionFactory)

   • 作用：用于配置并创建一个RedisTemplate Bean，这个 Bean 用于和 Redis 进行交互。

   • 具体功能：

     • 通过传入的RedisConnectionFactory，来确保 RedisTemplate 可以连接到 Redis 服务器。
     • 设置键（Key）和哈希键（Hash Key）使用字符串序列化（StringRedisSerializer），确保所有的键以可读的字符串形式存储。
     • 设置值（Value）和哈希值（Hash Value）使用 JSON 序列化（Jackson2JsonRedisSerializer），以便存储 Java 对象时能以 JSON 格式存入 Redis 中。这样做可以更好地对复杂的数据结构进行序列化和反序列化。

2. jackson2JsonRedisSerializer()

   • 作用：用于创建并配置一个Jackson2JsonRedisSerializer，并为其设置合适的对象映射（Object Mapper）。

   • 具体功能：

     • Jackson2JsonRedisSerializer是一个专门用于将 Java 对象序列化为 JSON 格式的工具，特别适用于 Redis 中的复杂对象存储。
     • 创建ObjectMapper并对其进行配置，比如设置对象的可见性、忽略未知属性、启用类型信息等，以确保 Java 对象能够正确地被序列化和反序列化。
     • 设置类型信息时，启用默认类型信息以保留对象的类型结构，这样在反序列化时能够还原对象原本的类型。

2.1 类注解与基本结构

• @Configuration：标注该类为配置类，Spring会自动扫描并加载该配置。
• @Bean：方法上的注解，表示该方法返回的对象会被注册为Spring容器的Bean，可以被其他组件注入使用。

2.2 RedisTemplate Bean的配置

• public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory)：

  • 创建并返回RedisTemplate实例，用于对Redis数据库进行操作。
  • 参数RedisConnectionFactory提供连接工厂，确保与Redis服务的连接。

• redisTemplate.setConnectionFactory(redisConnectionFactory)：

  • 设置连接工厂以连接Redis服务器。

• RedisSerializer<String> redisSerializer = new StringRedisSerializer()：

  • 创建StringRedisSerializer实例，设置键的序列化方式为字符串格式。

• redisTemplate.setKeySerializer(redisSerializer)和redisTemplate.setHashKeySerializer(redisSerializer)：

  • 设置键和Hash键的序列化方式为字符串，以确保键以可读形式存储在Redis中。

• redisTemplate.setValueSerializer(jackson2JsonRedisSerializer())和redisTemplate.setHashValueSerializer(jackson2JsonRedisSerializer())：

  • 设置值和Hash值的序列化方式为JSON格式，使用Jackson库实现，便于存储复杂的对象结构。

2.3 Jackson2JsonRedisSerializer配置

• private Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer()：

  • 创建Jackson2JsonRedisSerializer实例，用于将对象序列化为JSON格式，以便于存储在Redis中。

• ObjectMapper objectMapper = new ObjectMapper()：

  • 创建ObjectMapper实例，用于序列化和反序列化Java对象。

• objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY)：

  • 设置对象的可见性，确保所有属性都可以被序列化和反序列化，无论其访问修饰符如何。

• objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)：

  • 配置ObjectMapper在遇到未知属性时不抛出异常，增强兼容性。

• objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL, JsonTypeInfo.As.PROPERTY)：

  • 启用默认类型信息，以在反序列化时保留对象的类型信息，确保对象能正确还原。需要注意的是，这样做存在潜在的安全风险，因为启用默认类型信息可能导致反序列化时执行恶意代码，从而引发安全漏洞。因此，在使用时需要确保输入数据的安全性，避免从不可信的来源获取数据。。

• jsonRedisSerializer.setObjectMapper(objectMapper)：

  • 将ObjectMapper配置应用到Jackson2JsonRedisSerializer，确保其使用正确的序列化和反序列化规则。