参考代码
package com.ruoyi.common.redis.service;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.*;
import org.springframework.stereotype.Component;
/**
* spring redis 工具类
**/
@SuppressWarnings(value = "all")
@Component
public class RedisService
{
@Autowired
public RedisTemplate redisTemplate;
/**
* 设置有效时间
*
* @param key Redis键
* @param timeout 超时时间 时间(秒)
* @return true=设置成功；false=设置失败
*/
public boolean expire(final String key, final long timeout)
{
return expire(key, timeout, TimeUnit.SECONDS);
}
/**
* 设置有效时间
*
* @param key Redis键
* @param timeout 超时时间
* @param unit 时间单位
* @return true=设置成功；false=设置失败
*/
public boolean expire(final String key, final long timeout, final TimeUnit unit)
{
return redisTemplate.expire(key, timeout, unit);
}
/**
* 根据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)
{
return redisTemplate.hasKey(key);
}
/**
* 删除单个对象
*
* @param key
*/
public boolean del(final String key)
{
return redisTemplate.delete(key);
}
/**
* 删除集合对象
*
* @param collection 多个对象
* @return
*/
public long del(final Collection collection)
{
return redisTemplate.delete(collection);
}
//============================String=============================
/**
* 普通缓存获取。
*
* @param key 缓存键值
* @return 缓存键值对应的数据
*/
public <T> T get(final String key)
{
ValueOperations<String, T> operation = redisTemplate.opsForValue();
return operation.get(key);
}
/**
* 获得缓存的基本对象列表
*
* @param pattern 字符串前缀
* @return 对象列表
*/
public Collection<String> keys(final String pattern)
{
return redisTemplate.keys(pattern);
}
/**
* 缓存基本的对象，Integer、String、实体类等
*
* @param key 缓存的键值
* @param value 缓存的值
*/
public <T> void set(final String key, final T value)
{
redisTemplate.opsForValue().set(key, value);
}
/**
* 缓存基本的对象，Integer、String、实体类等
*
* @param key 缓存的键值
* @param value 缓存的值
* @param time 时间 (秒)
*/
public <T> void set(final String key, final T value, final long time)
{
redisTemplate.opsForValue().set(key, value, time, TimeUnit.SECONDS);
}
/**
* 缓存基本的对象，Integer、String、实体类等
*
* @param key 缓存的键值
* @param value 缓存的值
* @param timeout 时间
* @param timeUnit 时间颗粒度
*/
public <T> void set(final String key, final T value, final long timeout, final TimeUnit timeUnit)
{
redisTemplate.opsForValue().set(key, value, timeout, timeUnit);
}
/**
* 递增
*
* @param key 键
* @param delta 要增加几(大于0)
* @return
*/
public long incr(final String key, final long delta)
{
this.negativeNumber(delta, "递增因子必须大于0");
return redisTemplate.opsForValue().increment(key, delta);
}
/**
* 递减
*
* @param key 键
* @param delta 要减少几(小于0)
* @return
*/
public long decr(final String key, final long delta)
{
this.negativeNumber(delta, "递减因子必须大于0");
return redisTemplate.opsForValue().increment(key, -delta);
}
/**
* 尝试缓存指定对象
* @param key key
* @param value 值
* @param <T> 对象类型
* @return 添加成功:true, 添加失败false
*/
public <T> boolean setIfAbsent(final String key, final T value)
{
return redisTemplate.opsForValue().setIfAbsent(key, value);
}
/**
* 尝试缓存指定对象
* @param key key
* @param value 值
* @param timeout 超时时间: 单位秒
* @param <T> 对象类型
* @return 添加成功:true, 添加失败false
*/
public <T> boolean setIfAbsent(final String key, final T value, final long timeout)
{
return this.setIfAbsent(key, value, timeout, TimeUnit.SECONDS);
}
/**
* 尝试缓存指定对象
* @param key key
* @param value 值
* @param timeout 超时时间
* @param unit 时间单位
* @param <T> 对象类型
* @return 添加成功:true, 添加失败false
*/
public <T> boolean setIfAbsent(final String key, final T value, final long timeout, final TimeUnit unit)
{
return redisTemplate.opsForValue().setIfAbsent(key, value, timeout, unit);
}
//================================Map=================================
/**
* 获取Hash中的数据
*
* @param key Redis键
* @param hKey Hash键
* @return Hash中的对象
*/
public <T> T hget(final String key, final String hKey)
{
HashOperations<String, String, T> opsForHash = redisTemplate.opsForHash();
return opsForHash.get(key, hKey);
}
/**
* 获取多个Hash中的数据
*
* @param key Redis键
* @param hKeys Hash键集合
* @return Hash对象集合
*/
public <T> List<T> hgets(final String key, final Collection<?> hKeys)
{
return redisTemplate.opsForHash().multiGet(key, hKeys);
}
/**
* 获取hashKey对应的所有键值
*
* @param key 键
* @return 对应的多个键值
*/
public <T> Map<String, T> hmget(final String key)
{
return redisTemplate.opsForHash().entries(key);
}
/**
* HashSet
*
* @param key 键
* @param map 对应多个键值
*/
public <T> void hmset(final String key, final Map<String, T> map)
{
if (map != null)
{
redisTemplate.opsForHash().putAll(key, map);
}
}
/**
* HashSet 并设置时间
*
* @param key 键
* @param map 对应多个键值
* @param time 时间(秒)
*/
public <T> void hmset(final String key, final Map<String, T> map, final long time)
{
if (map != null)
{
redisTemplate.opsForHash().putAll(key, map);
expire(key, time);
}
}
/**
* HashSet 并设置时间
*
* @param key 键
* @param map 对应多个键值
* @param time 时间
* @param unit 时间单位
*/
public <T> void hmset(final String key, final Map<String, T> map, final long time, final TimeUnit unit)
{
if (map != null)
{
redisTemplate.opsForHash().putAll(key, map);
expire(key, time, unit);
}
}
/**
* 向一张hash表中放入数据,如果不存在将创建
*
* @param key 键
* @param hKey 项
* @param value 值
*/
public <T> void hset(final String key, final String hKey, final T value)
{
redisTemplate.opsForHash().put(key, hKey, value);
}
/**
* 向一张hash表中放入数据,如果不存在将创建
*
* @param key 键
* @param hKey 项
* @param value 值
* @param time 时间(秒) 注意:如果已存在的hash表有时间,这里将会替换原有的时间
*/
public <T> void hset(final String key, final String hKey, final T value, final long time)
{
redisTemplate.opsForHash().put(key, hKey, value);
expire(key, time);
}
/**
* 向一张hash表中放入数据,如果不存在将创建
*
* @param key 键
* @param hKey 项
* @param value 值
* @param time 时间 注意:如果已存在的hash表有时间,这里将会替换原有的时间
* @param unit 时间单位
*/
public <T> void hset(final String key, final String hKey, final T value, final long time, final TimeUnit unit)
{
redisTemplate.opsForHash().put(key, hKey, value);
expire(key, time, unit);
}
/**
* 删除hash表中的值
*
* @param key 键 不能为null
* @param hKey 项 可以使多个 不能为null
*/
public void hdel(final String key, final Object... hKey)
{
redisTemplate.opsForHash().delete(key, hKey);
}
/**
* 判断hash表中是否有该项的值
*
* @param key 键 不能为null
* @param hKey 项 不能为null
* @return true 存在 false不存在
*/
public boolean hHasKey(final String key, final String hKey)
{
return redisTemplate.opsForHash().hasKey(key, hKey);
}
/**
* hash递增 如果不存在,就会创建一个 并把新增后的值返回
*
* @param key 键
* @param hKey 项
* @param by 要增加几(大于0)
* @return
*/
public double hincr(final String key, final String hKey, final double by)
{
return redisTemplate.opsForHash().increment(key, hKey, by);
}
/**
* hash递减
*
* @param key 键
* @param hKey 项
* @param by 要减少记(小于0)
* @return
*/
public double hdecr(final String key, final String hKey, final double by)
{
return redisTemplate.opsForHash().increment(key, hKey, -by);
}
/**
* 获取hash列表的数量
* @param key 键
* @return
*/
public long hGetHashSize(final String key)
{
return redisTemplate.opsForHash().size(key);
}
//================================Set=================================
/**
* 将数据放入set缓存
*
* @param key 缓存键值
* @param set 缓存的数据
* @return 缓存数据的数量
*/
public <T> long sSet(final String key, final Set<T> set)
{
Long count = redisTemplate.opsForSet().add(key, set);
return count == null ? 0 : count;
}
/**
* 将数据放入set缓存 并设置时间
*
* @param key 缓存键值
* @param set 缓存的数据
* @param time 时间(秒)
* @return 缓存数据的数量
*/
public <T> long sSet(final String key, final Set<T> set, final long time)
{
Long count = redisTemplate.opsForSet().add(key, set);
expire(key, time);
return count == null ? 0 : count;
}
/**
* 将数据放入set缓存 并设置时间
*
* @param key 缓存键值
* @param set 缓存的数据
* @param time 时间
* @param unit 时间单位
* @return 缓存数据的数量
*/
public <T> long sSet(final String key, final Set<T> set, final long time, final TimeUnit unit)
{
Long count = redisTemplate.opsForSet().add(key, set);
expire(key, time, unit);
return count == null ? 0 : count;
}
/**
* 将数据放入set缓存
*
* @param key 键
* @param values 值 可以是多个
* @return 成功个数
*/
public long sSet(final String key, final Object... values)
{
Long count = redisTemplate.opsForSet().add(key, values);
return count == null ? 0 : count;
}
/**
* 将数据放入set缓存
*
* @param key 键
* @param time 时间(秒)
* @param values 值 可以是多个
* @return 成功个数
*/
public long sSet(final String key, final long time, final Object... values)
{
Long count = redisTemplate.opsForSet().add(key, values);
expire(key, time);
return count == null ? 0 : count;
}
/**
* 将数据放入set缓存
*
* @param key 键
* @param time 时间(秒)
* @param unit 时间单位
* @param values 值 可以是多个
* @return 成功个数
*/
public long sSet(final String key, final long time, final TimeUnit unit, final Object... values)
{
Long count = redisTemplate.opsForSet().add(key, values);
expire(key, time, unit);
return count == null ? 0 : count;
}
/**
* 根据value从一个set中查询,是否存在
*
* @param key 键
* @param value 值
* @return true 存在 false不存在
*/
public boolean sHasKey(final String key, final Object value)
{
return redisTemplate.opsForSet().isMember(key, value);
}
/**
* 根据key获取Set中的所有值
*
* @param key
* @return
*/
public <T> Set<T> sGet(final String key)
{
return redisTemplate.opsForSet().members(key);
}
/**
* 获取set缓存的长度
*
* @param key 键
* @return
*/
public long sGetSetSize(final String key)
{
return redisTemplate.opsForSet().size(key);
}
/**
* 移除值为value的
*
* @param key 键
* @param values 值 可以是多个
* @return 移除的个数
*/
public long setRemove(String key, Object... values)
{
Long count = redisTemplate.opsForSet().remove(key, values);
return count == null ? 0 : count;
}
//================================List=================================
/**
* 获得所有缓存的list缓存的内容
*
* @param key 缓存的键值
* @return 缓存键值对应的数据
*/
public <T> List<T> lGet(final String key)
{
return redisTemplate.opsForList().range(key, 0, -1);
}
/**
* 获取指定位置list缓存的内容
*
* @param key 键
* @param start 开始
* @param end 结束 0 到 -1代表所有值
* @return
*/
public <T> List<T> lGet(final String key, final long start, final long end)
{
return redisTemplate.opsForList().range(key, start, end);
}
/**
* 列表只保留指定区间内的元素，不在指定区间之内的元素都将被删除
* @param key 键
* @param start 开始
* @param end 结束 0 到 -1代表所有值
*/
public void lTrim(final String key, final long start, final long end)
{
redisTemplate.opsForList().trim(key, start, end);
}
/**
* 通过索引 获取list中的值
*
* @param key 键
* @param index 索引 index>=0时， 0 表头，1 第二个元素，依次类推；index<0时，-1，表尾，-2倒数第二个元素，依次类推
* @return
*/
public <T> T lGetIndex(final String key, final long index)
{
ListOperations<String, T> opsForList = redisTemplate.opsForList();
return opsForList.index(key, index);
}
/**
* 获取list缓存的长度
*
* @param key 键
* @return
*/
public long lGetListSize(final String key)
{
return redisTemplate.opsForList().size(key);
}
/**
* 缓存List数据
*
* @param key 缓存的键值
* @param list 待缓存的List数据
* @return 缓存的对象
*/
public <T> long lSet(final String key, final List<T> list)
{
Long count = redisTemplate.opsForList().rightPushAll(key, list);
return count == null ? 0 : count;
}
/**
* 缓存List数据
*
* @param key 缓存的键值
* @param list 待缓存的List数据
* @param time 时间(秒)
* @return 缓存的对象
*/
public <T> long lSet(final String key, final List<T> list, final long time)
{
Long count = redisTemplate.opsForList().rightPushAll(key, list);
expire(key, time);
return count == null ? 0 : count;
}
/**
* 缓存List数据
*
* @param key 缓存的键值
* @param list 待缓存的List数据
* @param time 时间
* @param unit 时间单位
* @return 缓存的对象
*/
public <T> long lSet(final String key, final List<T> list, final long time, final TimeUnit unit)
{
Long count = redisTemplate.opsForList().rightPushAll(key, list);
expire(key, time, unit);
return count == null ? 0 : count;
}
/**
* 将list放入缓存
*
* @param key 键
* @param value 值
* @return
*/
public <T> long lSet(final String key, final T value)
{
Long count = redisTemplate.opsForList().rightPush(key, value);
return count == null ? 0 : count;
}
/**
* 将list放入缓存
*
* @param key 键
* @param value 值
* @param time 时间(秒)
* @return
*/
public <T> long lSet(final String key, final T value, final long time)
{
Long count = redisTemplate.opsForList().rightPush(key, value);
expire(key, time);
return count == null ? 0 : count;
}
/**
* 将list放入缓存
*
* @param key 键
* @param value 值
* @param time 时间
* @param unit 时间单位
* @return
*/
public <T> long lSet(final String key, final T value, final long time, final TimeUnit unit)
{
Long count = redisTemplate.opsForList().rightPush(key, value);
expire(key, time, unit);
return count == null ? 0 : count;
}
/**
* 根据索引修改list中的某条数据
*
* @param key 键
* @param index 索引
* @param value 值
* @return
*/
public <T> void lUpdateIndex(final String key, final long index, final T value)
{
redisTemplate.opsForList().set(key, index, value);
}
/**
* 移除N个值为value
*
* @param key 键
* @param count 移除多少个
* @param value 值
* @return 移除的个数
*/
public long lRemove(final String key, final long count, final Object value)
{
Long remove = redisTemplate.opsForList().remove(key, count, value);
return remove == null ? 0 : remove;
}
/**
* 弹出最左边的元素，弹出之后该值在列表中将不复存在
*
* @param key 键
* @return 弹出的值
*/
public <T> T leftPop(final String key)
{
ListOperations<String, T> opsForList = redisTemplate.opsForList();
return opsForList.leftPop(key);
}
/**
* 弹出最左边指定数量的元素，弹出之后这些值在列表中将不复存在
*
* @param key 键
* @param count 指定数量 必须为正整数
* @return 弹出指定数量的数据
*/
public <T> List<T> leftPopList(final String key, final long count)
{
// 获取list左边指定数量的数据
List<T> opsForList = this.lGet(key, 0, count - 1);
// 删除list左边指定数量的数据
this.lTrim(key, count, -1);
return opsForList;
}
/**
* 弹出最右边指定数量的元素，弹出之后这些值在列表中将不复存在
*
* @param key 键
* @param count 指定数量 必须为正整数
* @return 弹出指定数量的数据
*/
public <T> List<T> rightPopList(final String key, final long count)
{
// 获取list右边指定数量的数据
List<T> opsForList = this.lGet(key, -1 - count, -1);
// 删除list右边指定数量的数据
this.lTrim(key, 0, -1 - count);
return opsForList;
}
}
