Cache (Java SDK API Reference for AWS PaaS)

java.lang.Object
- com.actionsoft.bpms.commons.cache.Cache<K,V>

类型参数:

K - - 缓存键

V - - 缓存值
```
public abstract class Cache<K extends java.io.Serializable,V extends java.io.Serializable>
extends java.lang.Object
```
AWS缓存接口，通过调用load()方法完成缓存初始化。App启动时通过CachePluginProfile的注册声明加载该缓存对象
- 1、内置集群同步机制。默认提供了Put、Remove、Init常用同步动作的实现，开发者可在子类的构造函数中注册 ReplicateActionListener扩展自定义缓存同步动作；
- 2、支持过期失效设置；
- 3、支持缓存对象上限设置和相对淘汰算法；
- 4、支持内存索引。开发者可通过在子类中注册 CacheIndex扩展索引定义；
使用注意事项：
- 1、K、V和缓存对象需要同步的属性都需要继承java.io.Serializable
- 2、使用多值索引时需要重写V的equals和hashCode方法

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`ACTION_DESTROY` 销毁全部缓存对象指令
`static java.lang.String`	`ACTION_INIT` 重新加载缓存对象指令
`static java.lang.String`	`ACTION_PUT` 更新缓存对象指令
`static java.lang.String`	`ACTION_REMOVE` 移走缓存对象指令
`static int`	`MEM_LOADING`
`static int`	`REDIS_CLOSE`
`static int`	`REDIS_CLOSEING`
`static int`	`REDIS_NO_LOADREDIS`
`static int`	`REDIS_OPEN`
`static int`	`REDIS_OPENING`

构造器概要

构造器
构造器和说明

Cache()

Cache(CachePluginProfile configuration)
构造方法，初始化一个新的缓存存储和缓存索引。

构造器
构造器和说明
`Cache()`
`Cache(CachePluginProfile configuration)` 构造方法，初始化一个新的缓存存储和缓存索引。

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addOpsTrace(java.lang.String op, K key)` 增加操作信息，内部方法
`void`	`addTo()`
`void`	`destroy()` 清空缓存内容，同时清空集群节点
`void`	`destroy(boolean notifyCluster)` 清空缓存内容
`void`	`destroyMem(boolean notifyCluster)`
`void`	`destroyRedis()`
`V`	`get(K key)` 根据key查询缓存对象，当对象过期或者不存在时返回null
`CachePluginProfile`	`getConfiguration()` Cache插件配置模型
`java.util.Map<java.lang.Class<? extends <any>>,<any>>`	`getIndexs()` 获得索引集合，内部使用
`<any>`	`getOpsTrace()` 获得当前缓存的操作信息
`<any>`	`getRedisAdapter()`
`java.util.List<V>`	`getRedisValues(java.util.List<K> keys)`
`long`	`getUpdateTime()` 获得最后更新时间
`boolean`	`isPurge()` 是否定期执行该缓存的purge方法
`boolean`	`isRedisCache()`
`java.util.Iterator<V>`	`iterator()` 获得结果迭代器，但不保证缓存对象顺序
`java.util.Iterator<V>`	`iteratorSorted(java.util.Comparator<V> comparator)` 获得排序后的结果迭代器
`static <T> java.util.List<T>`	`iteratorToList(java.util.Iterator<T> it)` 工具方法,将迭代转换为列表
`java.util.Set<K>`	`keys()` 所有的键
`void`	`onReplicate(java.lang.String action, java.lang.Object param)` 仅用于cache内部。
`void`	`purge()` 清理方法
`void`	`put(K key, V object)` 缓存一个永不过期的对象，如果处于集群部署时同步到其他节点
`void`	`put(K key, V object, boolean notifyCluster)` 缓存一个永不过期的对象
`void`	`put(K key, V object, long timeout)` 缓存一个对象，如果处于集群部署时同步到其他节点
`void`	`put(K key, V object, long timeout, boolean notifyCluster)` 缓存一个对象
`void`	`putRedis(java.util.List<V> list)` 将多个对象批量放入Redis
`void`	`reload()` 重新加载缓存，包含重新加载其它集群节点
`void`	`reload(boolean notifyCluster)` 重新加载缓存
`void`	`remove(K key)`
`void`	`remove(K key, boolean notifyCluster)`
`V`	`removeX(K key)` 根据key删除缓存对象。
`V`	`removeX(K key, boolean notifyCluster)` 根据key删除缓存对象
`void`	`replicate(java.lang.String action, java.io.Serializable param)` 仅用于cache的子类。
`int`	`size()` 获得当前缓存对象个数。
`java.util.stream.Stream<V>`	`stream()` 获取一个不保证缓存顺序的串行流

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

- 字段详细资料
  - ACTION_PUT
```
public static final java.lang.String ACTION_PUT
```
    更新缓存对象指令
    
    另请参阅:
    
    常量字段值
  - ACTION_REMOVE
```
public static final java.lang.String ACTION_REMOVE
```
    移走缓存对象指令
    
    另请参阅:
    
    常量字段值
  - ACTION_INIT
```
public static final java.lang.String ACTION_INIT
```
    重新加载缓存对象指令
    
    另请参阅:
    
    常量字段值
  - ACTION_DESTROY
```
public static final java.lang.String ACTION_DESTROY
```
    销毁全部缓存对象指令
    
    另请参阅:
    
    常量字段值
  - REDIS_CLOSE
```
public static final int REDIS_CLOSE
```
    另请参阅:
    
    常量字段值
  - REDIS_OPEN
```
public static final int REDIS_OPEN
```
    另请参阅:
    
    常量字段值
  - REDIS_OPENING
```
public static final int REDIS_OPENING
```
    另请参阅:
    
    常量字段值
  - REDIS_CLOSEING
```
public static final int REDIS_CLOSEING
```
    另请参阅:
    
    常量字段值
  - REDIS_NO_LOADREDIS
```
public static final int REDIS_NO_LOADREDIS
```
    另请参阅:
    
    常量字段值
  - MEM_LOADING
```
public static final int MEM_LOADING
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - Cache
```
public Cache(CachePluginProfile configuration)
```
    构造方法，初始化一个新的缓存存储和缓存索引。如果该缓存对象扩展了缓存索引或自定义的集群同步动作，请在该构造方法中注册
    
    参数:
    
    configuration - 缓存插件注册配置对象
    
    另请参阅:
    
    ReplicateActionListener, CacheIndex
  - Cache
