【SpringBoot整合Redis篇】 ---- RedisTemplate自定义序列化

【SpringBoot整合Redis篇】 ---- RedisTemplate自定义序列化

历史文章

1.RedisTemplate自定义序列化

---

---

一、概述

Spring Boot提供了对Reds集成的组件包: spring-boot-starter-data-redis,它依赖于 spring-data-redis和 lettuce。Spring Boot1.0, 默认使用的是 Jedis客户端,2.0替换成了 Lettuce

• Lettuce:是一个可伸缩线程安全的Reds客户端,多个线程可以共享同一个 RedisConnection,它利用优秀 Netty NIO框架来高效地管理多个连接

RedisTemplate中定义了对应redis5种数据结构操作

• opsForvalue(); //操作字符串
• opsForHash(); //操作hash
• opsForList(); //操作list
• opsForSet(); //操作set
• opsForZSet(); //操作有序set

二、使用步骤

2.1 引入redis依赖

<dependency>
	<groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<!--commons-pool2是因为lettuce需要使用commons-pool2创建连接池-->
<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-pool2</artifactId>
</dependency>

2.2 加入配置信息

# Redis服务器地址
spring.redis.host=localhost
# Redis服务器连接端口
spring.redis.port=6379
# 连接池最大连接数(使用负值表示没有限制) 默认8
spring.redis.lettuce.pool.max-active=100
# 连接池最大阻塞等待时间(使用负值表示没有限制) 默认 -1
spring.redis.lettuce.pool.max-wait=PT10s
# 连接池中最大空闲连接
spring.redis.lettuce.pool.max-idle=30
# 连接池中最小空闲连接
spring.redis.lettuce.pool.min-idle=1
# 连接超时时间
spring.redis.timeout=PT10s

2.3 RedisTemplate和StringRedisTemplate区别

在平时的开发中通过Spring注入注解获取RedisTemplate对象的引用

@Autowired
private RedisTemplate<String,Object> redisTemplate;

为什么没有像SpringBoot注入RedisTemplate对象就能直接声明使用呢?

RedisAutoConfiguration源码

通过源码知道,启动SpringBoot后会像Spring一样注入两个Bean, 分别是RedisTemplate、StringRedisTemplate, 查看两者源码比较不同

RedisTemplate源码

public class RedisTemplate<K, V> extends RedisAccessor implements RedisOperations<K, V>, BeanClassLoaderAware {
   
    .....
    
    public RedisTemplate() {
   
    }

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

        if (this.enableDefaultSerializer) {
   
            if (this.keySerializer == null) {
   
                this.keySerializer = this.defaultSerializer;
                defaultUsed = true;
            }

            if (this.valueSerializer == null) {
   
                this.valueSerializer = this.defaultSerializer;
                defaultUsed = true;
            }

            if (this.hashKeySerializer == null) {
   
                this.hashKeySerializer = this.defaultSerializer;
                defaultUsed = true;
            }

            if (this.hashValueSerializer == null) {
   
                this.hashValueSerializer = this.defaultSerializer;
                defaultUsed = true;
            }
        }

        if (this.enableDefaultSerializer && defaultUsed) {
   
            Assert.notNull(this.defaultSerializer, "default serializer null and not all serializers initialized");
        }

        if (this.scriptExecutor == null) {
   
            this.scriptExecutor = new DefaultScriptExecutor(this);
        }

        this.initialized = true;
    }
    ....
	// hash结构数据的hashKey序列化器,默认是JdkSerializationRedisSerializer
	public void setHashKeySerializer(RedisSerializer<?> hashKeySerializer) {
   
        this.hashKeySerializer = hashKeySerializer;
    }

    public void setKeySerializer(RedisSerializer<?> serializer) {
   
        this.keySerializer = serializer;
    }
	
	public void setValueSerializer(RedisSerializer<?> serializer) {
   
        this.valueSerializer = serializer;
    }

	public void setHashValueSerializer(RedisSerializer<?> hashValueSerializer) {
   
        this.hashValueSerializer = hashValueSerializer;
    }
    .....

StringRedisTemplate 源码

public class StringRedisTemplate extends RedisTemplate<String, String> {
   
