Spring Data Redis详细使用教程
Spring Data Redis详细使用教程
简介
SpringData提供了针对数据库（包括SQL和NOSQL）的整合方案，对Hibernate JPA、Jedis等工具的api进行高级的封装，为我们提供简单方便地操作接口。
Spring Data Redis 是Spring Data的项目下的一个模块。整合了jedis，并对API进行了封装，让我们可以较方便地操作redis。
学习Spring Data Redis主要包括以下内容：
-
单机和集群的配置
-
使用
RedisTemplate操作分别操作不同的类型数据：string、list、set、sorted set、hash. -
使用
RedisTemplate操作事务。
项目测试中发现两个比较大的坑：
-
Spring Data Redis 涉及到返回Boolean的方法，不一定只是返回true或者false，还会返回null；
-
事务过程中，读可以马上执行，而写需要提交后一起执行。所以会出现事务中存入值，但是读出来是null的情况。
项目实现的需求
Spring Data Redis
-
使用
Spring Data Redis，以json格式存取不同类型数据：string、list、set、sorted set、hash -
测试
Spring Data Redis的事务管理。
项目工程环境
JDK：1.8.0_201
maven：3.6.1
IDE：Spring Tool Suites4 for Eclipse：4.12
Redis：3.2.100（windows版）
Spring Data Redis：2.1.10.RELEASE
applicationContext.xml的配置
单机版
这里主要注意2个要点：
- 序列化器：一般有以下5种。默认是采用
StringRedisSerializer，这种序列器不支持对象存储，使用过程中需要手动抓换序列化器。所以我统一把value的序列化器都改成GenericJackson2JsonRedisSerializer
| Serializer实现 | 描述 |
|---|---|
| StringRedisSerializer | String/byte[]转换，速度快 |
| JdkSerializationRedisSerializer | JDK自带序列化 |
| OxmSerializer | XML序列化，占空间，速度慢 |
| Jackson2JsonRedisSerializer | JSON序列化，需要定义JavaType |
| GenericJackson2JsonRedisSerializer | JSON序列化，无需定义JavaType |
- 事务配置。这里必须开启事务，如果不配置也行，但使用时需要频繁地手动地开启。
<!-- 引入配置文件 -->
<context:property-placeholder ignore-unresolvable="true" location="classpath:redis.properties" />
<!-- Jedis 连接池 -->
<bean id="poolConfig" class="redis.clients.jedis.JedisPoolConfig">
<property name="maxTotal" value="${redis.pool.maxTotal}" />
<property name="maxIdle" value="${redis.pool.maxIdle}" />
<property name="minIdle" value="${redis.pool.minIdle}" />
<property name="testOnBorrow" value="${redis.pool.testOnBorrow}"/>
</bean>
<!-- Jedis 的连接工厂 -->
<bean id="jedisConnectionFactory" class="org.springframework.data.redis.connection.jedis.JedisConnectionFactory">
<property name="hostName" value="${redis.host}" />
<property name="port" value="${redis.port}" />
<property name="password" value="${redis.password}" />
<property name="poolConfig" ref="poolConfig" />
</bean>
<!-- Redis 模板对象 -->
<bean id="redisTemplate" class="org.springframework.data.redis.core.RedisTemplate">
<property name="connectionFactory" ref="jedisConnectionFactory" />
<!-- 序列化器：能够把我们储存的key 与value 做序列化处理的对象 -->
<!-- 配置默认的序列化器 -->
<!-- keySerializer、valueSerializer 配置Redis 中的String 类型key 与value 的序列化器 -->
<!-- HashKeySerializer、HashValueSerializer 配置Redis 中的Hash 类型key 与value的序列化器 -->
<property name="keySerializer">
<bean class="org.springframework.data.redis.serializer.StringRedisSerializer" />
</property>
<property name="valueSerializer">
<bean class="org.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer"/>
</property>
<property name="hashKeySerializer">
<bean class="org.springframework.data.redis.serializer.StringRedisSerializer" />
</property>
<property name="hashValueSerializer">
<bean class="org.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer"/>
</property>
<!--开启事务 -->
<property name="enableTransactionSupport" value="true"></property>
</bean>
测试操作String类型数据
Spring Data Redis 涉及到返回Boolean的方法，不一定只是返回true或者false，还会返回null，所以不能直接用于if判断
/**
* @Title: testKey
* @Description: 测试操作String的方法
* @author: zzs
* @date: 2019年9月1日 下午9:30:43
* @return: void
* @throws Exception
*/
@Test
public void testString() {
//定义key
String key = "redis-demo:testString";
//key如果存在，先清除
redisTemplate.delete(key);
//获取String类型的操作对象
ValueOperations<String, Object> opsForValue = redisTemplate.opsForValue();
//添加键值对
opsForValue.set(key, user1);
//修改键值对
opsForValue.set(key, user2);
//判断键值对是否存在
System.err.println(redisTemplate.hasKey(key));
//获取键值对
System.err.println(opsForValue.get(key));
}
测试操作List类型数据
/**
* @Title: testList
* @Description: 测试操作List的方法
* @author: zzs
* @date: 2019年9月1日 下午9:30:43
* @return: void
* @throws Exception
*/
@Test
public void testList() {
//定义key
String key = "redis-demo:testlist";
//key如果存在，先清除
redisTemplate.delete(key);
//获取List类型的操作对象
ListOperations<String, Object> opsForList = redisTemplate.opsForList();
//从左边批量添加元素
opsForList.leftPushAll(key, user1, user2, user3, user4);
//修改元素：只能根据索引删除
opsForList.set(key, 0, user5);
//从右边删除第一个元素：只能删除第一个或最后一个
System.err.println("弹出并删除元素：" + opsForList.rightPop(key));
//遍历元素
List<Object> list = opsForList.range(key, 0, -1);
Iterator<Object> iterator = list.iterator();
while (iterator.hasNext()) {
System.err.println(iterator.next());
}
}
测试操作Set类型数据
/**
* @Title: testSet
* @Description: 测试操作Set的方法
* @author: zzs
* @date: 2019年9月1日 下午9:30:43
* @return: void
* @throws Exception
*/
@Test
public void testSet() {
//定义key
String key = "redis-demo:testSet";
//key如果存在，先清除
redisTemplate.delete(key);
//获取Set类型的操作对象
SetOperations<String, Object> opsForSet = redisTemplate.opsForSet();
//添加元素
opsForSet.add(key, user1, user2, user3, user4);
//更新元素：不能更新元素
//删除元素
opsForSet.remove(key, user1);
//判断元素是否存在
System.err.println(opsForSet.isMember(key, user1));
//遍历元素
Set<Object> members = opsForSet.members(key);
Iterator<Object> iterator = members.iterator();
while (iterator.hasNext()) {
System.err.println(iterator.next());
}
}
测试操作Sorted Set类型数据
/**
* @Title: testSortedSet
* @Description: 测试操作Sorted Set的方法
* @author: zzs
* @date: 2019年9月1日 下午9:30:43
* @return: void
* @throws Exception
*/
@Test
public void testSortedSet() throws Exception {
//定义key
String key = "redis-demo:testSortedSet";
//key如果存在，先清除
redisTemplate.delete(key);
//获取Sorted Set类型的操作对象
ZSetOperations<String, Object> opsForZSet = redisTemplate.opsForZSet();
//添加元素
opsForZSet.add(key, user1, 1D);
opsForZSet.add(key, user2, 3D);
opsForZSet.add(key, user3, 4D);
opsForZSet.add(key, user4, 2D);
//更新元素
opsForZSet.add(key, user5, 1D);
//删除元素
opsForZSet.remove(key, user3);
//查找指定元素的score
System.err.println(opsForZSet.score(key, user2));
//查找指定指定元素的排名
System.err.println(opsForZSet.rank(key, user2));
//遍历元素
Set<Object> set = opsForZSet.range(key, 0, -1);
Iterator<Object> iterator = set.iterator();
while (iterator.hasNext()) {
System.err.println(iterator.next());
}
}
测试操作Hash类型数据
/**
* @Title: testHash
* @Description: 测试操作Hash的方法
* @author: zzs
* @date: 2019年9月1日 下午9:30:43
* @return: void
* @throws Exception
*/
@Test
public void testHash() throws Exception {
//定义key
String key = "redis-demo:testHash";
//key如果存在，先清除
redisTemplate.delete(key);
//获取hash类型的操作对象
HashOperations<String, Object, Object> opsForHash = redisTemplate.opsForHash();
//添加元素
opsForHash.put(key, "name", user1.getName());
opsForHash.put(key, "age", user1.getAge());
opsForHash.put(key, "create", user1.getCreate());
opsForHash.put(key, "modified", user1.getModified());
//更新元素
opsForHash.put(key, "age", 22);
//删除元素
opsForHash.delete(key, "modified");
//获取指定元素的值
System.err.println(opsForHash.get(key, "name"));
//遍历元素
Map<Object, Object> map = opsForHash.entries(key);
for (Entry<Object, Object> entry : map.entrySet()) {
System.err.println(entry.getKey() + "=" + entry.getValue());
}
}
测试操作Key
/**
* @Title: testKey
* @Description: 测试操作key的方法
* @author: zzs
* @date: 2019年9月1日 下午9:30:43
* @return: void
* @throws Exception
*/
@Test
public void testKey() throws Exception {
//定义key
String key = "redis-demo:testKey";
//key如果存在，先清除
if (redisTemplate.hasKey(key)) {
redisTemplate.delete(key);
}
//添加键值对
redisTemplate.opsForValue().set(key, "test001");
//设置key的过期时间
redisTemplate.expire(key, 5, TimeUnit.SECONDS);
Thread.sleep(3000);
//查询key的剩余时间
System.err.println(redisTemplate.getExpire(key, TimeUnit.SECONDS));
//清除key的过期时间
redisTemplate.persist(key);
System.err.println(redisTemplate.getExpire(key, TimeUnit.SECONDS));
}
测试事务管理
注意：事务过程中，读可以马上执行，而写需要提交后一起执行。所以会出现事务中存入值，但是读出来是null的情况。
/**
* @Title: testTransaction
* @Description: 测试操作事务操作
* @author: zzs
* @date: 2019年9月1日 下午9:30:43
* @return: void
* @throws Exception
*/
@Test
public void testTransaction() {
//定义key
String key = "redis-demo:testString";
//开启对key修改的监视，如果事务执行期间key被修改，那么事务将不会提交。
redisTemplate.watch(key);
//开启事务
redisTemplate.multi();
try {
//如果key存在先删除
redisTemplate.delete(key);
//获取String类型的操作对象
ValueOperations<String, Object> opsForValue = redisTemplate.opsForValue();
//添加键值对
opsForValue.set(key, user1);
//判断键值对是否存在:null。这时key还没存进redis，而且竟然不是false
System.err.println(redisTemplate.hasKey(key));
//提交事务
//int i = 2/0;
redisTemplate.exec();
//判断键值对是否存在:true。这时事务已经提交，所以可以找到。
System.err.println(redisTemplate.hasKey(key));
} catch (Exception e) {
logger.error("测试jedis存取String类型出错，事务回滚", e);
//回滚事务
redisTemplate.discard();
}
}
项目路径：
spring-data-redis-demo
学习使我快乐！！