```
public Cache()
```
- 方法详细资料
  - put
```
public void put(K key,
                V object)
```
    缓存一个永不过期的对象，如果处于集群部署时同步到其他节点
    
    参数:
    
    key - 缓存对象键值
    
    object - 缓存对象
    
    另请参阅:
    
    key、object实现序列化接口
  - put
```
public void put(K key,
                V object,
                boolean notifyCluster)
```
    缓存一个永不过期的对象
    
    参数:
    
    key - 缓存对象键值
    
    object - 缓存对象
    
    notifyCluster - 是否同步到其它集群节点
    
    另请参阅:
    
    key、object实现序列化接口
  - put
```
public void put(K key,
                V object,
                long timeout)
```
    缓存一个对象，如果处于集群部署时同步到其他节点
    
    参数:
    
    key - 缓存对象键值
    
    object - 缓存对象
    
    timeout - 过期时间（单位秒），如果值为0表示永不过期
    
    另请参阅:
    
    key、object实现序列化接口
  - put
```
public void put(K key,
                V object,
                long timeout,
                boolean notifyCluster)
```
    缓存一个对象
    
    参数:
    
    key - 缓存对象键值
    
    object - 缓存对象
    
    timeout - 过期时间（单位秒），如果值为0表示永不过期
    
    notifyCluster - 是否同步到其它集群节点
    
    另请参阅:
    
    key、object实现序列化接口
  - reload
```
public void reload()
```
    重新加载缓存，包含重新加载其它集群节点
  - reload
```
public void reload(boolean notifyCluster)
```
    重新加载缓存
    
    参数:
    
    notifyCluster - 是否重新加载其它集群节点
  - destroy
```
public void destroy()
```
    清空缓存内容，同时清空集群节点
  - destroy
```
public void destroy(boolean notifyCluster)
```
    清空缓存内容
    
    参数:
    
    notifyCluster - 是否清空保存集群节点
  - destroyRedis
```
public void destroyRedis()
```
  - destroyMem
```
public void destroyMem(boolean notifyCluster)
```
  - get
