程序包 com.sie.mbm.mom.framework.cache.execute

类 RedisHelper

java.lang.Object

com.sie.mbm.mom.framework.cache.execute.RedisHelper

所有已实现的接口:

ICacheHelper

public class RedisHelper
extends Object
implements ICacheHelper

RedisHelper类

字段概要

字段

修饰符和类型	字段	说明
private String	keyPreFix
private final org.springframework.data.redis.core.RedisTemplate<String,Object>	redisTemplate	注入RedisTemplate实例

构造器概要

构造器

构造器	说明
RedisHelper()

方法概要

修饰符和类型	方法	说明
void	allDel(String keyPrefix)	删除所有符合给定前缀的键
void	convertAndSend(String channel, Object message)	发送消息
Long	decrement(String key, Long delta)	对键对应的值进行减量操作
Long	decrementHash(String name, String key, Long delta)	对哈希表中的字段进行减量操作
Boolean	del(String key)	删除给定键
Long	execLuaScript(String script, String key, Object value)	执行Lua脚本
void	expire(String key, Long timeout)	设置键的过期时间
Object	get(String key)	获取给定键的值
<T> T	get(String key, Class<T> clazz)	获取给定键的值，并转换为指定类型
Object	get(String key, Function<String,Object> mappingFunction, Long timeout)	获取给定键的值，如果值为空，则使用映射函数进行计算并设置
<T> T	get(String key, Function<String,T> mappingFunction, Class<T> clazz)	获取给定键的值并转换为指定类型，如果值为空，则使用映射函数进行计算并设置
<T> T	get(String key, Function<String,T> mappingFunction, Class<T> clazz, Long timeout)	从Redis中获取缓存值，如果不存在则通过映射函数获取并设置到Redis中
Object	getHashValue(String name, String key)	获取哈希表中的字段值
private String	getRedisKey(String key)	获取Redis键
org.springframework.data.redis.core.Cursor<String>	getScan(org.springframework.data.redis.core.ScanOptions options)	查询所有key
void	hdel(String key, Object... fields)	删除哈希表中的字段
Object	hget(String key, String field)	获取哈希表中的字段值
Map<Object,Object>	hgetall(String key)	获取哈希表中的所有字段和值
List<Object>	hgetvalues(String key)	获取哈希表中的所有字段值
void	hset(String key, String field, Object value)	设置哈希表中的字段值
Long	increment(String key, Long delta)	对键对应的值进行增量操作
Long	incrementHash(String name, String key, Long delta)	对哈希表中的字段进行增量操作
Boolean	keyIsExist(String key)	判断key是否存在
Set<String>	keys(String pattern)	查找符合给定模式的键
Object	lpop(String key)	从列表的左侧弹出元素
Long	lpush(String key, Object value)	在列表的左侧添加元素
List<Object>	mget(List<String> keys)	批量获取值
void	multiSetWithExpire(Map<String,Object> redisMap, long timeout, TimeUnit timeUnit)	批量写入 key-value 并设置统一过期时间
Long	rpush(String key, Object value)	在列表的右侧添加元素
Long	sadd(String key, Object... values)	向集合中添加一个或多个成员
Long	scard(String key)	获取集合中的成员数量
Set<Object>	sdiff(String... keys)	获取多个集合的差集（第一个集合相对于其他集合的差集）
Set<Object>	sdiff(String key, String otherKey)	获取两个集合的差集（第一个集合相对于第二个集合的差集）
void	set(String key, Object value)	设置键值对
void	set(String key, Object value, Long timeout)	设置键值对，并设置过期时间
void	setHashValue(String name, String key, Object value)	设置哈希表中的字段值
Boolean	setnx(String key, Object value)	设置键值对，仅当键不存在时
Boolean	setnx(String key, Object value, Integer seconds)	设置键值对，仅当键不存在时，并指定过期时间
void	setnx60s(String key, Object value)	设置键值对，仅当键不存在时
Set<Object>	sinter(String... keys)	获取多个集合的交集
Set<Object>	sinter(String key, String otherKey)	获取两个集合的交集
Boolean	sismember(String key, Object value)	检查成员是否是集合的成员
Set<Object>	smembers(String key)	获取集合中的所有成员
Object	spop(String key)	移除并返回集合中的一个随机成员
Set<Object>	srandmember(String key, long count)	从集合中随机获取一个或多个成员（不移除）
Long	srem(String key, Object... values)	从集合中移除一个或多个成员
Set<Object>	sunion(String... keys)	获取多个集合的并集
Set<Object>	sunion(String key, String otherKey)	获取两个集合的并集
void	trimList(String key, long start, long end)	截取 list at key to elements between start and end.

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

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

