SpringDataRedis 操作

发表于 | 分类于 |
字数统计: 2.1k | 阅读时长 ≈ 9

RedisTemplate操作Redis，这一篇文章就够了（一）ha_lydms的博客-CSDN博客redistemplate

Redis

redis是一款开源的Key-Value数据库，运行在内存中，由C语言编写。企业开发通常采用Redis来实现缓存。同类的产品还有memcache 、memcached 等。

Jedis

Jedis是Redis官方推出的一款面向Java的客户端，提供了很多接口供Java语言调用。可以在Redis官网下载，当然还有一些开源爱好者提供的客户端，如Jredis、SRP等等，推荐使用Jedis。

Spring Data Redis

Spring-data-redis是spring大家族的一部分，提供了在srping应用中通过简单的配置访问redis服务，对reids底层开发包(Jedis, JRedis, and RJC)进行了高度封装，RedisTemplate提供了redis各种操作、异常处理及序列化，支持发布订阅，并对spring 3.1 cache进行了实现。 spring-data-redis针对jedis提供了如下功能：

  • 连接池自动管理，提供了一个高度封装的“RedisTemplate”类

  • 针对jedis客户端中大量api进行了归类封装,将同一类型操作封装为operation接口

    ValueOperations：简单K-V操作 SetOperations：set类型数据操作 ZSetOperations：zset类型数据操作 HashOperations：针对map类型的数据操作 ListOperations：针对list类型的数据操作

  • 提供了对key的“bound”(绑定)便捷化操作API，可以通过bound封装指定的key，然后进行一系列的操作而无须“显式”的再次指定Key，即BoundKeyOperations：

  • 将事务操作封装，有容器控制。

  • 针对数据的“序列化/反序列化”，提供了多种可选择策略(RedisSerializer)

    JdkSerializationRedisSerializer：POJO对象的存取场景，使用JDK本身序列化机制，将pojo类通过ObjectInputStream/ObjectOutputStream进行序列化操作，最终redis-server中将存储字节序列。是目前最常用的序列化策略。

    StringRedisSerializer：Key或者value为字符串的场景，根据指定的charset对数据的字节序列编码成string，是“new String(bytes, charset)”和“string.getBytes(charset)”的直接封装。是最轻量级和高效的策略。

    JacksonJsonRedisSerializer：jackson-json工具提供了javabean与json之间的转换能力，可以将pojo实例序列化成json格式存储在redis中，也可以将json格式的数据转换成pojo实例。因为jackson工具在序列化和反序列化时，需要明确指定Class类型，因此此策略封装起来稍微复杂。【需要jackson-mapper-asl工具支持】

RedisTemplate中API使用

pom.xml依赖

1
2
3
4
5
<!--Redis-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

配置文件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# Redis服务器连接端口
spring.redis.port=6379
# Redis服务器地址
spring.redis.host=127.0.0.1
# Redis数据库索引（默认为0）
spring.redis.database=0
# Redis服务器连接密码（默认为空）
spring.redis.password=
# 连接池最大连接数（使用负值表示没有限制）
spring.redis.jedis.pool.max-active=8
# 连接池最大阻塞等待时间（使用负值表示没有限制）
spring.redis.jedis.pool.max-wait=-1ms
# 连接池中的最大空闲连接
spring.redis.jedis.pool.max-idle=8
# 连接池中的最小空闲连接
spring.redis.jedis.pool.min-idle=0
# 连接超时时间（毫秒）
spring.redis.timeout=5000ms

RedisTemplate的直接方法

首先使用@Autowired注入RedisTemplate（后面直接使用，就不特殊说明）

1
2
@Autowired
private RedisTemplate redisTemplate;

删除单个key

1
2
3
4
//    删除key
public void delete(String key){
    redisTemplate.delete(key);
}
1
2
3
4
//    删除多个key
public void deleteKey (String ...keys){
    redisTemplate.delete(keys);
}
1
2
3
4
5
//    根据key获取过期时间
public long getExpire(String key){
    Long expire = redisTemplate.getExpire(key);
    return expire;
}
1
2
3
4
//    判断key是否存在
public boolean hasKey(String key){
    return redisTemplate.hasKey(key);
}