```
public V get(K key)
```
    根据key查询缓存对象，当对象过期或者不存在时返回null
    
    参数:
    
    key - 缓存对象键值
    
    返回:
    
    缓存对象
  - keys
```
public java.util.Set<K> keys()
```
    所有的键
  - purge
```
public void purge()
```
    清理方法
  - iterator
```
public java.util.Iterator<V> iterator()
```
    获得结果迭代器，但不保证缓存对象顺序
    
    返回:
    
    全部缓存对象
  - getRedisValues
```
public java.util.List<V> getRedisValues(java.util.List<K> keys)
```
  - stream
```
public java.util.stream.Stream<V> stream()
```
    获取一个不保证缓存顺序的串行流
    
    返回:
    
    流对象
  - iteratorSorted
```
public java.util.Iterator<V> iteratorSorted(java.util.Comparator<V> comparator)
```
    获得排序后的结果迭代器
    
    参数:
    
    comparator - 排序算法
    
    返回:
    
    全部缓存对象
  - remove
```
public void remove(K key)
```
  - remove
```
public void remove(K key,
                   boolean notifyCluster)
```
  - removeX
```
public V removeX(K key)
```
    根据key删除缓存对象。如果该对象在其它集群节点有副本，一并删除
    
    参数:
    
    key - 缓存对象键值
  - removeX
```
public V removeX(K key,
                 boolean notifyCluster)
```
    根据key删除缓存对象
    
    参数:
    
    key - 缓存对象键值
    
    notifyCluster - 是否删除其它集群节点的对象
  - replicate
```
public void replicate(java.lang.String action,
                      java.io.Serializable param)
```
    仅用于cache的子类。该方法是集群状态下节点间同步的公共方法，一般只在子类需要自定义同步动作进行扩展同步的场景
  - onReplicate
```
public void onReplicate(java.lang.String action,
                        java.lang.Object param)
```
    仅用于cache内部。 cache对象收到集群节点同步动作后，会把action动作转发给注册的名称为action的ReplicateActionListener处理
  - size
```
public int size()
```
    获得当前缓存对象个数。包括失效对象
  - getIndexs
```
public java.util.Map<java.lang.Class<? extends <any>>,<any>> getIndexs()
```
    获得索引集合，内部使用
  - iteratorToList
```
public static <T> java.util.List<T> iteratorToList(java.util.Iterator<T> it)
```
    工具方法,将迭代转换为列表
    
    参数:
    
    it - 迭代器
    
    返回:
    
    一个List集合
  - getConfiguration
```
public CachePluginProfile getConfiguration()
```
    Cache插件配置模型
  - isPurge
```
public boolean isPurge()
```
    是否定期执行该缓存的purge方法
  - getUpdateTime
```
public long getUpdateTime()
```
    获得最后更新时间
  - addOpsTrace
```
public void addOpsTrace(java.lang.String op,
                        K key)
```
    增加操作信息，内部方法
    
    参数:
    
    op - 操作信息
    
    key - 键
  - getOpsTrace
```
public <any> getOpsTrace()
```
    获得当前缓存的操作信息
  - getRedisAdapter
```
public <any> getRedisAdapter()
```
  - putRedis
```
public void putRedis(java.util.List<V> list)
```
    将多个对象批量放入Redis
    
    参数:
    
    list - 需缓存的对象组成的list
  - isRedisCache
```
public boolean isRedisCache()
```
  - addTo
```
public void addTo()
```

类 Cache<K extends java.io.Serializable,V extends java.io.Serializable>

字段概要

构造器概要

方法概要

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

字段详细资料

ACTION_PUT

ACTION_REMOVE

ACTION_INIT

ACTION_DESTROY

REDIS_CLOSE

REDIS_OPEN

REDIS_OPENING

REDIS_CLOSEING

REDIS_NO_LOADREDIS

MEM_LOADING

构造器详细资料

Cache

Cache

方法详细资料

put

put

put

put

reload

reload

destroy

destroy

destroyRedis

destroyMem

get

keys

purge

iterator

getRedisValues

stream

iteratorSorted

remove

remove

removeX

removeX

replicate

onReplicate

size

getIndexs

iteratorToList

getConfiguration

isPurge

getUpdateTime

addOpsTrace

getOpsTrace

getRedisAdapter

putRedis

isRedisCache

addTo