top.tangyh.basic.cache.repository.impl

类 RedisOpsImpl

java.lang.Object

top.tangyh.basic.cache.repository.impl.RedisOpsImpl

所有已实现的接口:

CacheOps, CachePlusOps

public class RedisOpsImpl
extends Object
implements CacheOps, CachePlusOps

Redis Repository redis 基本操作 可扩展,基本够用了

作者:

zuihou

构造器概要

构造器

构造器和说明
RedisOpsImpl(RedisOps redisOps)

方法概要

限定符和类型	方法和说明
Long	decr(CacheKey key) 为键 key 储存的数字值减去一。
Long	decrBy(CacheKey key, long decrement) 将 key 所储存的值减去减量 decrement 。
Long	del(CacheKey... keys) 删除指定的key
Long	del(String... keys) 删除指定的key
Boolean	exists(CacheKey key) 判断指定的key 是否存在
Boolean	expire(CacheKey key) 为给定 key 设置生存时间，当 key 过期时(生存时间为 0 )，它会被自动删除。
<T> List<T>	find(Collection<CacheKey> keys) 根据keys获取对象
void	flushDb() 清空redis存储的数据
<T> T	get(CacheKey key, boolean... cacheNullValues) 根据key获取对象
<T> T	get(CacheKey key, Function<CacheKey,? extends T> loader, boolean... cacheNullValues) 根据key获取对象 不存在时，调用function回调获取数据，并set进入，然后返回
<T> T	get(String key, boolean... cacheNullValues) 根据key获取对象
Long	getCounter(CacheKey key, Function<CacheKey,Long> loader) 获取key中存放的Long值
org.springframework.data.redis.core.RedisTemplate<String,Object>	getRedisTemplate() 获取 RedisTemplate对象
Long	hDel(CacheHashKey cacheHashKey) 删除哈希表 key 中的指定域，不存在的域将被忽略。
Long	hDel(String key, Object... fields) 删除哈希表 key 中的一个或多个指定域，不存在的域将被忽略。
Boolean	hExists(CacheHashKey cacheHashKey) 检查给定域 field 是否存在于哈希表 hash 当中
<T> T	hGet(CacheHashKey key, boolean... cacheNullValues) 返回哈希表 key 中给定域 field 的值。
<T> T	hGet(CacheHashKey key, Function<CacheHashKey,T> loader, boolean... cacheNullValues) 返回哈希表 key 中给定域 field 的值。
<K,V> Map<K,V>	hGetAll(CacheHashKey key) 返回哈希表 key 中，所有的域和值。
<K,V> Map<K,V>	hGetAll(CacheHashKey key, Function<CacheHashKey,Map<K,V>> loader, boolean... cacheNullValues) 返回哈希表 key 中，所有的域和值。
Double	hIncrBy(CacheHashKey key, double increment) 为哈希表 key 中的域 field 的值加上增量 increment 。
Long	hIncrBy(CacheHashKey key, long increment) 为哈希表 key 中的域 field 的值加上增量 increment 。
Set<Object>	hKeys(CacheHashKey key) 返回哈希表 key 中的所有域。
Long	hLen(CacheHashKey key) 返回哈希表 key 中域的数量。
void	hSet(CacheHashKey key, Object value, boolean... cacheNullValues) 将哈希表 key 中的域 field 的值设为 value 。
List<Object>	hVals(CacheHashKey key) 返回哈希表 key 中所有域的值。
Long	incr(CacheKey key) 为键 key 储存的数字值加上一。
Long	incrBy(CacheKey key, long increment) 为键 key 储存的数字值加上increment。
Double	incrByFloat(CacheKey key, double increment) 为键 key 储存的数字值加上一。
Set<String>	keys(String pattern) 查找所有符合给定模式 pattern 的 key 。
Boolean	persist(CacheKey key) 移除给定 key 的生存时间，将这个 key 从『易失的』(带生存时间 key )转换成『持久的』(一个不带生存时间、永不过期的 key )。
Long	pTtl(CacheKey key) 以毫秒为单位，返回给定 key 的剩余生存时间(TTL, time to live)。
Long	sAdd(CacheKey key, Object value) 将一个或多个 member 元素加入到集合 key 当中，已经存在于集合的 member 元素将被忽略。
List<String>	scan(String pattern) 查找所有符合给定模式 pattern 的 key 。
void	scanUnlink(String pattern) 查找所有符合给定模式 pattern 的 key ,并将其删除 例子： KEYS * 匹配数据库中所有 key 。
Long	sCard(CacheKey key) 返回集合 key 的基数(集合中元素的数量)。
void	set(CacheKey key, Object value, boolean... cacheNullValues) 添加到带有 过期时间的 缓存
Set<Object>	sMembers(CacheKey key) 返回集合 key 中的所有成员。
<T> T	sPop(CacheKey key) 移除并返回集合中的一个随机元素。
Long	sRem(CacheKey key, Object... members) 移除集合 key 中的一个或多个 member 元素，不存在的 member 元素会被忽略。
Long	ttl(CacheKey key) 以秒为单位，返回给定 key 的剩余生存时间(TTL, time to live)。
String	type(CacheKey key) 返回 key 所储存的值的类型。

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

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