String类型相关操作

添加缓存（2/3是1的递进值）

1
2
3
4
5
6
7
8
9
10
11
12
13
//1、通过redisTemplate设置值
redisTemplate.boundValueOps("StringKey").set("StringValue");
redisTemplate.boundValueOps("StringKey").set("StringValue",1, TimeUnit.MINUTES);

//2、通过BoundValueOperations设置值
BoundValueOperations stringKey = redisTemplate.boundValueOps("StringKey");
stringKey.set("StringVaule");
stringKey.set("StringValue",1, TimeUnit.MINUTES);

//3、通过ValueOperations设置值
ValueOperations ops = redisTemplate.opsForValue();
ops.set("StringKey", "StringVaule");
ops.set("StringValue","StringVaule",1, TimeUnit.MINUTES);

获取具体操作接口对象的方法

ReactiveGeoOperations<K, V> opsForGeo();

返回地理空间特定操作接口。

返回：地理空间特定操作。

1
<HK, HV> ReactiveHashOperations<K, HK, HV> opsForHash();

返回对哈希值执行的操作。

Returns: hash operations.

ReactiveHyperLogLogOperations<K, V> opsForHyperLogLog();

返回使用 HyperLogLog 对多重集执行的操作。

ReactiveListOperations<K, V> opsForList();

Returns the operations performed on list values.

Returns: list operations.

ReactiveSetOperations<K, V> opsForSet();

Returns the operations performed on set values. Returns: set operations.

ReactiveValueOperations<K, V> opsForValue();

Returns the operations performed on simple values (or Strings in Redis terminology). Returns:value operations

ReactiveZSetOperations<K, V> opsForZSet();

Returns the operations performed on zset values (also known as sorted sets). Returns: zset operations.

设置过期时间(单独设置)

1
2
redisTemplate.boundValueOps("StringKey").expire(1,TimeUnit.MINUTES);
redisTemplate.expire("StringKey",1,TimeUnit.MINUTES);

获取缓存值（2/3是1的递进值

1
2
3
4
5
6
7
8
9
10
//1、通过redisTemplate设置值
String str1 = (String) redisTemplate.boundValueOps("StringKey").get();

//2、通过BoundValueOperations获取值
BoundValueOperations stringKey = redisTemplate.boundValueOps("StringKey");
String str2 = (String) stringKey.get();

//3、通过ValueOperations获取值
ValueOperations ops = redisTemplate.opsForValue();
String str3 = (String) ops.get("StringKey");

删除key

Boolean result = redisTemplate.delete("StringKey");

顺序递增

redisTemplate.boundValueOps("StringKey").increment(3L);

Hash类型相关操作

添加缓存（2/3是1的递进值）

1
2
3
4
5
6
7
8
9
10
11
//1、通过redisTemplate设置值
redisTemplate.boundHashOps("HashKey").put("SmallKey", "HashVaue");

//2、通过BoundValueOperations设置值
// <HK, HV> BoundHashOperations<K, HK, HV> boundHashOps(K key);
BoundHashOperations hashKey = redisTemplate.boundHashOps("HashKey");
hashKey.put("SmallKey", "HashVaue");

//3、通过ValueOperations设置值
HashOperations hashOps = redisTemplate.opsForHash();
hashOps.put("HashKey", "SmallKey", "HashVaue");
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
/**
 * Returns the operations performed on hash values.
 *
 * @param <HK> hash key (or field) type
 * @param <HV> hash value type
 * @return hash operations
 */
<HK, HV> HashOperations<K, HK, HV> opsForHash();

/**
 * Returns the operations performed on hash values bound to the given key. * @param <HK> hash key (or field) type
 *
 * @param <HV> hash value type
 * @param key Redis key
 * @return hash operations bound to the given key.
 */
<HK, HV> BoundHashOperations<K, HK, HV> boundHashOps(K key);

设置过期时间(单独设置)

1
2
redisTemplate.boundValueOps("HashKey").expire(1,TimeUnit.MINUTES);
redisTemplate.expire("HashKey",1,TimeUnit.MINUTES);

添加一个Map集合

1
2
HashMap<String, String> hashMap = new HashMap<>();
redisTemplate.boundHashOps("HashKey").putAll(hashMap );