字段详细资料

keyPreFix

@Value("${spring.redis.key-pre-fix:none}")
private String keyPreFix

redisTemplate

private final org.springframework.data.redis.core.RedisTemplate<String,Object> redisTemplate

注入RedisTemplate实例

构造器详细资料

RedisHelper

public RedisHelper()

方法详细资料

getRedisKey

private String getRedisKey(String key)

获取Redis键

参数:

key -

返回:

keyIsExist

public Boolean keyIsExist(String key)

判断key是否存在

指定者:

keyIsExist 在接口中 ICacheHelper

参数:

key -

返回:

expire

public void expire(String key,
 Long timeout)

设置键的过期时间

指定者:

expire 在接口中 ICacheHelper

参数:

key - Redis键

timeout - 过期时间，以秒为单位

increment

public Long increment(String key,
 Long delta)

对键对应的值进行增量操作

指定者:

increment 在接口中 ICacheHelper

参数:

key - Redis键

delta - 增量值

返回:

增量操作后的值

decrement

public Long decrement(String key,
 Long delta)

对键对应的值进行减量操作

指定者:

decrement 在接口中 ICacheHelper

参数:

key - Redis键

delta - 减量值

返回:

减量操作后的值

incrementHash

public Long incrementHash(String name,
 String key,
 Long delta)

对哈希表中的字段进行增量操作

指定者:

incrementHash 在接口中 ICacheHelper

参数:

name - 哈希表名

key - 字段键

delta - 增量值

返回:

增量操作后的值

decrementHash

public Long decrementHash(String name,
 String key,
 Long delta)

对哈希表中的字段进行减量操作

指定者:

decrementHash 在接口中 ICacheHelper

参数:

name - 哈希表名

key - 字段键

delta - 减量值

返回:

减量操作后的值

setHashValue

public void setHashValue(String name,
 String key,
 Object value)

设置哈希表中的字段值

指定者:

setHashValue 在接口中 ICacheHelper

参数:

name - 哈希表名

key - 字段键

value - 字段值

getHashValue

public Object getHashValue(String name,
 String key)

获取哈希表中的字段值

指定者:

getHashValue 在接口中 ICacheHelper

参数:

name - 哈希表名

key - 字段键

返回:

字段值

keys

public Set<String> keys(String pattern)

查找符合给定模式的键

指定者:

keys 在接口中 ICacheHelper

参数:

pattern - 键名模式

返回:

符合模式的键集合

del

public Boolean del(String key)

删除给定键

指定者:

del 在接口中 ICacheHelper

参数:

key - Redis键

返回:

删除操作是否成功

allDel

public void allDel(String keyPrefix)

删除所有符合给定前缀的键

指定者:

allDel 在接口中 ICacheHelper

参数:

keyPrefix - 键名前缀

set

public void set(String key,
 Object value)

设置键值对

指定者:

set 在接口中 ICacheHelper

参数:

key - Redis键

value - 值

set

public void set(String key,
 Object value,
 Long timeout)

设置键值对，并设置过期时间

指定者:

set 在接口中 ICacheHelper

参数:

key - Redis键

value - 值

timeout - 过期时间，以秒为单位

setnx60s

public void setnx60s(String key,
 Object value)

设置键值对，仅当键不存在时

指定者:

setnx60s 在接口中 ICacheHelper

参数:

key - Redis键

value - 值

setnx

public Boolean setnx(String key,
 Object value)

设置键值对，仅当键不存在时

指定者:

setnx 在接口中 ICacheHelper

参数:

key - Redis键

value - 值

返回:

设置操作是否成功

setnx

public Boolean setnx(String key,
 Object value,
 Integer seconds)

设置键值对，仅当键不存在时，并指定过期时间

指定者:

setnx 在接口中 ICacheHelper

参数:

key - Redis键

value - 值

seconds - 过期时间，以秒为单位

返回:

设置操作是否成功

get

public Object get(String key)

获取给定键的值

指定者:

get 在接口中 ICacheHelper

参数:

key - Redis键

返回:

值

get

public <T> T get(String key,
 Class<T> clazz)

获取给定键的值，并转换为指定类型

指定者:

get 在接口中 ICacheHelper

类型参数:

T - 泛型标记

参数:

key - Redis键

clazz - 值的类类型

返回:

转换后的值

get

public Object get(String key,
 Function<String,Object> mappingFunction,
 Long timeout)

获取给定键的值，如果值为空，则使用映射函数进行计算并设置

指定者:

get 在接口中 ICacheHelper

参数:

key - Redis键

mappingFunction - 映射函数

返回:

值

get

public <T> T get(String key,
 Function<String,T> mappingFunction,
 Class<T> clazz)

获取给定键的值并转换为指定类型，如果值为空，则使用映射函数进行计算并设置

指定者:

get 在接口中 ICacheHelper

类型参数:

T - 泛型标记

参数:

key - Redis键

mappingFunction - 映射函数

clazz - 值的类类型

返回:

转换后的值

get

public <T> T get(String key,
 Function<String,T> mappingFunction,
 Class<T> clazz,
 Long timeout)

从Redis中获取缓存值，如果不存在则通过映射函数获取并设置到Redis中

指定者:

get 在接口中 ICacheHelper

类型参数:

T - 泛型参数，表示返回值的类型

参数:

key - 缓存的键

mappingFunction - 用于获取实际值的映射函数

clazz - 期望获取的值的类型

timeout - 缓存的过期时间（秒）为null表示不设置过期时间

返回:

返回缓存的值，如果Redis中没有则通过映射函数获取并设置到Redis中

mget

public List<Object> mget(List<String> keys)

批量获取值

指定者:

mget 在接口中 ICacheHelper

参数:

keys - Redis键集合

返回:

值的列表

hset

public void hset(String key,
 String field,
 Object value)

设置哈希表中的字段值

指定者:

hset 在接口中 ICacheHelper

参数:

key - 哈希表名

field - 字段键

value - 字段值

hget

public Object hget(String key,
 String field)

获取哈希表中的字段值

指定者:

hget 在接口中 ICacheHelper

参数:

key - 哈希表名

field - 字段键

返回:

字段值

hdel

public void hdel(String key,
 Object... fields)

删除哈希表中的字段

指定者:

hdel 在接口中 ICacheHelper

参数:

key - 哈希表名

fields - 字段键集合

hgetall

public Map<Object,Object> hgetall(String key)

获取哈希表中的所有字段和值

指定者:

hgetall 在接口中 ICacheHelper

参数:

key - 哈希表名

返回:

字段和值的映射

hgetvalues

public List<Object> hgetvalues(String key)

获取哈希表中的所有字段值

指定者:

hgetvalues 在接口中 ICacheHelper

参数:

key - 哈希表名

返回:

字段值列表

lpush

public Long lpush(String key,
 Object value)

在列表的左侧添加元素

指定者:

lpush 在接口中 ICacheHelper

参数:

key - 列表名

value - 元素值

返回:

列表长度

lpop

public Object lpop(String key)

从列表的左侧弹出元素

指定者:

lpop 在接口中 ICacheHelper

参数:

key - 列表名

返回:

弹出的元素

rpush

public Long rpush(String key,
 Object value)

在列表的右侧添加元素

指定者:

rpush 在接口中 ICacheHelper

参数:

key - 列表名

value - 元素值

返回:

列表长度

execLuaScript

public Long execLuaScript(String script,
 String key,
 Object value)

执行Lua脚本

指定者:

execLuaScript 在接口中 ICacheHelper

参数:

script - Lua脚本内容

key - Redis键

value - 值

返回:

脚本执行结果