构造器详细资料

RedisOpsImpl

public RedisOpsImpl(RedisOps redisOps)

方法详细资料

getRedisTemplate

public org.springframework.data.redis.core.RedisTemplate<String,Object> getRedisTemplate()

获取 RedisTemplate对象

del

public Long del(@NonNull
                CacheKey... keys)

从接口复制的说明: CacheOps

删除指定的key

指定者:

del 在接口中 CacheOps

参数:

keys - 多个key

返回:

删除个数

del

public Long del(String... keys)

从接口复制的说明: CacheOps

删除指定的key

指定者:

del 在接口中 CacheOps

参数:

keys - 多个key

返回:

删除个数

exists

public Boolean exists(@NonNull
                      CacheKey key)

从接口复制的说明: CacheOps

判断指定的key 是否存在

指定者:

exists 在接口中 CacheOps

参数:

key - key

返回:

是否存在

set

public void set(@NonNull
                CacheKey key,
                Object value,
                boolean... cacheNullValues)

从接口复制的说明: CacheOps

添加到带有 过期时间的 缓存

指定者:

set 在接口中 CacheOps

参数:

key - redis主键

value - 值

cacheNullValues - 是否缓存null对象

get

public <T> T get(@NonNull
                 CacheKey key,
                 boolean... cacheNullValues)

从接口复制的说明: CacheOps

根据key获取对象

指定者:

get 在接口中 CacheOps

参数:

key - redis主键

cacheNullValues - 是否缓存null对象

返回:

值 不存在时，返回null

get

public <T> T get(String key,
                 boolean... cacheNullValues)

从接口复制的说明: CacheOps

根据key获取对象

指定者:

get 在接口中 CacheOps

参数:

key - redis主键

cacheNullValues - 是否缓存null对象

返回:

值 不存在时，返回null

find

public <T> List<T> find(@NonNull
                        Collection<CacheKey> keys)

从接口复制的说明: CacheOps

根据keys获取对象

指定者:

find 在接口中 CacheOps

参数:

keys - redis主键

返回:

值 不存在时，返回空集合

get

public <T> T get(@NonNull
                 CacheKey key,
                 Function<CacheKey,? extends T> loader,
                 boolean... cacheNullValues)

从接口复制的说明: CacheOps

根据key获取对象 不存在时，调用function回调获取数据，并set进入，然后返回

指定者:

get 在接口中 CacheOps

参数:

key - redis主键

loader - 加载器

cacheNullValues - 是否缓存null对象

返回:

值

flushDb

public void flushDb()

清空redis存储的数据

指定者:

flushDb 在接口中 CacheOps

incr

public Long incr(@NonNull
                 CacheKey key)

从接口复制的说明: CacheOps

为键 key 储存的数字值加上一。

指定者:

incr 在接口中 CacheOps

参数:

key - 一定不能为 null.

返回:

返回键 key 在执行加一操作之后的值。

getCounter

public Long getCounter(CacheKey key,
                       Function<CacheKey,Long> loader)

从接口复制的说明: CacheOps

获取key中存放的Long值

指定者:

getCounter 在接口中 CacheOps

参数:

key - 一定不能为 null.

loader - 加载

返回:

key中存储的的数字

incrBy

