备案控制台
探索云世界
开发者社区 数据库 文章 正文

springboot中集成redis，二次封装成工具类

2024-03-21 176
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
本文涉及的产品
云数据库 Redis 版，社区版 2GB
推荐场景：
搭建游戏排行榜
简介： springboot中集成redis，二次封装成工具类


现在是：2023年2月28日11:01:56

前言

redis大家应该都不陌生，我们在好多场景下都会使用，最近在面试别人的时候，也会问一些关于redis的问题，不多大家说的使用场景，基本都是在登录的时候，将用户信息放在缓存中，别的用的很少。表示一般在开发的时候，也不会进行二次封装redis的类，而是框架中本来就已经整合起来了，所以拿着用就行。

最近我在写一套开源的与社交软件交互的系统，后端采用的是springboot项目，有个地方需要用到缓存redis，所以就将原来的redis封装了下，现在分享出来。

springboot中集成redis

  1. 首先我们需要在pom文件中引入依赖，代码如下：
<!-- 集成redis依赖  -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>
  1. 在需要使用redis的类中，加入自动注入redis的代码：
@Autowired
    private RedisTemplate redisTemplate;
  1. 然后接下来我们就可以使用redis了，比如我们想给缓存中放存一个对象，那么我们可以这样写：
redisTemplate.opsForValue().set("name", "穆雄雄");
  1. 此时我们已经将name放在缓存中，那我们在使用的时候如何从缓存中获取呢？可以如下：
return key == null ? null : redisTemplate.opsForValue().get(key);
  1. 包括批量添加key:
Map<String, String> keyAndValue = new HashMap<String.String>();
     keyAndValue.put("name","穆雄雄");
    keyAndValue.put("age","20");
    redisTemplate.opsForValue().multiSet(keyAndValue);

如果在我们项目中使用redis的话，这样操作不仅繁琐，而且写起来也复杂，我们如何让在别的地儿使用的时候更加方便顺手呢，这个时候我们就需要做个简单的封装，

封装redis工具类

下面是我做了个简单的封装，部分也是参考的别人的：

  1. 给一个指定的 key 值附加过期时间
public boolean expire(String key, long time) {
        return redisTemplate.expire(key, time, TimeUnit.SECONDS);
    }
  1. 根据key 获取过期时间
public long getTime(String key) {
        return redisTemplate.getExpire(key, TimeUnit.SECONDS);
    }
  1. 移除指定key 的过期时间
public boolean persist(String key) {
        return redisTemplate.boundValueOps(key).persist();
    }
  1. 根据key获取值
public Object get(String key) {
        return key == null ? null : redisTemplate.opsForValue().get(key);
    }
  1. 将值放入缓存
public void set(String key, String value) {
        redisTemplate.opsForValue().set(key, value);
    }
  1. 移除指定key 的过期时间
public boolean persist(String key) {
        return redisTemplate.boundValueOps(key).persist();
    }
  1. 将值放入缓存并设置时间
public void set(String key, String value, long time) {
        if (time > 0) {
            redisTemplate.opsForValue().set(key, value, time, TimeUnit.SECONDS);
        } else {
            redisTemplate.opsForValue().set(key, value);
        }
    }
  1. 批量添加 key (重复的键会覆盖)
public void batchSet(Map<String, String> keyAndValue) {
        redisTemplate.opsForValue().multiSet(keyAndValue);
    }
  1. 批量添加 key-value 只有在键不存在时,才添加,map 中只要有一个key存在,则全部不添加
public void batchSetIfAbsent(Map<String, String> keyAndValue) {
        redisTemplate.opsForValue().multiSetIfAbsent(keyAndValue);
    }
  1. 对一个 key-value 的值进行加减操作,如果该 key 不存在 将创建一个key 并赋值该 number,如果 key 存在,但 value 不是长整型 ,将报错
public Long increment(String key, long number) {
        return redisTemplate.opsForValue().increment(key, number);
    }
  1. 对一个 key-value 的值进行加减操作,如果该 key 不存在 将创建一个key 并赋值该 number,如果 key 存在,但 value 不是 纯数字 ,将报错
