RedisTemplate序列化

梦里梦外; 2024-02-05 21:01 32阅读 0赞

SpringBoot整合Redis，配置RedisTemplate序列化。如果使用StringRedisTemplate，那么不需要配置序列化，但是StringRedisTemplate只能存储简单的String类型数据，如图：

![4e1f2c5e91c94814a34747f68e454e86.png][]  
如果使用StringRedisTemplate存储一个常规对象，只能转换成JSON字符串存储，取出后再把JSON字符串转成需要的对象，比较麻烦，所以一般使用RedisTemplate。

## **一、**RedisTemplate配置使用 ##

使用RedisTemplate之前一般需要配置序列化方式，这里以单节点Redis为例：

### 1、添加maven依赖 ###

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-data-redis</artifactId>
            </dependency>

###    2、添加配置 ###

import lombok.extern.slf4j.Slf4j;
    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.GenericJackson2JsonRedisSerializer;
    import org.springframework.data.redis.serializer.StringRedisSerializer;
    
    /**
     * Redis配置
     */
    @Slf4j
    @Configuration
    public class RedisConfig {
    
        /**
         * 实例化 RedisTemplate 对象
         * 设置序列化方式
         * 默认序列化为：JdkSerializationRedisSerializer
         * JdkSerializationRedisSerializer       占用空间小，序列化速度慢，客户端可读性差
         * GenericJackson2JsonRedisSerializer    占用空间大，序列化速度快，客户端可读性好
         *
         * @return
         */
        @Bean
        public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {
            log.info("redisTemplate init. serializer=GenericJackson2JsonRedisSerializer");
            RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
            StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();
            // 设置 key 的序列化器 StringRedisSerializer
            redisTemplate.setKeySerializer(stringRedisSerializer);
            redisTemplate.setHashKeySerializer(stringRedisSerializer);
            // 设置 value 的序列化器 GenericJackson2JsonRedisSerializer
            GenericJackson2JsonRedisSerializer genericJackson2JsonRedisSerializer = new GenericJackson2JsonRedisSerializer();
            redisTemplate.setHashValueSerializer(genericJackson2JsonRedisSerializer);
            redisTemplate.setValueSerializer(genericJackson2JsonRedisSerializer);
            redisTemplate.setConnectionFactory(factory);
            return redisTemplate;
        }

###    3、使用    ###

import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.data.redis.core.RedisTemplate;
    import org.springframework.stereotype.Component;
    import java.util.concurrent.TimeUnit;
    
    /**
     * Redis常用方法
     */
    @Component
    public class RedisCache {
    
        /**
         * 1分钟，单位：秒
         */
        private static final long ONE_MINUTE = 60;
    
        @Autowired
        private RedisTemplate redisTemplate;
    
        /**
         * 存储
         * @param key   唯一键
         * @param value     值
         * @param expireTime    过期时间，单位：秒
         * @param <T>
         */
        public <T> void set(String key, T value, long expireTime) {
            redisTemplate.opsForValue().set(key, value, expireTime, TimeUnit.SECONDS);
        }
    
        /**
         * 查询
         * @param key   唯一键
         * @param <T>
         * @return
         */
        public <T> T get(String key) {
            return (T) redisTemplate.opsForValue().get(key);
        }
        /**
         * 查询剩余过期时间
         * @param key   唯一键
         * @return
         */
        public Long getRemainExpire(String key) {
            return redisTemplate.opsForValue().getOperations().getExpire(key);
        }
    
        /**
         * 设置过期时间
         * @param key   唯一键
         * @param expireTime    过期时间，单位：秒
         * @return
         */
        public Boolean setExpire(String key, long expireTime) {
            return redisTemplate.opsForValue().getOperations().expire(key,expireTime, TimeUnit.SECONDS);
        }
    }

## 4.总结 ##

RedisTemplate默认使用的是JDK 序列化方式(JdkSerializationRedisSerializer) ，这种序列化方式可以不用在配置类里配置，默认即可，这种不推荐使用,这种方式对应客户端来说可读性差，不利于人工排查问题。

所以一般用JSON序列化，JSON序列化方式又有两种，GenericJackson2JsonRedisSerializer和Jackson2JsonRedisSerializer，GenericJackson2JsonRedisSerializer配置更简单方便些。

对比一下JDK 序列化和JSON序列化的可读性，如图：

JDK 序列化：  
![119472844bba47dbbb5a3fcfbaf3e069.png][]

JSON序列化：

![73eb928c1cdd4517ab1b324a57ebde73.png][]

[4e1f2c5e91c94814a34747f68e454e86.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/2e2ddce678ea4baf966c1341ff61101d.png
[119472844bba47dbbb5a3fcfbaf3e069.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/946dc5988db741059d868e716dc1785e.png
[73eb928c1cdd4517ab1b324a57ebde73.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/f456f11f60ab4a7f88e41653ceb39425.png