com.seeyon.ctp.component.cache

接口 CacheMap<K extends java.io.Serializable,V extends java.io.Serializable>

所有超级接口:

GroupCacheable, java.io.Serializable

所有已知实现类:

AbstractCacheMap, GenericCacheMap, RedisCacheMap

public interface CacheMap<K extends java.io.Serializable,V extends java.io.Serializable>
extends GroupCacheable

Map缓存，暂存名/值对，机制与Map类似。

注意：
当缓存的值改变时，必须重新调用put更新或调用notifyUpdate通知缓存组件。
比如缓存的值为java collection，调用get取值后直接对collection操作，缓存不能监听值的变化。

从以下版本开始:

cloud_version

字段概要

从接口继承的字段 com.seeyon.ctp.component.cache.GroupCacheable

isCacheDisabled

方法概要

限定符和类型	方法和说明
K[]	checkInValidKeys() 检查版本标记已经无效的Key集合
int	clearAndPutAll(java.util.Map<? extends K,? extends V> map) 清除缓存并将Map中的所有项目设置到缓存中。
boolean	contains(K key) 已过时。
void	endLocalMode() 结束本地操作模式,需要根据本地操作模式下的相关缓存操作进行数据和标记位的统一处理
V	get(K key) 获取key对应的值
java.util.Map<K,V>	getBatch(java.util.Collection<K> keys) 获取keys对应的值
V	getFromLocal(K key) 从一级缓存（本地）获取数据,不检查版本标记也不击穿缓存从数据库加载，以此提升某些场景的获取效率,必须在调用startPutToLocal才能使用.
java.util.Set<K>	keySet() 已过时。
int	put(K key, V value) 设置缓存。
int	putAll(java.util.Map<? extends K,? extends V> map) 将Map中的所有项目设置到缓存中。
void	putNoWait(K key, V value) 写入值,不等待缓存标记更新,在批量写入时能加快速度,异步清除本地缓存,和Redis上的缓存数据.不等待标志返回.
void	putToLocal(K key, V value) 更新一级缓存（本地）指定key的数据,不更新标志,必须在调用startPutToLocal才能使用.
int	remove(K key) 移除缓存项。
int	removeAll(java.util.Collection<K> keys) 移除缓存项
void	startLocalMode() 开始本地操作模式，get put操作不更新或check Redis版本标记，在endLocalMode() 调用时统一处理标记和本地缓存
java.util.Map<K,V>	toMap() 已过时。
void	updateKey(K key) 更新缓存标记，下次get可从db进行load
java.util.Collection<V>	values() 已过时。

从接口继承的方法 com.seeyon.ctp.component.cache.GroupCacheable

allowRedisFlush, clear, getFullName, getGroup, getName, getStatistics, isEmpty, needConsistent, size

方法详细资料

put

int put(K key,
        V value)

设置缓存。如果指定的缓存项已存在则以新值覆盖。

参数:

key -

value -

putAll

int putAll(java.util.Map<? extends K,? extends V> map)

将Map中的所有项目设置到缓存中。效果相当于循环调用put，但性能要高一些。不清除原有项目进行追加，如果Key冲突则覆盖原缓存项。

参数:

map - Java Map

clearAndPutAll

int clearAndPutAll(java.util.Map<? extends K,? extends V> map)

清除缓存并将Map中的所有项目设置到缓存中。效果相当于先clear再putAll。

参数:

map - Java Map

get

V get(K key)

获取key对应的值

参数:

key - 缓存的Key

getBatch

java.util.Map<K,V> getBatch(java.util.Collection<K> keys)

获取keys对应的值

参数:

keys - 缓存的Key集合

remove

int remove(K key)

移除缓存项。

参数:

key - 缓存的Key

返回:

被移除的缓存项。如果不存在返回null。

removeAll

int removeAll(java.util.Collection<K> keys)

移除缓存项

参数:

keys - 缓存的Key集合，所有以集合中元素为key的换成都会被移除。

返回:

如果有元素被移除返回true，否则返回false。

updateKey

void updateKey(K key)

更新缓存标记，下次get可从db进行load

参数:

keys - 缓存的Key

contains

@Deprecated
boolean contains(K key)

已过时。

判断是否存在指定的缓存项

参数:

key - 缓存的Key

返回:

存在返回true，否则返回false。

toMap

@Deprecated
java.util.Map<K,V> toMap()

已过时。

将缓存转化为Map表示

返回:

Map，Key为缓存的Key，Value为缓存中的对象。

keySet

@Deprecated
java.util.Set<K> keySet()

已过时。

Returns a set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll retainAll, and clear operations. It does not support the add or addAll operations.

返回:

a set view of the keys contained in this map.

values

@Deprecated
java.util.Collection<V> values()

已过时。

Returns a collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

返回:

a collection view of the values contained in this map.

startLocalMode

void startLocalMode()

开始本地操作模式，get put操作不更新或check Redis版本标记，在endLocalMode() 调用时统一处理标记和本地缓存

endLocalMode

void endLocalMode()

结束本地操作模式,需要根据本地操作模式下的相关缓存操作进行数据和标记位的统一处理

putToLocal

void putToLocal(K key,
                V value)

更新一级缓存（本地）指定key的数据,不更新标志,必须在调用startPutToLocal才能使用.

参数:

key -

getFromLocal

V getFromLocal(K key)

从一级缓存（本地）获取数据,不检查版本标记也不击穿缓存从数据库加载，以此提升某些场景的获取效率,必须在调用startPutToLocal才能使用.

参数:

key -

返回:

checkInValidKeys

K[] checkInValidKeys()

检查版本标记已经无效的Key集合

返回:

putNoWait

void putNoWait(K key,
               V value)

写入值,不等待缓存标记更新,在批量写入时能加快速度,异步清除本地缓存,和Redis上的缓存数据.不等待标志返回.

参数:

key -

value -