public Double increment(String key, double number) {
        return redisTemplate.opsForValue().increment(key, number);
    }
  1. 将数据放入set缓存
public void sSet(String key, String value) {
        redisTemplate.opsForSet().add(key, value);
    }
  1. 获取变量中的值
public Set<Object> members(String key) {
        return redisTemplate.opsForSet().members(key);
    }
  1. 随机获取变量中指定个数的元素
public void randomMembers(String key, long count) {
        redisTemplate.opsForSet().randomMembers(key, count);
    }
  1. 随机获取变量中的元素
public Object randomMember(String key) {
        return redisTemplate.opsForSet().randomMember(key);
    }
  1. 弹出变量中的元素
public Object pop(String key) {
        return redisTemplate.opsForSet().pop("setValue");
    }
  1. 移除指定key 的过期时间
public boolean persist(String key) {
        return redisTemplate.boundValueOps(key).persist();
    }
  1. 获取变量中值的长度
public long size(String key) {
        return redisTemplate.opsForSet().size(key);
    }
  1. 根据value从一个set中查询,是否存在
public boolean sHasKey(String key, Object value) {
        return redisTemplate.opsForSet().isMember(key, value);
    }

完整的工具类RedisUtil：

package com.hookapi.common;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Component;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;
/**
 * @author: muxiongxiong
 * @date: 2023年02月22日 下午 5:48
 * 公众号：雄雄的小课堂
 * 博客：https://blog.csdn.net/qq_34137397
 * 个人站：http://www.穆雄雄.com
 * 个人站：http://www.muxiongxiong.cn
 * @Description: 类的描述
 */
