AgileRedis (Agile通用缓存组件 2.0.8 API)

java.lang.Object
- cloud.agileframework.cache.support.AbstractAgileCache
- - cloud.agileframework.cache.support.redis.AgileRedis

所有已实现的接口:

AgileCache, org.springframework.cache.Cache
```
public class AgileRedis
extends AbstractAgileCache
```
从以下版本开始:

1.0

版本:

1.0

作者:

佟盟日期 2019/7/23 18:36 描述 TODO

嵌套类概要
- 从接口继承的嵌套类/接口 org.springframework.cache.Cache
  org.springframework.cache.Cache.ValueRetrievalException, org.springframework.cache.Cache.ValueWrapper

字段概要
- 从类继承的字段 cloud.agileframework.cache.support.AbstractAgileCache
  cache

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addToList(Object listKey, Object node)` 向List中添加节点
`void`	`addToMap(Object mapKey, Object key, Object value)` 向Map中添加数据
`void`	`addToSet(Object setKey, Object node)` 向set中添加节点
`boolean`	`containKey(Object key)` 判断
`protected Object`	`deserializeCacheKey(byte[] value)`
`protected Object`	`deserializeCacheValue(byte[] value)`
`org.springframework.cache.Cache.ValueWrapper`	`get(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数据
`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)` 过期存储
`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)` 解锁

从类继承的方法 cloud.agileframework.cache.support.AbstractAgileCache
clear, evict, get, getName, putIfAbsent

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

- 方法详细资料
  - put
```
public void put(Object key,
                Object value,
                Duration timeout)
```
    从接口复制的说明: AgileCache
    
    过期存储
    
    参数:
    
    key - 索引
    
    value - 值
    
    timeout - 过期时间
  - containKey
```
public boolean containKey(Object key)
```
    从接口复制的说明: AgileCache
    
    判断
    
    参数:
    
    key - 索引
    
    返回:
    
    是否
  - addToMap
```
public void addToMap(Object mapKey,
                     Object key,
                     Object value)
```
    从接口复制的说明: AgileCache
    
    向Map中添加数据
    
    参数:
    
    mapKey - map索引
    
    key - key
    
    value - value
  - getFromMap
```
public Object getFromMap(Object mapKey,
                         Object key)
```
    从接口复制的说明: AgileCache
    
    查询Map中索引key对应的value数据
    
    参数:
    
    mapKey - map索引
    
    key - key
    
    返回:
    
    值
  - getFromMap
```
public <T> T getFromMap(Object mapKey,
                        Object key,
                        Class<T> clazz)
```
    从接口复制的说明: AgileCache
    
    查询Map中索引key对应的value数据
    
    参数:
    
    mapKey - map索引
    
    key - key
    
    返回:
    
    值
  - removeFromMap
```
public void removeFromMap(Object mapKey,
                          Object key)
```
    从接口复制的说明: AgileCache
    
    从Map中删除索引key
    
    参数:
    
    mapKey - map索引
    
    key - key
  - addToList
```
public void addToList(Object listKey,
                      Object node)
```
    从接口复制的说明: AgileCache
    
    向List中添加节点
    
    参数:
    
    listKey - list索引
    
    node - 节点数据
  - getFromList
```
public Object getFromList(Object listKey,
                          int index)
```
    从接口复制的说明: AgileCache
    
    从List中获取下标为inde下的节点数据
    
    参数:
    
    listKey - list索引
    
    index - 节点下标
    
    返回:
    
    值
  - getFromList
```
public <T> T getFromList(Object listKey,
                         int index,
                         Class<T> clazz)
```
    从接口复制的说明: AgileCache
    
    从List中获取下标为inde下的节点数据
    
    参数:
    
    listKey - list索引
    
    index - 节点下标
    
    返回:
    
    值
  - removeFromList
```
public void removeFromList(Object listKey,
                           int index)
```
    从接口复制的说明: AgileCache
    
    从List中删除下标节点
    
    参数:
    
    listKey - list索引
    
    index - 节点下标
  - addToSet
```
public void addToSet(Object setKey,
                     Object node)
```
    从接口复制的说明: AgileCache
    
    向set中添加节点
    
    参数:
    
    setKey - set索引
    
    node - 节点数据
  - removeFromSet
```
public void removeFromSet(Object setKey,
                          Object node)
```
    从接口复制的说明: AgileCache
    
    set中删除节点
    
    参数:
    
    setKey - set索引
    
    node - 节点数据
  - lock
```
public boolean lock(Object lock)
```
    从接口复制的说明: AgileCache
    
    分布式同步锁
    
    参数:
    
    lock - 锁标识
    
    返回:
    
    是否加锁成功
  - lock
```
public boolean lock(Object lock,
                    Duration timeout)
```
    从接口复制的说明: AgileCache
    
    分布式同步锁
    
    参数:
    
    lock - 锁标识
    
    timeout - 超时
    
    返回:
    
    是否加锁成功
  - unlock
```
public void unlock(Object lock)
```
    从接口复制的说明: AgileCache
    
    解锁
    
    参数:
    
    lock - 锁标识
  - unlock
```
public void unlock(Object lock,
                   Duration timeout)
```
    从接口复制的说明: AgileCache
    
    解锁
    
    参数:
    
    lock - 锁标识
    
    timeout - 过期时间
  - deserializeCacheValue
```
protected Object deserializeCacheValue(byte[] value)
```
  - deserializeCacheKey
```
protected Object deserializeCacheKey(byte[] value)
```
  - put
```
public void put(Object key,
                Object value)
```
    从接口复制的说明: AgileCache
    
    存储
    
    指定者:
    
    put 在接口中 AgileCache
    
    指定者:
    
    put 在接口中 org.springframework.cache.Cache
    
    覆盖:
    
    put 在类中 AbstractAgileCache
    
    参数:
    
    key - 索引
    
    value - 值
  - get
```
public <T> T get(Object key,
                 Class<T> clazz)
```
    从接口复制的说明: AgileCache
    
    获取
    
    指定者:
    
    get 在接口中 AgileCache
    
    指定者:
    
    get 在接口中 org.springframework.cache.Cache
    
    覆盖:
    
    get 在类中 AbstractAgileCache
    
    类型参数:
    
    T - 泛型
    
    参数:
    
    key - 索引
    
    clazz - 类型
    
    返回:
    
    值
  - get
```
public org.springframework.cache.Cache.ValueWrapper get(Object key)
```
    指定者:
    
    get 在接口中 org.springframework.cache.Cache
    
    覆盖:
    
    get 在类中 AbstractAgileCache
  - getNativeCache
```
public Object getNativeCache()
```
    从接口复制的说明: AgileCache
    
    直接获取缓存客户端
    
    指定者:
    
    getNativeCache 在接口中 AgileCache
    
    指定者:
    
    getNativeCache 在接口中 org.springframework.cache.Cache
    
    覆盖:
    
    getNativeCache 在类中 AbstractAgileCache
    
    返回:
    
    例如:RedisConnection/Ehcache

类 AgileRedis

嵌套类概要

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

字段概要

从类继承的字段 cloud.agileframework.cache.support.AbstractAgileCache

方法概要

从类继承的方法 cloud.agileframework.cache.support.AbstractAgileCache

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

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

方法详细资料

put

containKey

addToMap

getFromMap

getFromMap

removeFromMap

addToList

getFromList

getFromList

removeFromList

addToSet

removeFromSet

lock

lock

unlock

unlock

deserializeCacheValue

deserializeCacheKey

put

get

get

getNativeCache