如何在SpringBoot中设置RedisTemplate的序列化方式

如何在SpringBoot中设置RedisTemplate的序列化方式

1、第一种方式：写配置类（自动序列化）

1.1、导入相关依赖坐标

<!-- redis依赖 -->    
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>
    
<!-- common-pool 连接池 -->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-pool2</artifactId>
        </dependency>

注意事项：Spring Data Redis 默认使用的是Redis的Java客户端Lettuce依赖，如果要使用Jedis，则必须要导入下面的jedis依赖。并且Spring Data Redis 提供的序列化器依赖于Jackson库,所以需要确保相关的依赖已经被引入到项目中。如果没有则引入下面的Jackson库依赖。

<!-- Redis的Java客户端Jedis依赖 -->
        <dependency>
            <groupId>redis.clients</groupId>
            <artifactId>jedis</artifactId>
        </dependency>    
    
<!-- Jackson依赖 -->
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
        </dependency>

1.2、在application.yml文件配置Redis相关信息

# Redis配置
spring:
  redis:
    host: localhost # 连接的IP地址
    port: 6379 # Redis端口号
    #password: 123456  #连接的密码
    database: 0 # 操作的是0号数据库
    #jedis:   # jedis配置,看你使用那种Redis的Java客户端
    lettuce:  # lettuce配置,看你使用那种Redis的Java客户端
        # 连接池配置
        pool:
          max-active: 8 # 连接池的最大连接数
          max-idle: 8    # 连接池中的最大空闲连接
          min-idle: 0     # 连接池中的最小空闲连接
          max-wait: 10ms   # 连接池最大阻塞等待时间

1.3、编写RedisConfig配置类信息

@Configuration
public class RedisConfig {
    
    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
        // 创建RedisTemplate对象
        RedisTemplate<String, Object> template = new RedisTemplate<>();
        // 设置Redis连接工厂
        template.setConnectionFactory(redisConnectionFactory);
        // 创建JSON序列化器（两种设置Value和HashValue的JSON的序列化器）
        GenericJackson2JsonRedisSerializer genericJackson2JsonRedisSerializer 
                                                          = new GenericJackson2JsonRedisSerializer();
        /*Jackson2JsonRedisSerializer jackson2JsonRedisSerializer
                                                          = new Jackson2JsonRedisSerializer<>(Object.class);*/

        // 设置Key和HashKey采用String序列化
        template.setKeySerializer(RedisSerializer.string());
        template.setHashKeySerializer(RedisSerializer.string());
        // 设置Value和HashValue采用JSON的序列化
        template.setValueSerializer(genericJackson2JsonRedisSerializer);
        template.setHashValueSerializer(genericJackson2JsonRedisSerializer);
        //template.setValueSerializer(jackson2JsonRedisSerializer);
        //template.setHashValueSerializer(jackson2JsonRedisSerializer);
        return template;
    }

}

1.4、测试案例

@SpringBootTest
class RedisTemplateTests {

    @Autowired
    private RedisTemplate<String,Object> redisTemplate;

    @Test
    void testUser() {
        // 向Redis数据库写入数据
        User user1 = new User(1,"Redis",36);
        redisTemplate.opsForValue().set("user:1", user1);

        // 向Redis数据库获取数据
        Object user2 = redisTemplate.opsForValue().get("user:1");
        System.out.println(user2);
    }
}

2、第二种方式：使用 StringRedisTemplate（手动序列化）

2.1、导入相关依赖

<!-- redis依赖 -->    
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>
    
<!-- common-pool连接池 -->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-pool2</artifactId>
        </dependency>

注意事项：Spring Data Redis 默认使用的是Redis的Java客户端Lettuce依赖，如果要使用Jedis，则必须要导入下面的jedis依赖。并且Spring Data Redis 提供的序列化器依赖于Jackson库,所以需要确保相关的依赖已经被引入到项目中。如果没有则引入下面的Jackson库依赖。

<!-- Redis的Java客户端Jedis -->
        <dependency>
            <groupId>redis.clients</groupId>
            <artifactId>jedis</artifactId>
        </dependency>    
    
<!-- Jackson依赖 -->
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
        </dependency>

2.2、在application.yml文件配置Redis相关信息

# Redis配置
spring:
  redis:
    host: localhost # 连接的IP地址
    port: 6379 # Redis端口号
    #password: 123456  #连接的密码
    database: 0 # 操作的是0号数据库
    #jedis:   # jedis配置,看你使用那种Redis的Java客户端
    lettuce:  # lettuce配置,看你使用那种Redis的Java客户端
        # 连接池配置
        pool:
          max-active: 8 # 连接池的最大连接数
          max-idle: 8    # 连接池中的最大空闲连接
          min-idle: 0     # 连接池中的最小空闲连接
          max-wait: 10ms   # 连接池最大阻塞等待时间

2.3、测试案例

@SpringBootTest
class StringRedisTemplateTests {
    
    private static final ObjectMapper mapper = new ObjectMapper();

    @Autowired
    private StringRedisTemplate stringRedisTemplate;

    @Test
    void testUser() throws JsonProcessingException {
        // 向Redis数据库写入数据
        User user1 = new User(2, "Redis2", 18);
        // 手动序列化对象为JSON对象
        String jsonUser1 = mapper.writeValueAsString(user1);
        // 写入数据
        stringRedisTemplate.opsForValue().set("user:2", jsonUser1);

        // 向Redis数据库获取数据
        String jsonUser2 = stringRedisTemplate.opsForValue().get("user:2");
        // 手动反序列化对象为Java对象
        User user2 = mapper.readValue(jsonUser2, User.class);
        System.out.println(user2);
    }
}

3、总结

第一种方式：采用自动序列化的方式，会将类的class类型写入json数据中，一并存入到Redis数据库当中。会带来额外的内存开销。

第二种方式：采用手动序列化的方式，需要我们手动序列化java对象与json对象。不会带来额外的内存开销。