trimList

public void trimList(String key,
 long start,
 long end)

截取 list at key to elements between start and end.

指定者:

trimList 在接口中 ICacheHelper

参数:

key - must not be null.

start -

end -

另请参阅:

• Redis Documentation: LTRIM

getScan

public org.springframework.data.redis.core.Cursor<String> getScan(org.springframework.data.redis.core.ScanOptions options)

查询所有key

指定者:

getScan 在接口中 ICacheHelper

参数:

options - Redis键

返回:

查询所有key

multiSetWithExpire

public void multiSetWithExpire(Map<String,Object> redisMap,
 long timeout,
 TimeUnit timeUnit)

批量写入 key-value 并设置统一过期时间

指定者:

multiSetWithExpire 在接口中 ICacheHelper

参数:

redisMap - key-value 映射，value 可以是任意对象

timeout - 过期时间

timeUnit - 时间单位

convertAndSend

public void convertAndSend(String channel,
 Object message)

从接口复制的说明: ICacheHelper

发送消息

指定者:

convertAndSend 在接口中 ICacheHelper

参数:

channel - Redis键

message - 值

sadd

public Long sadd(String key,
 Object... values)

向集合中添加一个或多个成员

指定者:

sadd 在接口中 ICacheHelper

参数:

key - 集合键名

values - 要添加的成员

返回:

添加到集合中的新成员数量

smembers

public Set<Object> smembers(String key)

获取集合中的所有成员

指定者:

smembers 在接口中 ICacheHelper

参数:

key - 集合键名

返回:

集合中的所有成员

sismember

public Boolean sismember(String key,
 Object value)

检查成员是否是集合的成员

指定者:

sismember 在接口中 ICacheHelper

参数:

key - 集合键名

value - 要检查的成员

返回:

如果成员存在返回true，否则返回false

scard

public Long scard(String key)

获取集合中的成员数量

指定者:

scard 在接口中 ICacheHelper

参数:

key - 集合键名

返回:

集合中的成员数量

spop

public Object spop(String key)

移除并返回集合中的一个随机成员

指定者:

spop 在接口中 ICacheHelper

参数:

key - 集合键名

返回:

被移除的随机成员

srandmember

public Set<Object> srandmember(String key,
 long count)

从集合中随机获取一个或多个成员（不移除）

指定者:

srandmember 在接口中 ICacheHelper

参数:

key - 集合键名

count - 要获取的成员数量

返回:

随机成员集合

srem

public Long srem(String key,
 Object... values)

从集合中移除一个或多个成员

指定者:

srem 在接口中 ICacheHelper

参数:

key - 集合键名

values - 要移除的成员

返回:

被成功移除的成员数量

sinter

public Set<Object> sinter(String key,
 String otherKey)

获取两个集合的交集

指定者:

sinter 在接口中 ICacheHelper

参数:

key - 第一个集合键名

otherKey - 第二个集合键名

返回:

交集成员集合

sinter

public Set<Object> sinter(String... keys)

获取多个集合的交集

指定者:

sinter 在接口中 ICacheHelper

参数:

keys - 集合键名列表

返回:

交集成员集合

sunion

public Set<Object> sunion(String key,
 String otherKey)

获取两个集合的并集

指定者:

sunion 在接口中 ICacheHelper

参数:

key - 第一个集合键名

otherKey - 第二个集合键名

返回:

并集成员集合

sunion

public Set<Object> sunion(String... keys)

获取多个集合的并集

指定者:

sunion 在接口中 ICacheHelper

参数:

keys - 集合键名列表

返回:

并集成员集合

sdiff

public Set<Object> sdiff(String key,
 String otherKey)

获取两个集合的差集（第一个集合相对于第二个集合的差集）

指定者:

sdiff 在接口中 ICacheHelper

参数:

key - 第一个集合键名

otherKey - 第二个集合键名

返回:

差集成员集合

sdiff

public Set<Object> sdiff(String... keys)

获取多个集合的差集（第一个集合相对于其他集合的差集）

指定者:

sdiff 在接口中 ICacheHelper

参数:

keys - 集合键名列表

返回:

差集成员集合