RedisTemplate常用操作封装类

最新推荐文章于 2024-08-30 20:47:31 发布

原创最新推荐文章于 2024-08-30 20:47:31 发布 · 958 阅读

2 ·

本内容遵循CC 4.0 BY-SA版权协议

标签

#java #jvm #数据库

该文档提供了一套使用RedisTemplate实现的分布式锁增强版以及对String、哈希、Set和List等数据类型的缓存操作方法，包括添加、获取、删除、更新和过期时间管理等。

一、通用操作工具

1、常用的分布式锁加强版

    /**
       * 最终加强分布式锁
       * @param key key值
       * @return 是否获取到
       */
  public boolean lock(String key) {
          String lock = LOCK_PREFIX + key;
          // 利用lambda表达式
          return (Boolean) redisTemplate.execute(new RedisCallback<Object>() {
              @Override
              public Object doInRedis(RedisConnection redisConnection) throws DataAccessException {
                  long expireAt = System.currentTimeMillis() + LOCK_EXPIRE + 1;
                  Boolean acquire = redisConnection.setNX(lock.getBytes(), String.valueOf(expireAt).getBytes());
                  if (acquire) {
                      return true;
                  } else {
                      byte[] value = redisConnection.get(lock.getBytes());
                      if (Objects.nonNull(value) && value.length > 0) {
                          long expireTime = Long.parseLong(new String(value));
                          if (expireTime < System.currentTimeMillis()) {
                              // 如果锁已经过期
                              byte[] oldValue = redisConnection.getSet(lock.getBytes(), String.valueOf(System.currentTimeMillis() + LOCK_EXPIRE + 1).getBytes());
                              // 防止死锁
                              return Long.parseLong(new String(oldValue)) < System.currentTimeMillis();
                          }
                      }
                  }
                  return false;
              }
          });
      }

2、删除锁

    /**
       * 删除锁
       *
       * @param key
       */
      public void delete(String key) {
          redisTemplate.delete(key);
      }

3、指定缓存失效时间

    /**
       * 指定缓存失效时间
       * @param key 键
       * @param time 时间(秒)
       * @return
       */
      public boolean expire(String key,long time){
          try {
              if(time>0){
                  redisTemplate.expire(key, time, TimeUnit.SECONDS);
              }
              return true;
          } catch (Exception e) {
              e.printStackTrace();
              return false;
          }
      }

4、根据key 获取过期时间

    /**
       * 根据key 获取过期时间
       * @param key 键 不能为null
       * @return 时间(秒) 返回0代表为永久有效
       */
      public long getExpire(String key){
          return redisTemplate.getExpire(key,TimeUnit.SECONDS);
      }

5、判断key是否存在

    /**
       * 判断key是否存在
       * @param key 键
       * @return true 存在 false不存在
       */
      public boolean hasKey(String key){
          try {
              return redisTemplate.hasKey(key);
          } catch (Exception e) {
              e.printStackTrace();
              return false;
          }
      }

6、删除缓存

    /**
       * 删除缓存
       * @param key 可以传一个值 或多个
       */
      @SuppressWarnings("unchecked")
      public void del(String ... key){
          if(key!=null&&key.length>0){
              if(key.length==1){
                  redisTemplate.delete(key[0]);
              }else{
                  redisTemplate.delete(CollectionUtils.arrayToList(key));
              }
          }
      }

二、 String类型相关操作

1、获取缓存

    /**
       * 获取缓存
       * @param key 键
       * @return 值
       */
      public Object get(String key){
          return key==null?null:redisTemplate.opsForValue().get(key);
      }

2、添加缓存

    /**
       * 添加缓存
       * @param key 键
       * @param value 值
       * @return true成功 false失败
       */
      public boolean set(String key,Object value) {
          try {
              redisTemplate.opsForValue().set(key, value);
              return true;
          } catch (Exception e) {
              e.printStackTrace();
              return false;
          }
  
      }

3、添加缓存并设置过期时间

    /**
       * 添加缓存并设置过期时间
       * @param key 键
       * @param value 值
       * @param time 时间(秒) time要大于0 如果time小于等于0 将设置无限期
       * @return true成功 false 失败
       */
      public boolean set(String key,Object value,long time){
          try {
              if(time>0){
                  redisTemplate.opsForValue().set(key, value, time, TimeUnit.SECONDS);
              }else{
                  set(key, value);
              }
              return true;
          } catch (Exception e) {
              e.printStackTrace();
              return false;
          }
      }

4、递增操作

    /**
       * 递增
       * @param key 键
       * @return
       */
      public long incr(String key, long delta){
          if(delta<0){
              throw new RuntimeException("递增因子必须大于0");
          }
          return redisTemplate.opsForValue().increment(key, delta);
      }