    public StringRedisTemplate() {
   
        this.setKeySerializer(RedisSerializer.string());
        this.setValueSerializer(RedisSerializer.string());
        this.setHashKeySerializer(RedisSerializer.string());
        this.setHashValueSerializer(RedisSerializer.string());
    }

    public StringRedisTemplate(RedisConnectionFactory connectionFactory) {
   
        this();
        this.setConnectionFactory(connectionFactory);
        this.afterPropertiesSet();
    }

    protected RedisConnection preProcessConnection(RedisConnection connection, boolean existingConnection) {
   
        return new DefaultStringRedisConnection(connection);
    }
}

两者区别:

• 两者关系是StringRedisTemplate继承RedisTemplate
• RedisTemplate是一个泛型类,而StringRedisTemplate不是
• StringRedisTemplate只能对key=String, value=String的键值对进行操作,而RedisTemplate可以对任何类型的key-value键值对操作
• 各自的序列化方式不同,但最终得到的都是一个字节数组,StringRedisTemplate使用的是StringRedisSerializer类;RedisTemplate使用的是JdkSerializationRedisSerializer类。反序列化时,一个得到String,一个得到Object
  另外针对数据的"序列化/反序列化",提供了多种可选择策略(RedisSerializer)
  • JdkSerializationRedisSerializer:这个序列化方法是jdk提供的。首先要求我们要被序列化的类继承自 Serializable接口,然后通过jdk对象序列化的方法保存。(注:这个序列化保存的对象,即使是个 String类型的,在redis控制台,也是看不出来的,因为它保存了一些对象的类型额外信息)。是目前最常用的序列化策略。
  • StringRedisSerializer:就是通过string.getBytes0来实现的。而且在 Redist中,所有存储的值都是字符串类型的。所以这种方法保存后,通过 Redis-c控制台,可以清楚查看我们保存了什么。是最轻量级和高效的策略。
  • JacksonJsonRedisSerializer: jackson- json工具提供了 javabean与json之间的转换能力,可以将pojo实例序列化成json格式存储在redis中,也可以将json格式的数据转换成pojo实例。因为 jackson工具在序列化和反序列化时,需要明确指定Class类型,因此策略封装起来稍微复杂。

2.4 RedisTemplate和StringRedisTemplate代码案例

RedisTemplate

@SpringBootTest
@RunWith(SpringRunner.class)
public class RedisTemplateApplicationTests {
   

	@Test
	public void contextLoads() {
   
	}
	
	@Autowired
	private RedisTemplate redisTemplate;
	
	@Test
	public void testRedis(){
   
		redisTemplate.opsForValue().set("username", "张三");
		System.out.println(redisTemplate.opsForValue().get("username"));
	}
}

RedisTemplate在操作数据的时候,存入数据会将数据先序列化成字节数组,然后在存入Redis数据库(默认JdkSerializationRedisSerializer:这个序列化方法是jdk提供的。首先要求我们要被序列化的类继承自 Serializable接口,然后通过jdk对象序列化的方法保存),打开Redis-Desktop-Manager图形化工具查看的时候,数据是以字节数组显示。

StringRedisTemplate

@SpringBootTest
@RunWith(SpringRunner.class)
public class RedisTemplateApplicationTests {
   

	@Test
	public void contextLoads() {
   
	}
	
	@Autowired
	private StringRedisTemplate stringRedisTemplate;
	
	/*@Autowired
	private RedisTemplate redisTemplate;*/
	
	@Test
	public void testRedis(){
   	
	/*	redisTemplate.opsForValue().set("username", "张三");
		System.out.println(redisTemplate.opsForValue().get("username"));*/

		stringRedisTemplate.opsForValue().set("username", "张三");
		System.out.println(stringRedisTemplate.opsForValue().get("username"));
	}
}

而StringRedisSerializer在操作数据的时候就是通过string.getBytes0来实现的。在Redis中,所有存储的值都是字符串类型的。所以这种方法保存后,通过Redis-Desktop-Manager图形化工具,可以清楚的查看到key和value。

这样会出现问题,当我们的以前的项目升级为RedisTemplate在不指定序列化方式的时候取不到原来的值。

注意要删除一开始用RedisTemplate存储的key, 保留的是StringRedisTemplate存储的key, 否则还是会拿到值,我们测试的是RedisTemplate能否取到StringRedisTemplate的键值对