@Component
public class RedisUtil {
    @Autowired
    private RedisTemplate redisTemplate;
    /**
     * 给一个指定的 key 值附加过期时间
     *
     * @param key
     * @param time
     * @return
     */
    public boolean expire(String key, long time) {
        return redisTemplate.expire(key, time, TimeUnit.SECONDS);
    }
    /**
     * 根据key 获取过期时间
     *
     * @param key
     * @return
     */
    public long getTime(String key) {
        return redisTemplate.getExpire(key, TimeUnit.SECONDS);
    }
    /**
     * 根据key 获取过期时间
     *
     * @param key
     * @return
     */
    public boolean hasKey(String key) {
        return redisTemplate.hasKey(key);
    }
    /**
     * 移除指定key 的过期时间
     *
     * @param key
     * @return
     */
    public boolean persist(String key) {
        return redisTemplate.boundValueOps(key).persist();
    }
    //- - - - - - - - - - - - - - - - - - - - -  String类型 - - - - - - - - - - - - - - - - - - - -
    /**
     * 根据key获取值
     *
     * @param key 键
     * @return 值
     */
    public Object get(String key) {
        return key == null ? null : redisTemplate.opsForValue().get(key);
    }
    /**
     * 将值放入缓存
     *
     * @param key   键
     * @param value 值
     * @return true成功 false 失败
     */
    public void set(String key, String value) {
        redisTemplate.opsForValue().set(key, value);
    }
    /**
     * 将值放入缓存并设置时间
     *
     * @param key   键
     * @param value 值
     * @param time  时间(秒) -1为无期限
     * @return true成功 false 失败
     */
    public void set(String key, String value, long time) {
        if (time > 0) {
            redisTemplate.opsForValue().set(key, value, time, TimeUnit.SECONDS);
        } else {
            redisTemplate.opsForValue().set(key, value);
        }
    }
    /**
     * 批量添加 key (重复的键会覆盖)
     *
     * @param keyAndValue
     */
    public void batchSet(Map<String, String> keyAndValue) {
        redisTemplate.opsForValue().multiSet(keyAndValue);
    }
    /**
     * 批量添加 key-value 只有在键不存在时,才添加
     * map 中只要有一个key存在,则全部不添加
     *
     * @param keyAndValue
     */
    public void batchSetIfAbsent(Map<String, String> keyAndValue) {
        redisTemplate.opsForValue().multiSetIfAbsent(keyAndValue);
    }
    /**
     * 对一个 key-value 的值进行加减操作,
     * 如果该 key 不存在 将创建一个key 并赋值该 number
     * 如果 key 存在,但 value 不是长整型 ,将报错
     *
     * @param key
     * @param number
     */
    public Long increment(String key, long number) {
        return redisTemplate.opsForValue().increment(key, number);
    }
    /**
     * 对一个 key-value 的值进行加减操作,
     * 如果该 key 不存在 将创建一个key 并赋值该 number
     * 如果 key 存在,但 value 不是 纯数字 ,将报错
     *
     * @param key
     * @param number
     */
    public Double increment(String key, double number) {
        return redisTemplate.opsForValue().increment(key, number);
    }
    //- - - - - - - - - - - - - - - - - - - - -  set类型 - - - - - - - - - - - - - - - - - - - -
    /**
     * 将数据放入set缓存
     *
     * @param key 键
     * @return
     */
    public void sSet(String key, String value) {
        redisTemplate.opsForSet().add(key, value);
    }
    /**
     * 获取变量中的值
     *
     * @param key 键
     * @return
     */
    public Set<Object> members(String key) {
        return redisTemplate.opsForSet().members(key);
    }
    /**
     * 随机获取变量中指定个数的元素
     *
     * @param key   键
     * @param count 值
     * @return
     */
    public void randomMembers(String key, long count) {
        redisTemplate.opsForSet().randomMembers(key, count);
    }
    /**
     * 随机获取变量中的元素
     *
     * @param key 键
     * @return
     */
    public Object randomMember(String key) {
        return redisTemplate.opsForSet().randomMember(key);
    }
    /**
     * 弹出变量中的元素
     *
     * @param key 键
     * @return
     */
    public Object pop(String key) {
        return redisTemplate.opsForSet().pop("setValue");
    }
    /**
     * 获取变量中值的长度
     *
     * @param key 键
     * @return
     */
    public long size(String key) {
        return redisTemplate.opsForSet().size(key);
    }
    /**
     * 根据value从一个set中查询,是否存在
     *
     * @param key   键
     * @param value 值
     * @return true 存在 false不存在
     */
    public boolean sHasKey(String key, Object value) {
        return redisTemplate.opsForSet().isMember(key, value);
    }
    /**
     * 检查给定的元素是否在变量中。
     *
     * @param key 键
     * @param obj 元素对象
     * @return
     */
    public boolean isMember(String key, Object obj) {
        return redisTemplate.opsForSet().isMember(key, obj);
    }
    /**
     * 转移变量的元素值到目的变量。
     *
     * @param key     键
     * @param value   元素对象
     * @param destKey 元素对象
     * @return
     */
    public boolean move(String key, String value, String destKey) {
        return redisTemplate.opsForSet().move(key, value, destKey);
    }
    /**
     * 批量移除set缓存中元素
     *
     * @param key    键
     * @param values 值
     * @return
     */
    public void remove(String key, Object... values) {
        redisTemplate.opsForSet().remove(key, values);
    }
    /**
     * 通过给定的key求2个set变量的差值
     *
     * @param key     键
     * @param destKey 键
     * @return
     */
    public Set<Set> difference(String key, String destKey) {
        return redisTemplate.opsForSet().difference(key, destKey);
    }
    //- - - - - - - - - - - - - - - - - - - - -  hash类型 - - - - - - - - - - - - - - - - - - - -
    /**
     * 加入缓存
     *
     * @param key 键
     * @param map 键
     * @return
     */
    public void add(String key, Map<String, String> map) {
        redisTemplate.opsForHash().putAll(key, map);
    }
    /**
     * 获取 key 下的 所有  hashkey 和 value
     *
     * @param key 键
     * @return
     */
    public Map<Object, Object> getHashEntries(String key) {
        return redisTemplate.opsForHash().entries(key);
    }
    /**
     * 验证指定 key 下 有没有指定的 hashkey
     *
     * @param key
     * @param hashKey
     * @return
     */
    public boolean hashKey(String key, String hashKey) {
        return redisTemplate.opsForHash().hasKey(key, hashKey);
    }
    /**
     * 获取指定key的值string
     *
     * @param key  键
     * @param key2 键
     * @return
     */
    public String getMapString(String key, String key2) {
        return redisTemplate.opsForHash().get("map1", "key1").toString();
    }
    /**
     * 获取指定的值Int
     *
     * @param key  键
     * @param key2 键
     * @return
     */
    public Integer getMapInt(String key, String key2) {
        return (Integer) redisTemplate.opsForHash().get("map1", "key1");
    }
    /**
     * 弹出元素并删除
     *
     * @param key 键
     * @return
     */
    public String popValue(String key) {
        return redisTemplate.opsForSet().pop(key).toString();
    }
    /**
     * 删除指定 hash 的 HashKey
     *
     * @param key
     * @param hashKeys
     * @return 删除成功的 数量
     */
    public Long delete(String key, String... hashKeys) {
        return redisTemplate.opsForHash().delete(key, hashKeys);
    }
    /**
     * 给指定 hash 的 hashkey 做增减操作
     *
     * @param key
     * @param hashKey
     * @param number
     * @return
     */
    public Long increment(String key, String hashKey, long number) {
        return redisTemplate.opsForHash().increment(key, hashKey, number);
    }
    /**
     * 给指定 hash 的 hashkey 做增减操作
     *
     * @param key
     * @param hashKey
     * @param number
     * @return
     */
    public Double increment(String key, String hashKey, Double number) {
        return redisTemplate.opsForHash().increment(key, hashKey, number);
    }
    /**
     * 获取 key 下的 所有 hashkey 字段
     *
     * @param key
     * @return
     */
    public Set<Object> hashKeys(String key) {
        return redisTemplate.opsForHash().keys(key);
    }
    /**
     * 获取指定 hash 下面的 键值对 数量
     *
     * @param key
     * @return
     */
    public Long hashSize(String key) {
        return redisTemplate.opsForHash().size(key);
    }
    //- - - - - - - - - - - - - - - - - - - - -  list类型 - - - - - - - - - - - - - - - - - - - -
    /**
     * 在变量左边添加元素值
     *
     * @param key
     * @param value
     * @return
     */
    public void leftPush(String key, Object value) {
        redisTemplate.opsForList().leftPush(key, value);
    }
    /**
     * 获取集合指定位置的值。
     *
     * @param key
     * @param index
     * @return
     */
    public Object index(String key, long index) {
        return redisTemplate.opsForList().index("list", 1);
    }
    /**
     * 获取指定区间的值。
     *
     * @param key
     * @param start
     * @param end
     * @return
     */
    public List<Object> range(String key, long start, long end) {
        return redisTemplate.opsForList().range(key, start, end);
    }
    /**
     * 把最后一个参数值放到指定集合的第一个出现中间参数的前面，
     * 如果中间参数值存在的话。
     *
     * @param key
     * @param pivot
     * @param value
     * @return
     */
    public void leftPush(String key, String pivot, String value) {
        redisTemplate.opsForList().leftPush(key, pivot, value);
    }
    /**
     * 向左边批量添加参数元素。
     *
     * @param key
     * @param values
     * @return
     */
    public void leftPushAll(String key, String... values) {
//        redisTemplate.opsForList().leftPushAll(key,"w","x","y");
        redisTemplate.opsForList().leftPushAll(key, values);
    }
    /**
     * 向集合最右边添加元素。
     *
     * @param key
     * @param value
     * @return
     */
    public void leftPushAll(String key, String value) {
        redisTemplate.opsForList().rightPush(key, value);
    }
    /**
     * 向左边批量添加参数元素。
     *
     * @param key
     * @param values
     * @return
     */
    public void rightPushAll(String key, String... values) {
        //redisTemplate.opsForList().leftPushAll(key,"w","x","y");
        redisTemplate.opsForList().rightPushAll(key, values);
    }
    /**
     * 向已存在的集合中添加元素。
     *
     * @param key
     * @param value
     * @return
     */
    public void rightPushIfPresent(String key, Object value) {
        redisTemplate.opsForList().rightPushIfPresent(key, value);
    }
    /**
     * 向已存在的集合中添加元素。
     *
     * @param key
     * @return
     */
    public long listLength(String key) {
        return redisTemplate.opsForList().size(key);
    }
    /**
     * 移除集合中的左边第一个元素。
     *
     * @param key
     * @return
     */
    public void leftPop(String key) {
        redisTemplate.opsForList().leftPop(key);
    }
    /**
     * 移除集合中左边的元素在等待的时间里，如果超过等待的时间仍没有元素则退出。
     *
     * @param key
     * @return
     */
    public void leftPop(String key, long timeout, TimeUnit unit) {
        redisTemplate.opsForList().leftPop(key, timeout, unit);
    }
    /**
     * 移除集合中右边的元素。
     *
     * @param key
     * @return
     */
    public void rightPop(String key) {
        redisTemplate.opsForList().rightPop(key);
    }
    /**
     * 移除集合中右边的元素在等待的时间里，如果超过等待的时间仍没有元素则退出。
     *
     * @param key
     * @return
     */
    public void rightPop(String key, long timeout, TimeUnit unit) {
        redisTemplate.opsForList().rightPop(key, timeout, unit);
    }
}