5、递减操作

    /**
       * 递减
       * @param key 键
       * @return
       */
      public long decr(String key, long delta){
          if(delta<0){
              throw new RuntimeException("递减因子必须大于0");
          }
          return redisTemplate.opsForValue().increment(key, -delta);
      }

三、哈希类型相关操作

1、设置一组Map的键值对

    /**
       * HashGet
       * @param key 键 不能为null
       * @param item 项 不能为null
       * @return 值
       */
      public Object hget(String key,String item){
          return redisTemplate.opsForHash().get(key, item);
      }

2、获取指定Map的所有键值对

    /**
       * 获取hashKey对应的所有键值
       * @param key 键
       * @return 对应的多个键值
       */
      public Map<Object,Object> hmget(String key){
          return redisTemplate.opsForHash().entries(key);
      }

3、添加一个Map类型值

    /**
       * HashSet
       * @param key 键
       * @param map 对应多个键值
       * @return true 成功 false 失败
       */
      public boolean hmset(String key, Map<String,Object> map){
          try {
              redisTemplate.opsForHash().putAll(key, map);
              return true;
          } catch (Exception e) {
              e.printStackTrace();
              return false;
          }
      }

4、添加一个Map类型值并设置过期时间

    /**
       * HashSet 并设置时间
       * @param key 键
       * @param map 对应多个键值
       * @param time 时间(秒)
       * @return true成功 false失败
       */
      public boolean hmset(String key, Map<String,Object> map, long time){
          try {
              redisTemplate.opsForHash().putAll(key, map);
              if(time>0){
                  expire(key, time);
              }
              return true;
          } catch (Exception e) {
              e.printStackTrace();
              return false;
          }
      }

5、向一张hash表中放入数据,如果不存在将创建

    /**
       * 向一张hash表中放入数据,如果不存在将创建
       * @param key 键
       * @param item 项
       * @param value 值
       * @return true 成功 false失败
       */
      public boolean hset(String key,String item,Object value) {
          try {
              redisTemplate.opsForHash().put(key, item, value);
              return true;
          } catch (Exception e) {
              e.printStackTrace();
              return false;
          }
      }

6、向一张hash表中放入数据,如果不存在将创建并设置过期时间

    /**
       * 向一张hash表中放入数据,如果不存在将创建
       * @param key 键
       * @param item 项
       * @param value 值
       * @param time 时间(秒)  注意:如果已存在的hash表有时间,这里将会替换原有的时间
       * @return true 成功 false失败
       */
      public boolean hset(String key,String item,Object value,long time) {
          try {
              redisTemplate.opsForHash().put(key, item, value);
              if(time>0){
                  expire(key, time);
              }
              return true;
          } catch (Exception e) {
              e.printStackTrace();
              return false;
          }
      }

7、删除hash表中的值

    /**
       * 删除hash表中的值
       * @param key 键 不能为null
       * @param item 项 可以使多个 不能为null
       */
      public void hdel(String key, Object... item){
          redisTemplate.opsForHash().delete(key,item);
      }

8、判断hash表中是否有该项的值

    /**
       * 判断hash表中是否有该项的值
       * @param key 键 不能为null
       * @param item 项 不能为null
       * @return true 存在 false不存在
       */
      public boolean hHasKey(String key, String item){
          return redisTemplate.opsForHash().hasKey(key, item);
      }

9、递增，如果不存在,就会创建一个并把新增后的值返回

    /**
       * hash递增 如果不存在,就会创建一个 并把新增后的值返回
       * @param key 键
       * @param item 项
       * @param by 要增加几(大于0)
       * @return
       */
      public double hincr(String key, String item,double by){
          return redisTemplate.opsForHash().increment(key, item, by);
      }

10、递减

    /**
       * hash递减
       * @param key 键
       * @param item 项
       * @param by 要减少记(小于0)
       * @return
       */
      public double hdecr(String key, String item,double by){
          return redisTemplate.opsForHash().increment(key, item,-by);
      }

四、 SET类型相关操作

1、根据key获取Set中的所有值

    /**
       * 根据key获取Set中的所有值
       * @param key 键
       * @return
       */
      public Set<Object> sGet(String key){
          try {
              return redisTemplate.opsForSet().members(key);
          } catch (Exception e) {
              e.printStackTrace();
              return null;
          }
      }

2、根据value从一个set中查询,是否存在

    /**
       * 根据value从一个set中查询,是否存在
       * @param key 键
       * @param value 值
       * @return true 存在 false不存在
       */
      public boolean sHasKey(String key,Object value){
          try {
              return redisTemplate.opsForSet().isMember(key, value);
          } catch (Exception e) {
              e.printStackTrace();
              return false;
          }
      }

3、添加一个SET缓存

    /**
       * 将数据放入set缓存
       * @param key 键
       * @param values 值 可以是多个
       * @return 成功个数
       */
      public long sSet(String key, Object...values) {
          try {
              return redisTemplate.opsForSet().add(key, values);
          } catch (Exception e) {
              e.printStackTrace();
              return 0;
          }
      }