public Long incrBy(@NonNull
                   CacheKey key,
                   long increment)

从接口复制的说明: CacheOps

为键 key 储存的数字值加上increment。

指定者:

incrBy 在接口中 CacheOps

参数:

key - 一定不能为 null.

increment - 增量值

返回:

返回键 key 在执行加一操作之后的值。

incrByFloat

public Double incrByFloat(@NonNull
                          CacheKey key,
                          double increment)

从接口复制的说明: CacheOps

为键 key 储存的数字值加上一。

指定者:

incrByFloat 在接口中 CacheOps

参数:

key - 一定不能为 null.

increment - 增量值

返回:

返回键 key 在执行加一操作之后的值。

decr

public Long decr(@NonNull
                 CacheKey key)

从接口复制的说明: CacheOps

为键 key 储存的数字值减去一。

指定者:

decr 在接口中 CacheOps

参数:

key - 一定不能为 null.

返回:

在减去增量 1 之后， 键 key 的值。

decrBy

public Long decrBy(@NonNull
                   CacheKey key,
                   long decrement)

从接口复制的说明: CacheOps

将 key 所储存的值减去减量 decrement 。

指定者:

decrBy 在接口中 CacheOps

参数:

key - 一定不能为 null.

decrement - 增量值

返回:

在减去增量 decrement 之后， 键 key 的值。

keys

public Set<String> keys(@NonNull
                        String pattern)

从接口复制的说明: CachePlusOps

查找所有符合给定模式 pattern 的 key 。

例子： KEYS * 匹配数据库中所有 key 。 KEYS h?llo 匹配 hello ， hallo 和 hxllo 等。 KEYS a*cde 匹配 acde 和 aeeeeecde 等。 KEYS h[ae]llo 匹配 hello 和 hallo ，但不匹配 hillo 。

特殊符号用 \ 隔开

指定者:

keys 在接口中 CachePlusOps

参数:

pattern - 表达式

返回:

符合给定模式的 key 列表

scan

public List<String> scan(String pattern)

从接口复制的说明: CachePlusOps

查找所有符合给定模式 pattern 的 key 。

例子： KEYS * 匹配数据库中所有 key 。 KEYS h?llo 匹配 hello ， hallo 和 hxllo 等。 KEYS a*cde 匹配 acde 和 aeeeeecde 等。 KEYS h[ae]llo 匹配 hello 和 hallo ，但不匹配 hillo 。

特殊符号用 \ 隔开

指定者:

scan 在接口中 CachePlusOps

参数:

pattern - 表达式

返回:

符合给定模式的 key 列表

scanUnlink

public void scanUnlink(String pattern)

从接口复制的说明: CachePlusOps

查找所有符合给定模式 pattern 的 key ,并将其删除

例子： KEYS * 匹配数据库中所有 key 。 KEYS h?llo 匹配 hello ， hallo 和 hxllo 等。 KEYS a*cde 匹配 acde 和 aeeeeecde 等。 KEYS h[ae]llo 匹配 hello 和 hallo ，但不匹配 hillo 。

特殊符号用 \ 隔开

指定者:

scanUnlink 在接口中 CachePlusOps

参数:

pattern - 表达式

expire

public Boolean expire(@NonNull
                      CacheKey key)

从接口复制的说明: CachePlusOps

为给定 key 设置生存时间，当 key 过期时(生存时间为 0 )，它会被自动删除。

指定者:

expire 在接口中 CachePlusOps

参数:

key - 一定不能为 null.

返回:

是否成功

persist

public Boolean persist(@NonNull
                       CacheKey key)

从接口复制的说明: CachePlusOps

移除给定 key 的生存时间，将这个 key 从『易失的』(带生存时间 key )转换成『持久的』(一个不带生存时间、永不过期的 key )。

指定者:

persist 在接口中 CachePlusOps

参数:

key - 一定不能为 null.

返回:

是否成功

type

public String type(@NonNull
                   CacheKey key)

从接口复制的说明: CachePlusOps

返回 key 所储存的值的类型。

指定者:

type 在接口中 CachePlusOps

参数:

key - 一定不能为 null.

返回:

none (key不存在)、string (字符串)、list (列表)、set (集合)、zset (有序集)、hash (哈希表) 、stream （流）、caffeine（内存）

