net.hlinfo.opt

类 RedisUtils

java.lang.Object

net.hlinfo.opt.RedisUtils

@Component
public class RedisUtils
extends Object

Redis操作工具类

作者:

hlinfo.net

字段概要

字段

限定符和类型	字段和说明
org.springframework.data.redis.core.RedisTemplate	redisTemplate RedisTemplate实例化对象

构造器概要

构造器

构造器和说明
RedisUtils(org.springframework.data.redis.core.RedisTemplate redisTemplate) 通过构造函数注入RedisTemplate

方法概要

限定符和类型	方法和说明
void	deleteByPrex(String key) 模糊删除，keys*
void	deleteBySuffix(String key) 模糊删除，*keys
void	deleteObject(Collection collection) 删除集合对象
void	deleteObject(String key) 删除单个对象
Boolean	expire(String key, long timeout, TimeUnit unit) 设置过期时间
Boolean	expireAt(String key, Date date) 设置过期时间
int	getCacheInt(String key) 获得缓存的基本对象。
<T> List<T>	getCacheList(String key) 获得缓存的list对象
<T> Map<String,T>	getCacheMap(String key) 获得缓存的Map
<T> Set<T>	getCacheSet(String key) 获得缓存的set
long	getExpire(String key, TimeUnit timeUnit) 获取剩余的过期时间（指定时间单位）
long	getExpireMin(String key) 获取剩余的过期时间(分钟)
long	getExpireSeconds(String key) 获取剩余的过期时间(秒)
<T> List<T>	getListString(String key, Class<T> clazz) 获得缓存的list对象
<T> T	getObject(String key) 获得缓存的基本对象。
boolean	hashKeys(String key) 判断key是否存在
Long	incrBy(String key, long increment) 增加(自增长), 负数则为自减
Collection<String>	keys(String pattern) 获得缓存的基本对象列表
Set<String>	keysPrex(String keyPrefix) 获取指定前缀的一系列key 使用scan命令代替keys, Redis是单线程处理，keys命令在KEY数量较多时， 操作效率极低【时间复杂度为O(N)】，该命令一旦执行会严重阻塞线上其它命令的正常请求
Boolean	move(String key, int dbIndex) 将当前数据库的 key 移动到给定的数据库 db 当中
Boolean	persist(String key) 移除 key 的过期时间，key 将持久保持
String	randomKey() 从当前数据库中随机返回一个 key
boolean	removeAll(String keyPrefix) 删除指定前缀的一系列key
void	rename(String oldKey, String newKey) 修改 key 的名称
Boolean	renameIfAbsent(String oldKey, String newKey) 仅当 newkey 不存在时，将 oldKey 改名为 newkey
<T> org.springframework.data.redis.core.ValueOperations<String,T>	resetCacheData(String key, T value) 缓存对象数据，指定时间
<T> org.springframework.data.redis.core.ValueOperations<String,T>	resetCacheData(String key, T value, long minutes) 缓存对象数据，指定时间
Set<String>	sDifference(String key, Collection<String> otherKeys) 获取key集合与多个集合的差集
Long	sDifference(String key, Collection<String> otherKeys, String destKey) key与多个key的差集存储到destKey中
Set<String>	sDifference(String key, String otherKey) 获取两个集合的差集
Long	sDifference(String key, String otherKey, String destKey) key集合与otherKey集合的差集存储到destKey中
<T> org.springframework.data.redis.core.ValueOperations<String,T>	setCacheData(String key, T value, long minutes) 缓存对象数据，指定时间（分钟）
<T> org.springframework.data.redis.core.ListOperations<String,T>	setCacheList(String key, List<T> dataList) 缓存List数据(Redis本身的List)
<T> org.springframework.data.redis.core.HashOperations<String,String,T>	setCacheMap(String key, Map<String,T> dataMap) 缓存Map
<T> org.springframework.data.redis.core.BoundSetOperations<String,T>	setCacheSet(String key, Set<T> dataSet) 缓存Set
<T> Object	setListString(String key, List<T> list) 缓存List数据
<T> org.springframework.data.redis.core.ValueOperations<String,T>	setObject(String key, T value) 缓存基本的对象，Integer、String、实体类等
<T> org.springframework.data.redis.core.ValueOperations<String,T>	setObject(String key, T value, Integer timeout, TimeUnit timeUnit) 缓存基本的对象，Integer、String、实体类等，带过期时间
Set<String>	sIntersect(String key, Collection<String> otherKeys) 获取key集合与多个集合的交集
Set<String>	sIntersect(String key, String otherKey) 获取两个键值的交集
Long	sIntersectAndStore(String key, Collection<String> otherKeys, String destKey) key集合与多个集合的交集存储到destKey集合中
Long	sIntersectAndStore(String key, String otherKey, String destKey) key集合与otherKey集合的交集存储到destKey集合中
Set<String>	sUnion(String key, Collection<String> otherKeys) 获取key集合与多个集合的并集
Set<String>	sUnion(String key, String otherKeys) 获取两个集合的并集
Long	sUnionAndStore(String key, Collection<String> otherKeys, String destKey) key集合与多个集合的并集存储到destKey中
Long	sUnionAndStore(String key, String otherKey, String destKey) key集合与otherKey集合的并集存储到destKey中
org.springframework.data.redis.connection.DataType	type(String key) 返回 key 所储存的值的类型
Boolean	zAdd(String key, String value, double score) 添加元素,有序集合是按照元素的score值由小到大排列
Double	zIncrementScore(String key, String value, double delta) 增加元素的score值，并返回增加后的值
Set<String>	zRange(String key, long start, long end) 获取集合的元素, 从小到大排序
Long	zRank(String key, Object value) 返回元素在集合的排名,有序集合是按照元素的score值由小到大排列
Long	zReverseRank(String key, Object value) 返回元素在集合的排名,按元素的score值由大到小排列

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