4、添加一个SET缓存并设置过期时间

    /**
       * 将set数据放入缓存
       * @param key 键
       * @param time 时间(秒)
       * @param values 值 可以是多个
       * @return 成功个数
       */
      public long sSetAndTime(String key,long time,Object...values) {
          try {
              Long count = redisTemplate.opsForSet().add(key, values);
              if(time>0) expire(key, time);
              return count;
          } catch (Exception e) {
              e.printStackTrace();
              return 0;
          }
      }

5、获取SET缓存的长度

    /**
       * 获取set缓存的长度
       * @param key 键
       * @return
       */
      public long sGetSetSize(String key){
          try {
              return redisTemplate.opsForSet().size(key);
          } catch (Exception e) {
              e.printStackTrace();
              return 0;
          }
      }

6、移除指定key的缓存

    /**
       * 移除值为value的
       * @param key 键
       * @param values 值 可以是多个
       * @return 移除的个数
       */
      public long setRemove(String key, Object ...values) {
          try {
              Long count = redisTemplate.opsForSet().remove(key, values);
              return count;
          } catch (Exception e) {
              e.printStackTrace();
              return 0;
          }
      }

五、 LIST类型相关操作

1、获取list缓存的内容

    /**
       * 获取list缓存的内容
       * @param key 键
       * @param start 开始
       * @param end 结束  0 到 -1代表所有值
       * @return
       */
      public List<Object> lGet(String key,long start, long end){
          try {
              return redisTemplate.opsForList().range(key, start, end);
          } catch (Exception e) {
              e.printStackTrace();
              return null;
          }
      }

2、获取list缓存的长度

    /**
       * 获取list缓存的长度
       * @param key 键
       * @return
       */
      public long lGetListSize(String key){
          try {
              return redisTemplate.opsForList().size(key);
          } catch (Exception e) {
              e.printStackTrace();
              return 0;
          }
      }

3、通过索引获取list中的值

    /**
       * 通过索引 获取list中的值
       * @param key 键
       * @param index 索引  index>=0时， 0 表头，1 第二个元素，依次类推；index<0时，-1，表尾，-2倒数第二个元素，依次类推
       * @return
       */
      public Object lGetIndex(String key,long index){
          try {
              return redisTemplate.opsForList().index(key, index);
          } catch (Exception e) {
              e.printStackTrace();
              return null;
          }
      }

4、将list放入缓存

    /**
       * 将list放入缓存
       * @param key 键
       * @param value 值
       * @return
       */
      public boolean lSet(String key, Object value) {
          try {
              redisTemplate.opsForList().rightPush(key, value);
              return true;
          } catch (Exception e) {
              e.printStackTrace();
              return false;
          }
      }

5、将list放入缓存并设置过期时间

    /**
       * 将list放入缓存
       * @param key 键
       * @param value 值
       * @param time 时间(秒)
       * @return
       */
      public boolean lSet(String key, Object value, long time) {
          try {
              redisTemplate.opsForList().rightPush(key, value);
              if (time > 0) expire(key, time);
              return true;
          } catch (Exception e) {
              e.printStackTrace();
              return false;
          }
      }

6、将list放入缓存

    /**
       * 将list放入缓存
       * @param key 键
       * @param value 值
       * @return
       */
      public boolean lSet(String key, List<Object> value) {
          try {
              redisTemplate.opsForList().rightPushAll(key, value);
              return true;
          } catch (Exception e) {
              e.printStackTrace();
              return false;
          }
      }

7、将list放入缓存并设置过期时间

    /**
       * 将list放入缓存
       * @param key 键
       * @param value 值
       * @param time 时间(秒)
       * @return
       */
      public boolean lSet(String key, List<Object> value, long time) {
          try {
              redisTemplate.opsForList().rightPushAll(key, value);
              if (time > 0) expire(key, time);
              return true;
          } catch (Exception e) {
              e.printStackTrace();
              return false;
          }
      }

8、根据索引修改list中的某条数据

    /**
       * 根据索引修改list中的某条数据
       * @param key 键
       * @param index 索引
       * @param value 值
       * @return
       */
      public boolean lUpdateIndex(String key, long index,Object value) {
          try {
              redisTemplate.opsForList().set(key, index, value);
              return true;
          } catch (Exception e) {
              e.printStackTrace();
              return false;
          }
      }

9、移除N个值为value

    /**
       * 移除N个值为value
       * @param key 键
       * @param count 移除多少个
       * @param value 值
       * @return 移除的个数
       */
      public long lRemove(String key,long count,Object value) {
          try {
              Long remove = redisTemplate.opsForList().remove(key, count, value);
              return remove;
          } catch (Exception e) {
              e.printStackTrace();
              return 0;
          }
      }