cn.stylefeng.roses.kernel.cache.api

接口 CacheOperatorApi<T>

public interface CacheOperatorApi<T>

缓存操作的基础接口，可以实现不同种缓存实现

泛型为cache的值类class类型

从以下版本开始:

2020/7/8 22:02

作者:

stylefeng

方法概要

限定符和类型	方法和说明
default String	calcKey(String keyParam) 计算最终插入缓存的key值 key的组成方式：租户前缀:业务前缀:业务key
boolean	contains(String key) 判断某个key值是否存在于缓存
void	expire(String key, Long expiredSeconds) 删除缓存
T	get(String key) 通过缓存key获取缓存
Collection<String>	getAllKeys() 获得缓存的所有key列表（不带common prefix的）
Map<String,T>	getAllKeyValues() 获取所有的key，value
Collection<T>	getAllValues() 获得缓存的所有值列表
String	getCommonKeyPrefix() 通用缓存的前缀，用于区分不同业务 如果带了前缀，所有的缓存在添加的时候，key都会带上这个前缀
default String	getFinalPrefix() 获取最终的计算前缀 key的组成方式：租户前缀:业务前缀:业务key
void	put(String key, T value) 添加缓存
void	put(String key, T value, Long timeoutSeconds) 添加缓存（带过期时间，单位是秒）
void	remove(Collection<String> keys) 删除缓存
void	remove(String... key) 删除缓存
default String	removePrefix(String finalKey) 删除缓存key的前缀，返回用户最原始的key

方法详细资料

put

void put(String key,
         T value)

添加缓存

参数:

key - 键

value - 值

从以下版本开始:

2020/7/8 22:06

put

void put(String key,
         T value,
         Long timeoutSeconds)

添加缓存（带过期时间，单位是秒）

参数:

key - 键

value - 值

timeoutSeconds - 过期时间，单位秒

从以下版本开始:

2020/7/8 22:07

get

T get(String key)

通过缓存key获取缓存

参数:

key - 键

返回:

值

从以下版本开始:

2020/7/8 22:08

remove

void remove(String... key)

删除缓存

参数:

key - 键，多个

从以下版本开始:

2020/7/8 22:09

remove

void remove(Collection<String> keys)

删除缓存

参数:

keys - 多个键集合

从以下版本开始:

2023/7/14 17:35

expire

void expire(String key,
            Long expiredSeconds)

删除缓存

参数:

key - 键，多个

从以下版本开始:

2020/7/8 22:09

contains

boolean contains(String key)

判断某个key值是否存在于缓存

参数:

key - 缓存的键

返回:

true-存在，false-不存在

从以下版本开始:

2020/11/20 16:50

getAllKeys

Collection<String> getAllKeys()

获得缓存的所有key列表（不带common prefix的）

返回:

key列表

从以下版本开始:

2020/7/8 22:11

getAllValues

Collection<T> getAllValues()

获得缓存的所有值列表

返回:

值列表

从以下版本开始:

2020/7/8 22:11

getAllKeyValues

Map<String,T> getAllKeyValues()

获取所有的key，value

返回:

键值map

从以下版本开始:

2020/7/8 22:11

getCommonKeyPrefix

String getCommonKeyPrefix()

通用缓存的前缀，用于区分不同业务

如果带了前缀，所有的缓存在添加的时候，key都会带上这个前缀

返回:

缓存前缀

从以下版本开始:

2020/7/9 11:06

getFinalPrefix

default String getFinalPrefix()

获取最终的计算前缀

key的组成方式：租户前缀:业务前缀:业务key

从以下版本开始:

2022/11/9 10:41

calcKey

default String calcKey(String keyParam)

计算最终插入缓存的key值

key的组成方式：租户前缀:业务前缀:业务key

参数:

keyParam - 用户传递的key参数

返回:

最终插入缓存的key值

从以下版本开始:

2021/7/30 21:18

removePrefix

default String removePrefix(String finalKey)

删除缓存key的前缀，返回用户最原始的key

参数:

finalKey - 最终存在CacheOperator的key

返回:

用户最原始的key

从以下版本开始:

2022/11/9 10:31