勿忘初心做自己 发表于 2023-4-13 19:42:34

redis 工具类

redis 工具类

/**
* Redis 工具类
*/
@Component
public class RedisUtil {

    @Resource
    private RedisTemplate<String, Object> redisTemplate;

    public RedisUtil(RedisTemplate<String, Object> redisTemplate) {
      this.redisTemplate = redisTemplate;
    }

    /**
   * 指定缓存失效时间
   *
   * @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;
      }
    }

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

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

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

    //============================String=============================

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

    /**
   * 普通缓存放入
   *
   * @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;
      }
    }

    /**
   * 普通缓存放入并设置时间
   *
   * @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;
      }
    }

    /**
   * 分布式锁
   * @param key               锁住的key
   * @param lockExpireMils    锁住的时长。如果超时未解锁,视为加锁线程死亡,其他线程可夺取锁
   * @return
   */
    public boolean setNx(String key, Long lockExpireMils) {
      return (boolean) redisTemplate.execute((RedisCallback) connection -> {
            //获取锁
            return connection.setNX(key.getBytes(), String.valueOf(System.currentTimeMillis() + lockExpireMils + 1).getBytes());
      });
    }

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

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

    //================================Map=================================

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

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

    /**
   * 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;
      }
    }

    /**
   * 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;
      }
    }

    /**
   * 向一张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;
      }
    }

    /**
   * 向一张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;
      }
    }

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

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

    /**
   * 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);
    }

    /**
   * 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=============================

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

    /**
   * 根据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;
      }
    }

    /**
   * 将数据放入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;
      }
    }

    /**
   * 将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;
      }
    }

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

    /**
   * 移除值为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=================================

    /**
   * 获取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;
      }
    }

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

    /**
   * 通过索引 获取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;
      }
    }

    /**
   * 将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;
      }
    }

    /**
   * 将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;
      }
    }

    /**
   * 将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;
      }
    }

    /**
   * 将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;
      }
    }

    /**
   * 根据索引修改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;
      }
    }

    /**
   * 移除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;
      }
    }

    /**
   * 模糊查询获取key值
   *
   * @param pattern
   * @return
   */
    public Set keys(String pattern) {
      return redisTemplate.keys(pattern);
    }

    /**
   * 使用Redis的消息队列
   *
   * @param channel
   * @param message 消息内容
   */
    public void convertAndSend(String channel, Object message) {
      redisTemplate.convertAndSend(channel, message);
    }


    //=========BoundListOperations 用法 start============

    /**
   * 将数据添加到Redis的list中(从右边添加)
   *
   * @param listKey
   * @param timeout 有效时间
   * @param unit    时间类型
   * @param values待添加的数据
   */
    public void addToListRight(String listKey, long timeout, TimeUnit unit, Object... values) {
      //绑定操作
      BoundListOperations<String, Object> boundValueOperations = redisTemplate.boundListOps(listKey);
      //插入数据
      boundValueOperations.rightPushAll(values);
      //设置过期时间
      boundValueOperations.expire(timeout, unit);
    }

    /**
   * 根据起始结束序号遍历Redis中的list
   *
   * @param listKey
   * @param start   起始序号
   * @param end   结束序号
   * @return
   */
    public List<Object> rangeList(String listKey, long start, long end) {
      //绑定操作
      BoundListOperations<String, Object> boundValueOperations = redisTemplate.boundListOps(listKey);
      //查询数据
      return boundValueOperations.range(start, end);
    }

    /**
   * 弹出右边的值 --- 并且移除这个值
   *
   * @param listKey
   */
    public Object rightPop(String listKey) {
      //绑定操作
      BoundListOperations<String, Object> boundValueOperations = redisTemplate.boundListOps(listKey);
      return boundValueOperations.rightPop();
    }

    //=========BoundListOperations 用法 End============

}
免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!
页: [1]
查看完整版本: redis 工具类