提取所有的小key

1
2
3
4
5
6
7
8
9
10
//1、通过redisTemplate获取值
Set keys1 = redisTemplate.boundHashOps("HashKey").keys();

//2、通过BoundValueOperations获取值
BoundHashOperations hashKey = redisTemplate.boundHashOps("HashKey");
Set keys2 = hashKey.keys();

//3、通过ValueOperations获取值
HashOperations hashOps = redisTemplate.opsForHash();
Set keys3 = hashOps.keys("HashKey");

提取所有的value值

1
2
3
4
5
6
7
8
9
10
//1、通过redisTemplate获取值
List values1 = redisTemplate.boundHashOps("HashKey").values();

//2、通过BoundValueOperations获取值
BoundHashOperations hashKey = redisTemplate.boundHashOps("HashKey");
List values2 = hashKey.values();

//3、通过ValueOperations获取值
HashOperations hashOps = redisTemplate.opsForHash();
List values3 = hashOps.values("HashKey");

根据key提取value值

1
2
3
4
5
6
7
8
9
10
//1、通过redisTemplate获取
String value1 = (String) redisTemplate.boundHashOps("HashKey").get("SmallKey");

//2、通过BoundValueOperations获取值
BoundHashOperations hashKey = redisTemplate.boundHashOps("HashKey");
String value2 = (String) hashKey.get("SmallKey");

//3、通过ValueOperations获取值
HashOperations hashOps = redisTemplate.opsForHash();
String value3 = (String) hashOps.get("HashKey", "SmallKey");

获取所有的键值对集合

1
2
3
4
5
6
7
8
9
10
//1、通过redisTemplate获取
Map entries = redisTemplate.boundHashOps("HashKey").entries();

//2、通过BoundValueOperations获取值
BoundHashOperations hashKey = redisTemplate.boundHashOps("HashKey");
Map entries1 = hashKey.entries();

//3、通过ValueOperations获取值
HashOperations hashOps = redisTemplate.opsForHash();
Map entries2 = hashOps.entries("HashKey");

删除

1
2
3
4
//删除小key
redisTemplate.boundHashOps("HashKey").delete("SmallKey");
//删除大key
redisTemplate.delete("HashKey");

判断Hash中是否含有该值

1
Boolean isEmpty = redisTemplate.boundHashOps("HashKey").hasKey("SmallKey");

Zset类型的相关操作

向集合中插入元素，并设置分数

1
2
3
4
5
6
7
8
9
10
//1、通过redisTemplate设置值
redisTemplate.boundZSetOps("zSetKey").add("zSetVaule", 100D);

//2、通过BoundValueOperations设置值
BoundZSetOperations zSetKey = redisTemplate.boundZSetOps("zSetKey");
zSetKey.add("zSetVaule", 100D);

//3、通过ValueOperations设置值
ZSetOperations zSetOps = redisTemplate.opsForZSet();
zSetOps.add("zSetKey", "zSetVaule", 100D);

向集合中插入多个元素,并设置分数

1
2
3
DefaultTypedTuple<String> p1 = new DefaultTypedTuple<>("zSetVaule1", 2.1D);
DefaultTypedTuple<String> p2 = new DefaultTypedTuple<>("zSetVaule2", 3.3D);
redisTemplate.boundZSetOps("zSetKey").add(new HashSet<>(Arrays.asList(p1,p2)));

按照排名先后(从小到大)打印指定区间内的元素, -1为打印全部

1
Set<String> range = redisTemplate.boundZSetOps("zSetKey").range(0, -1);

获得指定元素的分数

Double score = redisTemplate.boundZSetOps("zSetKey").score("zSetVaule");

返回集合内指定分数范围的成员个数（Double类型）

1
Long COUNT = redisTemplate.boundZSetOps("zSetKey").count(0D, 2.2D);

返回集合内元素的排名，以及分数（从小到大）

1
2
3
4
Set<TypedTuple<String>> tuples = redisTemplate.boundZSetOps("zSetKey").rangeWithScores(0L, 3L);
  for (TypedTuple<String> tuple : tuples) {
      System.out.println(tuple.getValue() + " : " + tuple.getScore());
  }ss