然后我们可以看看如何在控制器中调用：

同样还是需要先注入：

@Autowired
    private RedisUtil redisUtil;

然后就可以使用了，比如我们给缓存中存放一个值：

redisUtil.set(user,topicName);

至此，就完成啦。

文章标签：
云数据库 Redis 版
NoSQL
Redis
缓存
Java
关键词：
集成springboot
云数据库 Redis 版Springboot
springboot云数据库 Redis 版
Spring Boot封装
集成redis
相关实践学习
基于Redis实现在线游戏积分排行榜
本场景将介绍如何基于Redis数据库实现在线游戏中的游戏玩家积分排行榜功能。
云数据库 Redis 版使用教程
云数据库Redis版是兼容Redis协议标准的、提供持久化的内存数据库服务，基于高可靠双机热备架构及可无缝扩展的集群架构，满足高读写性能场景及容量需弹性变配的业务需求。 产品详情：https://www.aliyun.com/product/kvstore &nbsp; &nbsp; ------------------------------------------------------------------------- 阿里云数据库体验：数据库上云实战 开发者云会免费提供一台带自建MySQL的源数据库&nbsp;ECS 实例和一台目标数据库&nbsp;RDS实例。跟着指引，您可以一步步实现将ECS自建数据库迁移到目标数据库RDS。 点击下方链接，领取免费ECS&amp;RDS资源，30分钟完成数据库上云实战！https://developer.aliyun.com/adc/scenario/51eefbd1894e42f6bb9acacadd3f9121?spm=a2c6h.13788135.J_3257954370.9.4ba85f24utseFl
穆雄雄.
目录
相关文章
风水道人
|
28天前
|
NoSQL Java Redis
SpringBoot集成Redis解决表单重复提交接口幂等（亲测可用）
SpringBoot集成Redis解决表单重复提交接口幂等（亲测可用）
风水道人
353 0
Sunny_yiyi
|
2月前
|
NoSQL Java Redis
SpringBoot集成Redis
SpringBoot集成Redis
Sunny_yiyi
464 0
一百减一是零
|
12天前
|
NoSQL 数据可视化 Java
Springboot整合redis
Springboot整合redis
一百减一是零
211 0
源码宝
|
12天前
|
人工智能 前端开发 Java
Java语言开发的AI智慧导诊系统源码springboot+redis 3D互联网智导诊系统源码
智慧导诊解决盲目就诊问题，减轻分诊工作压力。降低挂错号比例，优化就诊流程，有效提高线上线下医疗机构接诊效率。可通过人体画像选择症状部位，了解对应病症信息和推荐就医科室。
源码宝
159 10
程序三两行
|
22天前
|
NoSQL Java Redis
Springboot整合redis
Springboot整合redis
程序三两行
13 0
风水道人
|
29天前
|
NoSQL Java Redis
SpringBoot集成Redis
SpringBoot集成Redis
风水道人
55 1
bbpp
|
20天前
|
存储 NoSQL 算法
09- Redis分片集群中数据是怎么存储和读取的 ?
Redis分片集群使用哈希槽分区算法，包含16384个槽（0-16383）。数据存储时，通过CRC16算法对key计算并模16383，确定槽位，进而分配至对应节点。读取时，根据槽位找到相应节点直接操作。
bbpp
54 12
bbpp
|
20天前
|
NoSQL Linux Redis
06- 你们使用Redis是单点还是集群 ? 哪种集群 ?
**Redis配置:** 使用哨兵集群，结构为1主2从，加上3个哨兵节点，总计分布在3台Linux服务器上，提供高可用性。
bbpp
325 0
东方睿赢
|
28天前
|
负载均衡 监控 NoSQL
Redis的集群方案有哪些？
Redis集群包括主从复制（基础，手动故障恢复）、哨兵模式（自动高可用）和Redis Cluster（官方分布式解决方案，自动分片和容错）。此外，还有如Codis、Redisson和Twemproxy等第三方工具用于代理和负载均衡。选择方案需考虑应用场景、数据规模和并发需求。
东方睿赢
275 2
风水道人
|
2月前
|
NoSQL Redis
Redis集群(六)：集群常用命令及说明
Redis集群(六)：集群常用命令及说明
风水道人
233 0

