cloud.agileframework.cache.support

接口 AgileCache

所有超级接口:

org.springframework.cache.Cache

所有已知实现类:

AbstractAgileCache, AgileEhCache, AgileRedis, MemoryCache

public interface AgileCache
extends org.springframework.cache.Cache

从以下版本开始:

1.0

版本:

1.0

作者:

佟盟 日期 2019/7/15 13:50 描述 缓存实例功能集接口

嵌套类概要

从接口继承的嵌套类/接口 org.springframework.cache.Cache

org.springframework.cache.Cache.ValueRetrievalException, org.springframework.cache.Cache.ValueWrapper

方法概要

限定符和类型	方法和说明
void	addToList(Object listKey, Object node) 向List中添加节点
void	addToMap(Object mapKey, Object key, Object value) 向Map中添加数据
void	addToSet(Object setKey, Object node) 向set中添加节点
void	clear() 清理
boolean	containKey(Object key) 判断
void	evict(Object key) 删除
<T> T	get(Object key, Class<T> clazz) 获取
Object	getFromList(Object listKey, int index) 从List中获取下标为inde下的节点数据
<T> T	getFromList(Object listKey, int index, Class<T> clazz) 从List中获取下标为inde下的节点数据
Object	getFromMap(Object mapKey, Object key) 查询Map中索引key对应的value数据
<T> T	getFromMap(Object mapKey, Object key, Class<T> clazz) 查询Map中索引key对应的value数据
String	getName() 获取缓存区域名
Object	getNativeCache() 直接获取缓存客户端
boolean	lock(Object lock) 分布式同步锁
boolean	lock(Object lock, Duration timeout) 分布式同步锁
void	put(Object key, Object value) 存储
void	put(Object key, Object value, Duration timeout) 过期存储
org.springframework.cache.Cache.ValueWrapper	putIfAbsent(Object key, Object value) 如果不存在就存，存在就不存
void	removeFromList(Object listKey, int index) 从List中删除下标节点
void	removeFromMap(Object mapKey, Object key) 从Map中删除索引key
void	removeFromSet(Object setKey, Object node) set中删除节点
void	unlock(Object lock) 解锁
void	unlock(Object lock, Duration timeout) 解锁

从接口继承的方法 org.springframework.cache.Cache

evictIfPresent, get, get, invalidate

方法详细资料

getName

String getName()

获取缓存区域名

指定者:

getName 在接口中 org.springframework.cache.Cache

返回:

例如:common-cache

getNativeCache

Object getNativeCache()

直接获取缓存客户端

指定者:

getNativeCache 在接口中 org.springframework.cache.Cache

返回:

例如:RedisConnection/Ehcache

putIfAbsent

org.springframework.cache.Cache.ValueWrapper putIfAbsent(Object key,
                                                         Object value)

如果不存在就存，存在就不存

指定者:

putIfAbsent 在接口中 org.springframework.cache.Cache

参数:

key - 索引

value - 值

返回:

包装值

put

void put(Object key,
         Object value,
         Duration timeout)

过期存储

参数:

key - 索引

value - 值

timeout - 过期时间

put

void put(Object key,
         Object value)

存储

指定者:

put 在接口中 org.springframework.cache.Cache

参数:

key - 索引

value - 值

get

<T> T get(Object key,
          Class<T> clazz)

获取

指定者:

get 在接口中 org.springframework.cache.Cache

类型参数:

T - 泛型

参数:

key - 索引

clazz - 类型

返回:

值

evict

void evict(Object key)

删除

指定者:

evict 在接口中 org.springframework.cache.Cache

参数:

key - 索引

clear

void clear()

清理

指定者:

clear 在接口中 org.springframework.cache.Cache

containKey

boolean containKey(Object key)

判断

参数:

key - 索引

返回:

是否

addToMap

void addToMap(Object mapKey,
              Object key,
              Object value)

向Map中添加数据

参数:

mapKey - map索引

key - key

value - value

getFromMap

Object getFromMap(Object mapKey,
                  Object key)

查询Map中索引key对应的value数据

参数:

mapKey - map索引

key - key

返回:

值

getFromMap

<T> T getFromMap(Object mapKey,
                 Object key,
                 Class<T> clazz)

查询Map中索引key对应的value数据

参数:

mapKey - map索引

key - key

返回:

值

removeFromMap

void removeFromMap(Object mapKey,
                   Object key)

从Map中删除索引key

参数:

mapKey - map索引

key - key

addToList

void addToList(Object listKey,
               Object node)

向List中添加节点

参数:

listKey - list索引

node - 节点数据

getFromList

Object getFromList(Object listKey,
                   int index)

从List中获取下标为inde下的节点数据

参数:

listKey - list索引

index - 节点下标

返回:

值

getFromList

<T> T getFromList(Object listKey,
                  int index,
                  Class<T> clazz)

从List中获取下标为inde下的节点数据

参数:

listKey - list索引

index - 节点下标

返回:

值

removeFromList

void removeFromList(Object listKey,
                    int index)

从List中删除下标节点

参数:

listKey - list索引

index - 节点下标

addToSet

void addToSet(Object setKey,
              Object node)

向set中添加节点

参数:

setKey - set索引

node - 节点数据

removeFromSet

void removeFromSet(Object setKey,
                   Object node)

set中删除节点

参数:

setKey - set索引

node - 节点数据

lock

boolean lock(Object lock)

分布式同步锁

参数:

lock - 锁标识

返回:

是否加锁成功

lock

boolean lock(Object lock,
             Duration timeout)

分布式同步锁

参数:

lock - 锁标识

timeout - 超时

返回:

是否加锁成功

unlock

void unlock(Object lock)

解锁

参数:

lock - 锁标识

unlock

void unlock(Object lock,
            Duration timeout)

解锁

参数:

timeout - 过期时间

lock - 锁标识