ttl

public Long ttl(@NonNull
                CacheKey key)

从接口复制的说明: CachePlusOps

以秒为单位，返回给定 key 的剩余生存时间(TTL, time to live)。

指定者:

ttl 在接口中 CachePlusOps

参数:

key - 一定不能为 null.

返回:

当 key 不存在时，返回 -2 。 当 key 存在但没有设置剩余生存时间时，返回 -1 。 否则，以秒为单位，返回 key 的剩余生存时间。

pTtl

public Long pTtl(@NonNull
                 CacheKey key)

从接口复制的说明: CachePlusOps

以毫秒为单位，返回给定 key 的剩余生存时间(TTL, time to live)。

指定者:

pTtl 在接口中 CachePlusOps

参数:

key - 一定不能为 null.

返回:

当 key 不存在时，返回 -2 。当 key 存在但没有设置剩余生存时间时，返回 -1 。否则，以毫秒为单位，返回 key 的剩余生存时间

hSet

public void hSet(@NonNull
                 CacheHashKey key,
                 Object value,
                 boolean... cacheNullValues)

从接口复制的说明: CachePlusOps

将哈希表 key 中的域 field 的值设为 value 。

指定者:

hSet 在接口中 CachePlusOps

参数:

key - 一定不能为 null.

value - 值

cacheNullValues - 是否缓存空对象

hGet

public <T> T hGet(@NonNull
                  CacheHashKey key,
                  boolean... cacheNullValues)

从接口复制的说明: CachePlusOps

返回哈希表 key 中给定域 field 的值。

指定者:

hGet 在接口中 CachePlusOps

参数:

key - 一定不能为 null.

cacheNullValues - 是否缓存空值

返回:

默认情况下返回给定域的值, 如果给定域不存在于哈希表中， 又或者给定的哈希表并不存在， 那么命令返回 nil

hGet

public <T> T hGet(@NonNull
                  CacheHashKey key,
                  Function<CacheHashKey,T> loader,
                  boolean... cacheNullValues)

从接口复制的说明: CachePlusOps

返回哈希表 key 中给定域 field 的值。

指定者:

hGet 在接口中 CachePlusOps

参数:

key - 一定不能为 null.

loader - 加载器

cacheNullValues - 是否缓存空值

返回:

默认情况下返回给定域的值, 如果给定域不存在于哈希表中， 又或者给定的哈希表并不存在， 那么命令返回 nil

hExists

public Boolean hExists(@NonNull
                       CacheHashKey cacheHashKey)

从接口复制的说明: CachePlusOps

检查给定域 field 是否存在于哈希表 hash 当中

指定者:

hExists 在接口中 CachePlusOps

参数:

cacheHashKey - 一定不能为 null.

返回:

是否存在

hDel

public Long hDel(@NonNull
                 String key,
                 Object... fields)

从接口复制的说明: CachePlusOps

删除哈希表 key 中的一个或多个指定域，不存在的域将被忽略。

指定者:

hDel 在接口中 CachePlusOps

参数:

key - 一定不能为 null.

fields - 一定不能为 null.

返回:

删除的数量

hDel

public Long hDel(@NonNull
                 CacheHashKey cacheHashKey)

从接口复制的说明: CachePlusOps

删除哈希表 key 中的指定域，不存在的域将被忽略。

指定者:

hDel 在接口中 CachePlusOps

参数:

cacheHashKey - 一定不能为 null.

返回:

删除的数量

hLen

public Long hLen(@NonNull
                 CacheHashKey key)

从接口复制的说明: CachePlusOps

返回哈希表 key 中域的数量。

指定者:

hLen 在接口中 CachePlusOps

参数:

key - 一定不能为 null.

返回:

哈希表中域的数量。

hIncrBy

public Long hIncrBy(@NonNull
                    CacheHashKey key,
                    long increment)

从接口复制的说明: CachePlusOps

为哈希表 key 中的域 field 的值加上增量 increment 。

指定者:

hIncrBy 在接口中 CachePlusOps

参数:

key - 一定不能为 null.

increment - 增量

返回:

执行 HINCRBY 命令之后，哈希表 key 中域 field 的值

hIncrBy