redisTemplate

public org.springframework.data.redis.core.RedisTemplate redisTemplate

RedisTemplate实例化对象

构造器详细资料

RedisUtils

public RedisUtils(org.springframework.data.redis.core.RedisTemplate redisTemplate)

通过构造函数注入RedisTemplate

参数:

redisTemplate - RedisTemplate实例化对象

方法详细资料

setObject

public <T> org.springframework.data.redis.core.ValueOperations<String,T> setObject(String key,
                                                                                   T value)

缓存基本的对象，Integer、String、实体类等

参数:

key - 缓存的键

value - 缓存的值

返回:

缓存的对象

setObject

public <T> org.springframework.data.redis.core.ValueOperations<String,T> setObject(String key,
                                                                                   T value,
                                                                                   Integer timeout,
                                                                                   TimeUnit timeUnit)

缓存基本的对象，Integer、String、实体类等，带过期时间

参数:

key - 缓存的键

value - 缓存的值

timeout - 时间

timeUnit - 时间颗粒度

返回:

缓存的对象

getObject

public <T> T getObject(String key)

获得缓存的基本对象。

参数:

key - 缓存的键

返回:

缓存的键对应的数据

deleteObject

public void deleteObject(String key)

删除单个对象

参数:

key - redis缓存的键

deleteObject

public void deleteObject(Collection collection)

删除集合对象

参数:

collection - 集合

setCacheList

public <T> org.springframework.data.redis.core.ListOperations<String,T> setCacheList(String key,
                                                                                     List<T> dataList)

缓存List数据(Redis本身的List)

参数:

key - 缓存的键

dataList - 待缓存的List数据

返回:

缓存的对象

getCacheList

public <T> List<T> getCacheList(String key)

获得缓存的list对象

参数:

key - 缓存的键

返回:

缓存的键对应的数据

setCacheSet

public <T> org.springframework.data.redis.core.BoundSetOperations<String,T> setCacheSet(String key,
                                                                                        Set<T> dataSet)

缓存Set

参数:

key - 缓存的键

dataSet - 缓存的数据

返回:

缓存数据的对象

getCacheSet

public <T> Set<T> getCacheSet(String key)

获得缓存的set

参数:

key -

返回:

setCacheMap

public <T> org.springframework.data.redis.core.HashOperations<String,String,T> setCacheMap(String key,
                                                                                           Map<String,T> dataMap)

缓存Map

参数:

key - redis键

dataMap - map数据

返回:

缓存的对象

getCacheInt

public int getCacheInt(String key)

获得缓存的基本对象。

参数:

key - 缓存的键

返回:

缓存的键对应的数据

getCacheMap

public <T> Map<String,T> getCacheMap(String key)

获得缓存的Map

参数:

key - redis键

返回:

获取的map结果

keys

public Collection<String> keys(String pattern)

获得缓存的基本对象列表

参数:

pattern - 字符串前缀

返回:

对象列表

setCacheData

public <T> org.springframework.data.redis.core.ValueOperations<String,T> setCacheData(String key,
                                                                                      T value,
                                                                                      long minutes)

缓存对象数据，指定时间（分钟）

参数:

key - 缓存的键

value - 缓存的值

minutes - 分钟

返回:

缓存的对象

resetCacheData

public <T> org.springframework.data.redis.core.ValueOperations<String,T> resetCacheData(String key,
                                                                                        T value,
                                                                                        long minutes)

缓存对象数据，指定时间

参数:

key - 缓存的键

value - 缓存的值

minutes - 分钟

返回:

缓存的对象

resetCacheData

public <T> org.springframework.data.redis.core.ValueOperations<String,T> resetCacheData(String key,
                                                                                        T value)

缓存对象数据，指定时间

参数:

key - 缓存的键

value - 缓存的值

minutes - 分钟

返回:

缓存的对象

hashKeys

public boolean hashKeys(String key)

判断key是否存在

参数:

key - redis键

返回:

存在返回true

deleteBySuffix

public void deleteBySuffix(String key)

模糊删除，*keys

参数:

key - redis键后缀

deleteByPrex

public void deleteByPrex(String key)

模糊删除，keys*

参数:

key - redis键前缀

keysPrex

public Set<String> keysPrex(String keyPrefix)

获取指定前缀的一系列key 使用scan命令代替keys, Redis是单线程处理，keys命令在KEY数量较多时， 操作效率极低【时间复杂度为O(N)】，该命令一旦执行会严重阻塞线上其它命令的正常请求

参数:

keyPrefix - redis键关键词

返回:

key集合

removeAll

public boolean removeAll(String keyPrefix)

删除指定前缀的一系列key

参数:

keyPrefix - redis键关键词

返回:

成功返回true

getExpire

public long getExpire(String key,
                      TimeUnit timeUnit)

获取剩余的过期时间（指定时间单位）

参数:

key - redis键

timeUnit - 时间单位

返回:

按照时间单位进行返回

getExpireMin

public long getExpireMin(String key)

获取剩余的过期时间(分钟)

参数:

key - redis键

返回:

返回以分钟为单位的时间

getExpireSeconds

public long getExpireSeconds(String key)

获取剩余的过期时间(秒)

参数:

key - redis键

返回:

返回以秒为单位的时间

expire

public Boolean expire(String key,
                      long timeout,
                      TimeUnit unit)

设置过期时间

参数:

key - redis键

timeout - 时间

unit - 时间单位

返回:

操作结果，成功返回true

expireAt

public Boolean expireAt(String key,
                        Date date)

设置过期时间

参数:

key - redis键

date - 时间对象

返回:

操作结果，成功返回true

setListString

public <T> Object setListString(String key,
                                List<T> list)

缓存List数据

参数:

key - 缓存的键

list - 待缓存的List数据

返回:

缓存的对象

getListString

public <T> List<T> getListString(String key,
                                 Class<T> clazz)

获得缓存的list对象

参数:

key - 缓存的键

clazz - 对象类型

返回:

缓存的键对应的数据

move

public Boolean move(String key,
                    int dbIndex)

将当前数据库的 key 移动到给定的数据库 db 当中

参数:

key - 缓存的键

dbIndex - 新的redis数据库编号

返回:

操作结果，成功返回true

persist

public Boolean persist(String key)

移除 key 的过期时间，key 将持久保持

参数:

key - 缓存的键

返回:

操作结果，成功返回true

randomKey

public String randomKey()

从当前数据库中随机返回一个 key

返回:

随机返回的key

rename

public void rename(String oldKey,
                   String newKey)

修改 key 的名称

参数:

oldKey - 旧的key

newKey - 新的key

renameIfAbsent

public Boolean renameIfAbsent(String oldKey,
                              String newKey)

仅当 newkey 不存在时，将 oldKey 改名为 newkey