热门文章

最新文章

  • 1
    《Solidity 简易速速上手小册》第9章：DApp 开发与 Solidity 集成（2024 最新版）（上）
  • 2
    如何进行有效的Apollo测试：单元测试和集成测试指南
  • 3
    Hadoop【基础知识 05】【HDFS的JavaAPI】（集成及测试）
  • 4
    PYTHON集成机器学习：用ADABOOST、决策树、逻辑回归集成模型分类和回归和网格搜索超参数优化
  • 5
    《Git 简易速速上手小册》第6章：Git 在持续集成/持续部署（CI/CD）中的应用（2024 最新版）
  • 6
    无缝集成：在IntelliJ IDEA中利用Kubernetes插件轻松管理容器化应用
  • 7
    【视频】Boosting集成学习原理与R语言提升回归树BRT预测短鳍鳗分布生态学实例-2
  • 8
    Scikit-learn进阶：探索集成学习算法
  • 9
    使用Python实现集成学习算法：Bagging与Boosting
  • 10
    MIT等首次深度研究集成LLM预测能力：可媲美人类群体准确率
  • 1
    springboot中的第二个IOC容器BootstrapContext
    43
  • 2
    springboot使用html模版导出pdf文档
    153
  • 3
    springboot集成knife4j接口文档
    43
  • 4
    springboot - 条件注解@ConditionalOnClass原理
    20
  • 5
    SpringBoot启动后出现Please sign in页面
    48
  • 6
    Spring Boot的定时任务与异步任务
    53
  • 7
    SpringBoot整合Mybatis连接Oracle数据库
    65
  • 8
    通用Shell脚本执行Spring Boot项目Jar包
    31
  • 9
    【SpringBoot系列】SpringBoot集成Fast Mybatis
    173
  • 10
    Spring Boot集成Redis启动失败【Caused by: java.lang.ClassNotFoundException: org.apache.commons.pool2.impl.G】
    78

    • 相关课程

    更多
  • 大数据实战项目：反爬虫系统（Lua+Spark+Redis+Hadoop框架搭建）第二阶段
  • 大数据实战项目：反爬虫系统（Lua+Spark+Redis+Hadoop框架搭建）第三阶段
  • 大数据实战项目：反爬虫系统（Lua+Spark+Redis+Hadoop框架搭建）第五阶段
  • Redis入门实战演练
  • 云数据库 Redis 版使用教程
  • Redis数据库入门

    • 相关电子书

    更多
  • 阿里邮箱—安全高效集成
  • 集成智能接入网关APP：优化企业级移动办公网络
  • 云效助力企业集成安全到DevOps中

    • 相关实验场景

    更多
  • TLS1.3的后量子算法集成
  • Tair for Redis数据闪回：任意时间点数据恢复
  • 如何开通Redis的专属集群
  • 基于Redis实现在线游戏积分排行榜
    • 下一篇
    2024年阿里云免费云服务器及学生云服务器申请教程参考