StringRedisTemplate使用

一,StringRedisTemplate介绍

StringRedisTemplate` 是 Spring Framework 提供的一个用于操作 Redis 数据库中 String 类型数据的模板类。它是基于 RedisTemplate 实现的,专门用于处理 Redis 中的 String 类型数据,提供了一系列简化操作的方法。

在 Spring Data Redis 中,StringRedisTemplate 主要用于将 Redis 的 String 类型数据与 Spring 应用程序进行集成,使开发者可以方便地进行读取、写入和删除操作,而无需关心底层 Redis 的连接和数据序列化等细节。

以下是 StringRedisTemplate 的主要特点和用法:

  1. 简化的操作方法StringRedisTemplate 封装了一系列简化的操作方法,如设置、获取、删除 String 类型数据等,开发者可以直接调用这些方法来进行操作,而无需关心 Redis 的底层实现。
  2. 与 Spring 集成StringRedisTemplate 是基于 Spring 框架提供的 RedisTemplate 实现的,因此可以与 Spring 应用程序无缝集成,通过依赖注入的方式进行使用。
  3. 支持事务StringRedisTemplate 支持在事务中进行操作,可以保证多个操作的原子性,确保数据的一致性。
  4. 支持序列化StringRedisTemplate 支持将 Java 对象序列化成 Redis 数据格式,以及将 Redis 数据反序列化成 Java 对象,方便开发者进行数据存取操作。
  5. 提供回调接口StringRedisTemplate 还提供了一些回调接口,如 RedisCallback 和 SessionCallback,开发者可以通过这些接口来执行自定义的 Redis 操作,更灵活地控制 Redis 的使用。

总的来说,StringRedisTemplate 是一个功能强大且易于使用的工具类,可以帮助开发者快速地将 Redis 整合到 Spring 应用程序中,实现对 String 类型数据的管理和操作。

二,StringRedisTemplate使用

​ StringRedisTemplate是Spring提供的用于操作Redis的模板类之一,它简化了与Redis交互的操作。Redis是一种键值存储的数据库,支持多种数据类型的存储,其中包括字符串(String)、哈希(Hash)、列表(List)、集合(Set)和有序集合(Sorted Set)等。

下面我将详细解释StringRedisTemplate如何对这五种数据类型进行存储、删除和使用:

1.字符串(String):

优势:Redis 中最基本的数据类型,支持的操作简单高效,可以存储任何类型的数据,包括文本、数字等。

缺点:不支持复杂的数据结构,不适合存储结构化数据,当需要存储多个字段或者需要复杂的查询时,使用字符串可能不够方便。

常用时机:存储简单的键值对、缓存数据、计数器等。

// 通过redis操作模板获取操作类型对象
// 这段注释描述了使用StringRedisTemplate的opsForValue()方法获取操作类型对象的过程
ValueOperations<String, String> opsForValue = stringRedisTemplate.opsForValue();

// 将指定的键值对存储到Redis中
// 参数说明:
// - key: 要存储的键
// - value: 要存储的值
opsForValue.set("user:login:"+mobile, code);

// 将指定的键值对存储到Redis中,并设置存活时间
// 参数说明:
// - key: 要存储的键
// - value: 要存储的值
// - timeout: 存活时间
// - unit: 存活时间的单位
opsForValue.set("user:login:"+mobile, code, 60, TimeUnit.SECONDS);

// 获取指定键对应的值
// 参数说明:
// - key: 要获取值的键
String retrievedValue = opsForValue.get("user:login:"+mobile);

// 设置指定键的值,并返回旧值
// 参数说明:
// - key: 要设置值的键
// - value: 要设置的新值
String oldValue = opsForValue.getAndSet("user:login:"+mobile, newValue);

// 批量设置多个键值对
// 参数说明:
// - map: 要设置的键值对集合
Map<String, String> keyValueMap = new HashMap<>();
keyValueMap.put("key1", "value1");
keyValueMap.put("key2", "value2");
opsForValue.multiSet(keyValueMap);

// 批量获取多个键对应的值
// 参数说明:
// - keys: 要获取值的键集合
List<String> values = opsForValue.multiGet(Arrays.asList("key1", "key2"));

// 将指定键的值按给定的增量递增
// 参数说明:
// - key: 要递增的键
// - delta: 增量值
opsForValue.increment("counter", 1);

// 将指定键的值按给定的增量递减
// 参数说明:
// - key: 要递减的键
// - delta: 减量值
opsForValue.decrement("counter", 1);

// 将指定值追加到键对应的字符串值的末尾
// 参数说明:
// - key: 要追加值的键
// - value: 要追加的值
opsForValue.append("key", "value");

// 获取指定键对应的字符串值的长度
// 参数说明:
// - key: 要获取长度的键
Long length = opsForValue.size("key");

// 如果键不存在,则设置指定键的值
// 参数说明:
// - key: 要设置值的键
// - value: 要设置的新值
// 返回值:如果设置成功返回true,否则返回false
boolean setIfAbsentResult = opsForValue.setIfAbsent("key", "value");

// 如果键存在,则设置指定键的值
// 参数说明:
// - key: 要设置值的键
// - value: 要设置的新值
// 返回值:如果设置成功返回true,否则返回false
boolean setIfPresentResult = opsForValue.setIfPresent("key", "value");

// 获取底层的操作接口,可以通过它执行更多高级操作
// 返回值:底层的操作接口
Object nativeOperations = opsForValue.getOperations();

// 删除指定键对应的值
// 参数说明:
// - key: 要删除值的键
// 返回值:如果删除成功返回true,否则返回false
boolean deleteResult = stringRedisTemplate.delete("user:login:"+mobile);
2.哈希(Hash):

优势:适合存储对象属性,可以将相关字段存储在同一键下,方便管理和查询,减少键的数量,节省内存。

缺点:不支持像关系型数据库那样的复杂查询操作,对于嵌套结构不够友好。

常用时机:存储对象属性、存储用户信息、存储商品信息等。

// 通过redis操作模板获取操作类型对象
// 这段注释描述了使用StringRedisTemplate的opsForHash()方法获取操作类型对象的过程
HashOperations<String, String, String> opsForHash = stringRedisTemplate.opsForHash();

// 添加一个键值对到哈希表中
// 参数说明:
// - key: 哈希表的键
// - hashKey: 哈希表中的键
// - value: 哈希表中的值
// 返回值:如果哈希表中不存在给定的键,添加成功并返回true;如果哈希表中已经存在给定的键,更新值并返回false
Boolean putResult = opsForHash.put("hash:key", "hashField", "hashValue");

// 批量添加多个键值对到哈希表中
// 参数说明:
// - key: 哈希表的键
// - m: 要添加的多个键值对
// 返回值:返回成功添加的键值对数量
Long putAllResult = opsForHash.putAll("hash:key", Map.of("field1", "value1", "field2", "value2"));

// 获取存储在哈希表中指定字段的值
// 参数说明:
// - key: 哈希表的键
// - hashKey: 哈希表中的键
// 返回值:返回哈希表中指定字段的值
String getResult = opsForHash.get("hash:key", "hashField");

// 删除哈希表中的一个或多个字段
// 参数说明:
// - key: 哈希表的键
// - hashKeys: 要删除的字段
// 返回值:返回成功删除的字段数量
Long deleteResult = opsForHash.delete("hash:key", "hashField1", "hashField2");

// 判断哈希表中是否存在指定字段
// 参数说明:
// - key: 哈希表的键
// - hashKey: 要检查的字段
// 返回值:如果哈希表中存在给定的字段,返回true;如果哈希表中不存在给定的字段或key不存在,返回false
Boolean hasKeyResult = opsForHash.hasKey("hash:key", "hashField");

// 获取哈希表中所有的字段-值对
// 参数说明:
// - key: 哈希表的键
// 返回值:返回哈希表中所有的字段-值对
Map<String, String> entriesResult = opsForHash.entries("hash:key");

// 获取哈希表中所有的字段
// 参数说明:
// - key: 哈希表的键
// 返回值:返回哈希表中所有的字段
Set<String> keysResult = opsForHash.keys("hash:key");

// 获取哈希表中所有的值
// 参数说明:
// - key: 哈希表的键
// 返回值:返回哈希表中所有的值
List<String> valuesResult = opsForHash.values("hash:key");

// 获取哈希表中字段的数量
// 参数说明:
// - key: 哈希表的键
// 返回值:返回哈希表中字段的数量
Long sizeResult = opsForHash.size("hash:key");

//将指定位置的元素替换为新值
//其中"myList"是待操作的列表键
//index是要替换的位置
//value是新的值
opsForList.set("myList", index, value); 
3.列表(List):

优势:支持按照索引进行操作,可以实现队列、栈等数据结构,同时支持插入、删除等操作。

缺点:在数据量较大时,对索引进行插入和删除操作可能会影响性能。

常用时机:消息队列、实时排行榜、最新动态等

// 通过redis操作模板获取操作类型对象
// 这段注释描述了使用StringRedisTemplate的opsForList()方法获取操作类型对象的过程
ListOperations<String, String> opsForList = stringRedisTemplate.opsForList();

// 将一个或多个值插入到列表头部
// 参数说明:
// - key: 要操作的列表键
// - values: 要插入的值
// 返回值:返回列表的长度
Long leftPushResult = opsForList.leftPush("list:key", "value1", "value2", "value3");

// 将一个或多个值插入到列表尾部
// 参数说明:
// - key: 要操作的列表键
// - values: 要插入的值
// 返回值:返回列表的长度
Long rightPushResult = opsForList.rightPush("list:key", "value1", "value2", "value3");

// 获取列表指定范围内的元素
// 参数说明:
// - key: 要操作的列表键
// - start: 起始位置(0表示第一个元素)
// - end: 结束位置(-1表示最后一个元素)
// 返回值:返回指定范围内的元素列表
List<String> rangeResult = opsForList.range("list:key", 0, -1);

// 移除列表中与给定值相等的元素
// 参数说明:
// - key: 要操作的列表键
// - count: 移除元素的个数(正数表示从左到右移除,负数表示从右到左移除,0表示移除所有与值相等的元素)
// - value: 要移除的值
// 返回值:返回被移除元素的个数
Long removeResult = opsForList.remove("list:key", 0, "value");

// 获取列表中指定位置的元素
// 参数说明:
// - key: 要操作的列表键
// - index: 要获取元素的索引位置(0表示第一个元素,-1表示最后一个元素)
// 返回值:返回指定位置的元素
String indexResult = opsForList.index("list:key", 0);

// 获取列表的长度
// 参数说明:
// - key: 要操作的列表键
// 返回值:返回列表的长度
Long sizeResult = opsForList.size("list:key");

// 从列表的左侧弹出一个元素
// 参数说明:
// - key: 要操作的列表键
// 返回值:返回被弹出的元素
String leftPopResult = opsForList.leftPop("list:key");

// 从列表的右侧弹出一个元素
// 参数说明:
// - key: 要操作的列表键
// 返回值:返回被弹出的元素
String rightPopResult = opsForList.rightPop("list:key");

// 从一个列表的右侧弹出一个元素,并将它推到另一个列表的左侧
// 参数说明:
// - sourceKey: 要弹出元素的列表键
// - destinationKey: 要推入元素的列表键
// 返回值:返回被弹出的元素
String rightPopAndLeftPushResult = opsForList.rightPopAndLeftPush("source:key", "destination:key");

// 裁剪列表,保留指定范围内的元素
// 参数说明:
// - key: 要操作的列表键
// - start: 起始位置(0表示第一个元素)
// - end: 结束位置(-1表示最后一个元素)
// 返回值:无
opsForList.trim("list:key", 0, 9);
4.集合(Set):

优势:元素不重复,支持集合间的交集、并集、差集等操作,对于需要存储唯一值的场景很有用。

缺点:不支持按索引访问元素,无法按顺序获取元素。

常用时机:标签系统、好友关系、共同喜好等。

// 通过redis操作模板获取操作类型对象
// 这段注释描述了使用StringRedisTemplate的opsForSet()方法获取操作类型对象的过程
SetOperations<String, String> opsForSet = stringRedisTemplate.opsForSet();

// 向集合添加一个或多个成员
// 参数说明:
// - key: 要操作的集合键
// - values: 要添加的成员
// 返回值:返回成功添加的成员数量
Long addResult = opsForSet.add("set:key", "member1", "member2", "member3");

// 获取集合的成员数
// 参数说明:
// - key: 要操作的集合键
// 返回值:返回集合的成员数
Long sizeResult = opsForSet.size("set:key");

// 判断集合中是否包含指定成员
// 参数说明:
// - key: 要操作的集合键
// - value: 要检查的成员
// 返回值:如果成员存在于集合中,返回true;否则返回false
Boolean isMemberResult = opsForSet.isMember("set:key", "member");

// 获取集合中的所有成员
// 参数说明:
// - key: 要操作的集合键
// 返回值:返回集合中的所有成员
Set<String> membersResult = opsForSet.members("set:key");

// 从集合中随机弹出一个成员
// 参数说明:
// - key: 要操作的集合键
// 返回值:返回被弹出的成员
String popResult = opsForSet.pop("set:key");

// 将指定成员从一个集合移动到另一个集合
// 参数说明:
// - key: 源集合键
// - value: 要移动的成员
// - destKey: 目标集合键
// 返回值:如果成员成功移动,返回true;如果成员不存在于源集合,返回false
Boolean moveResult = opsForSet.move("source:set:key", "member", "destination:set:key");

// 从集合中移除一个或多个成员
// 参数说明:
// - key: 要操作的集合键
// - values: 要移除的成员
// 返回值:返回成功移除的成员数量
Long removeResult = opsForSet.remove("set:key", "member1", "member2");

// 获取两个集合的交集
// 参数说明:
// - key: 要操作的集合键
// - otherKeys: 其他集合的键
// 返回值:返回交集的成员集合
Set<String> intersectResult = opsForSet.intersect("set:key", "other:set:key");

// 获取两个集合的并集
// 参数说明:
// - key: 要操作的集合键
// - otherKeys: 其他集合的键
// 返回值:返回并集的成员集合
Set<String> unionResult = opsForSet.union("set:key", "other:set:key");

// 获取两个集合的差集
// 参数说明:
// - key: 要操作的集合键
// - otherKeys: 其他集合的键
// 返回值:返回差集的成员集合
Set<String> differenceResult = opsForSet.difference("set:key", "other:set:key");
5.有序集合(Sorted Set):
  • 优势:在集合的基础上增加了元素的排序功能,支持按分数范围获取值,适合实现排行榜等功能。

  • 缺点:相比普通集合,有额外的内存消耗。

  • 常用时机:排行榜、范围查询、带权重的任务队列等。

    // 通过redis操作模板获取操作类型对象
    // 这段注释描述了使用StringRedisTemplate的opsForZSet()方法获取操作类型对象的过程
    ZSetOperations<String, String> opsForZSet = stringRedisTemplate.opsForZSet();
    
    // 向有序集合添加一个或多个成员,或者更新已存在成员的分数
    // 参数说明:
    // - key: 要操作的有序集合键
    // - values: 要添加或更新的成员及其分数
    // 返回值:返回成功添加或更新的成员数量
    Long addResult = opsForZSet.add("zset:key", "member1", 1.0);
    Map<String, Double> memberScores = new HashMap<>();
    memberScores.put("member2", 2.0);
    memberScores.put("member3", 3.0);
    Long multiAddResult = opsForZSet.add("zset:key", memberScores);
    
    // 增加指定成员的分数
    // 参数说明:
    // - key: 要操作的有序集合键
    // - member: 要增加分数的成员
    // - delta: 分数增量
    // 返回值:返回成员新的分数值
    Double incrementScoreResult = opsForZSet.incrementScore("zset:key", "member", 2.5);
    
    // 获取有序集合的成员数
    // 参数说明:
    // - key: 要操作的有序集合键
    // 返回值:返回有序集合的成员数
    Long sizeResult = opsForZSet.size("zset:key");
    
    // 获取有序集合中指定成员的分数
    // 参数说明:
    // - key: 要操作的有序集合键
    // - member: 要获取分数的成员
    // 返回值:返回成员的分数
    Double scoreResult = opsForZSet.score("zset:key", "member");
    
    // 获取有序集合中指定范围内的成员及其分数,按分数从低到高排序
    // 参数说明:
    // - key: 要操作的有序集合键
    // - start: 起始位置(0表示第一个成员)
    // - end: 结束位置(-1表示最后一个成员)
    // 返回值:返回指定范围内的成员及其分数的集合
    Set<TypedTuple<String>> rangeWithScoresResult = opsForZSet.rangeWithScores("zset:key", 0, -1);
    
    // 获取有序集合中指定范围内的成员及其分数,按分数从高到低排序
    // 参数说明:
    // - key: 要操作的有序集合键
    // - start: 起始位置(0表示第一个成员)
    // - end: 结束位置(-1表示最后一个成员)
    // 返回值:返回指定范围内的成员及其分数的集合
    Set<TypedTuple<String>> reverseRangeWithScoresResult = opsForZSet.reverseRangeWithScores("zset:key", 0, -1);
    
    // 获取有序集合中指定范围内的成员数量,分数介于min和max之间(包含min和max)
    // 参数说明:
    // - key: 要操作的有序集合键
    // - min: 最小分数
    // - max: 最大分数
    // 返回值:返回指定范围内的成员数量
    Long countResult = opsForZSet.count("zset:key", min, max);
    
    // 从有序集合中移除指定范围内的成员,分数介于min和max之间(包含min和max)
    // 参数说明:
    // - key: 要操作的有序集合键
    // - min: 最小分数
    // - max: 最大分数
    // 返回值:返回成功移除的成员数量
    Long removeRangeByScoreResult = opsForZSet.removeRangeByScore("zset:key", min, max);
    
    // 根据排名范围移除有序集合中的成员(排名从0开始)
    // 参数说明:
    // - key: 要操作的有序集合键
    // - start: 起始排名
    // - end: 结束排名
    // 返回值:返回成功移除的成员数量
    Long removeRangeResult = opsForZSet.removeRange("zset:key", start, end);
    

总的来说,通过StringRedisTemplate的不同方法获取对应数据类型的操作实例,然后通过这些操作实例进行数据的存储、删除和使用。

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值