public Double hIncrBy(@NonNull
                      CacheHashKey key,
                      double increment)

从接口复制的说明: CachePlusOps

为哈希表 key 中的域 field 的值加上增量 increment 。

指定者:

hIncrBy 在接口中 CachePlusOps

参数:

key - 一定不能为 null.

increment - 增量

返回:

执行 HINCRBY 命令之后，哈希表 key 中域 field 的值

hKeys

public Set<Object> hKeys(@NonNull
                         CacheHashKey key)

从接口复制的说明: CachePlusOps

返回哈希表 key 中的所有域。

指定者:

hKeys 在接口中 CachePlusOps

参数:

key - 一定不能为 null.

返回:

所有的 filed

hVals

public List<Object> hVals(@NonNull
                          CacheHashKey key)

从接口复制的说明: CachePlusOps

返回哈希表 key 中所有域的值。

指定者:

hVals 在接口中 CachePlusOps

参数:

key - 一定不能为 null.

返回:

一个包含哈希表中所有值的表。

hGetAll

public <K,V> Map<K,V> hGetAll(@NonNull
                              CacheHashKey key)

从接口复制的说明: CachePlusOps

返回哈希表 key 中，所有的域和值。 在返回值里，紧跟每个域名(field name)之后是域的值(value)，所以返回值的长度是哈希表大小的两倍。

指定者:

hGetAll 在接口中 CachePlusOps

参数:

key - 一定不能为 null.

返回:

以列表形式返回哈希表的域和域的值

hGetAll

public <K,V> Map<K,V> hGetAll(@NonNull
                              CacheHashKey key,
                              Function<CacheHashKey,Map<K,V>> loader,
                              boolean... cacheNullValues)

从接口复制的说明: CachePlusOps

返回哈希表 key 中，所有的域和值。 在返回值里，紧跟每个域名(field name)之后是域的值(value)，所以返回值的长度是哈希表大小的两倍。

指定者:

hGetAll 在接口中 CachePlusOps

参数:

key - 一定不能为 null.

loader - 加载回调

cacheNullValues - 缓存空值

返回:

以列表形式返回哈希表的域和域的值

sAdd

public Long sAdd(@NonNull
                 CacheKey key,
                 Object value)

从接口复制的说明: CachePlusOps

将一个或多个 member 元素加入到集合 key 当中，已经存在于集合的 member 元素将被忽略。 假如 key 不存在，则创建一个只包含 member 元素作成员的集合。 当 key 不是集合类型时，返回一个错误。

指定者:

sAdd 在接口中 CachePlusOps

参数:

key - 一定不能为 null.

value - 值

返回:

被添加到集合中的新元素的数量，不包括被忽略的元素。

sRem

public Long sRem(@NonNull
                 CacheKey key,
                 Object... members)

从接口复制的说明: CachePlusOps

移除集合 key 中的一个或多个 member 元素，不存在的 member 元素会被忽略。 当 key 不是集合类型，返回一个错误。

指定者:

sRem 在接口中 CachePlusOps

参数:

key - 一定不能为 null.

members - 元素

返回:

被成功移除的元素的数量，不包括被忽略的元素

sMembers

public Set<Object> sMembers(@NonNull
                            CacheKey key)

从接口复制的说明: CachePlusOps

返回集合 key 中的所有成员。 不存在的 key 被视为空集合。

指定者:

sMembers 在接口中 CachePlusOps

参数:

key - 一定不能为 null.

返回:

集合中的所有成员。

sPop

public <T> T sPop(@NonNull
                  CacheKey key)

从接口复制的说明: CachePlusOps

移除并返回集合中的一个随机元素。 如果只想获取一个随机元素，但不想该元素从集合中被移除的话，可以使用 SRANDMEMBER 命令。

指定者:

sPop 在接口中 CachePlusOps

参数:

key - 一定不能为 null.

返回:

被移除的随机元素。 当 key 不存在或 key 是空集时，返回 nil 。

sCard

public Long sCard(@NonNull
                  CacheKey key)

从接口复制的说明: CachePlusOps

返回集合 key 的基数(集合中元素的数量)。

指定者:

sCard 在接口中 CachePlusOps

参数:

key - 一定不能为 null.

返回:

集合的基数。 当 key 不存在时，返回 0 。