参数:

oldKey - 旧的key

newKey - 新的key

返回:

操作结果,bool类型

type

public org.springframework.data.redis.connection.DataType type(String key)

返回 key 所储存的值的类型

参数:

key - 缓存的键

返回:

key对应值的类型

incrBy

public Long incrBy(String key,
                   long increment)

增加(自增长), 负数则为自减

参数:

key - 缓存的键

返回:

自增长后的值

sIntersect

public Set<String> sIntersect(String key,
                              String otherKey)

获取两个键值的交集

参数:

key - 缓存的键

otherKey - 缓存的另一个键

返回:

两个键值的交集

sIntersect

public Set<String> sIntersect(String key,
                              Collection<String> otherKeys)

获取key集合与多个集合的交集

参数:

key - 缓存的键

otherKeys - 缓存的另一些键的集合

返回:

key集合与多个集合的交集

sIntersectAndStore

public Long sIntersectAndStore(String key,
                               String otherKey,
                               String destKey)

key集合与otherKey集合的交集存储到destKey集合中

参数:

key - 健

otherKeys - 多个健集合

destKey - 新的健

返回:

操作结果

sIntersectAndStore

public Long sIntersectAndStore(String key,
                               Collection<String> otherKeys,
                               String destKey)

key集合与多个集合的交集存储到destKey集合中

参数:

key - 健

otherKeys - 多个健集合

destKey - 新的健

返回:

操作结果

sUnion

public Set<String> sUnion(String key,
                          String otherKeys)

获取两个集合的并集

参数:

key - 健

otherKeys - 多个健集合

返回:

操作结果

sUnion

public Set<String> sUnion(String key,
                          Collection<String> otherKeys)

获取key集合与多个集合的并集

参数:

key - 健

otherKeys - 多个健集合

返回:

操作结果

sUnionAndStore

public Long sUnionAndStore(String key,
                           String otherKey,
                           String destKey)

key集合与otherKey集合的并集存储到destKey中

参数:

key - 健

otherKeys - 多个健集合

destKey - 新的健

返回:

操作结果

sUnionAndStore

public Long sUnionAndStore(String key,
                           Collection<String> otherKeys,
                           String destKey)

key集合与多个集合的并集存储到destKey中

参数:

key - 健

otherKeys - 多个健集合

destKey - 新的健

返回:

操作结果

sDifference

public Set<String> sDifference(String key,
                               String otherKey)

获取两个集合的差集

参数:

key - 健

otherKeys - 多个健集合

返回:

操作结果

sDifference

public Set<String> sDifference(String key,
                               Collection<String> otherKeys)

获取key集合与多个集合的差集

参数:

key - 健

otherKeys - 多个健集合

返回:

操作结果

sDifference

public Long sDifference(String key,
                        String otherKey,
                        String destKey)

key集合与otherKey集合的差集存储到destKey中

参数:

key - 健

otherKeys - 多个健集合

destKey - 新的健

返回:

操作结果

sDifference

public Long sDifference(String key,
                        Collection<String> otherKeys,
                        String destKey)

key与多个key的差集存储到destKey中

参数:

key - 健

otherKeys - 多个健集合

destKey - 新的健

返回:

操作结果

zAdd

public Boolean zAdd(String key,
                    String value,
                    double score)

添加元素,有序集合是按照元素的score值由小到大排列

参数:

key - 健

value - 值

score - score值

返回:

操作结果

zIncrementScore

public Double zIncrementScore(String key,
                              String value,
                              double delta)

增加元素的score值，并返回增加后的值

参数:

key - 健

value - 值

delta - delta值

返回:

增加后的值

zRank

public Long zRank(String key,
                  Object value)

返回元素在集合的排名,有序集合是按照元素的score值由小到大排列

参数:

key - 健

value - 值

返回:

0表示第一位

zReverseRank

public Long zReverseRank(String key,
                         Object value)

返回元素在集合的排名,按元素的score值由大到小排列

参数:

key - 健

value - 值

返回:

排名

zRange

public Set<String> zRange(String key,
                          long start,
                          long end)

获取集合的元素, 从小到大排序

参数:

key - 健

start - 开始位置

end - 结束位置, -1查询所有

返回:

集合的元素