org.voovan.tools.collection

Class CacheMap<K,V>

java.lang.Object

org.voovan.tools.collection.CacheMap<K,V>

All Implemented Interfaces:

Map<K,V>, ICacheMap<K,V>

public class CacheMap<K,V>
extends Object
implements ICacheMap<K,V>

进程内缓存处理类 可字发现对象,在对象没有时自动同步对象到缓存,具备超时, 按照 LRU 的原则清理过期数据

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected static HashWheelTimer	CACHE_MAP_WHEEL_TIMER

Constructor Summary

Constructors

Constructor and Description
CacheMap() 构造函数
CacheMap(Integer maxSize) 构造函数
CacheMap(Map<K,V> map)
CacheMap(Map<K,V> map, int maxSize) 构造函数

Method Summary

Modifier and Type	Method and Description
CacheMap<K,V>	autoRemove(boolean autoRemove) 设置失效是否自动移除
void	checkAndDoExpire(K key) 检查指定的Key, 如果过期则处理过期的数据
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
CacheMap<K,V>	create() 创建CachedHashMap
CacheMap<K,V>	destory(BiFunction<K,V,Long> destory) 设置对象销毁函数
Set<Map.Entry<K,V>>	entrySet()
CacheMap<K,V>	expire(long expire) 设置默认超时时间
V	get(Object key, Function<K,V> appointedSupplier, Long createExpire, boolean refresh) 获取对象 不会刷新对象的时间戳
ConcurrentHashMap<K,org.voovan.tools.collection.CacheMap.TimeMark>	getCacheMark() 获取缓存标记对象
BiFunction<K,V,Long>	getDestory() 获取对象销毁函数
long	getExpire() 获取默认超时时间
Function<K,V>	getSupplier() 获取数据创建 Function 对象
long	getTTL(K key) 为 Key 获取 key 的超时时间
CacheMap<K,V>	interval(int interval) 设置最失效对象检查周期
boolean	isEmpty()
boolean	isExpire(String key) 是否过期
Set<K>	keySet()
CacheMap<K,V>	maxSize(int maxSize) 设置最大容量
V	put(K key, V value)
V	put(K key, V value, long expire) 写入对象
void	putAll(Map<? extends K,? extends V> m)
void	putAll(Map<? extends K,? extends V> m, long expire) 写入特定的整个 Map
V	putIfAbsent(K key, V value) 写入如果对象为空
V	putIfAbsent(K key, V value, long expire) 写入如果对象为空
V	remove(Object key)
boolean	remove(Object key, Object value)
boolean	setTTL(K key, long expire) 更新某个对象的超时时间 可以为某个没有配置超时时间的键值对配置超时时间
int	size()
CacheMap<K,V>	supplier(Function<K,V> buildFunction) 设置数据创建 Function 对象, 默认数据失效时不移除数据
CacheMap<K,V>	supplier(Function<K,V> buildFunction, boolean autoRemove) 设置数据创建 Function 对象
Collection<V>	values()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.voovan.tools.collection.ICacheMap

get, get, get, getAndRefresh, getAndRefresh, getAndRefresh

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, replace, replace, replaceAll

Field Detail

CACHE_MAP_WHEEL_TIMER

protected static final HashWheelTimer CACHE_MAP_WHEEL_TIMER

Constructor Detail

CacheMap

public CacheMap(Map<K,V> map,
                int maxSize)

构造函数

Parameters:

map - 缓存数据的 Map 对象

maxSize - 最大元素数量

CacheMap

public CacheMap(Map<K,V> map)

CacheMap

public CacheMap(Integer maxSize)

构造函数

Parameters:

maxSize - 缓存集合的最大容量, 多余的数据会被移除

CacheMap

public CacheMap()

构造函数

Method Detail

getSupplier

public Function<K,V> getSupplier()

获取数据创建 Function 对象

Specified by:

getSupplier in interface ICacheMap<K,V>

Returns:

Function 对象

supplier

public CacheMap<K,V> supplier(Function<K,V> buildFunction)

设置数据创建 Function 对象, 默认数据失效时不移除数据

Specified by:

supplier in interface ICacheMap<K,V>

Parameters:

buildFunction - Function 对象

Returns:

CachedHashMap 对象

supplier

public CacheMap<K,V> supplier(Function<K,V> buildFunction,
                              boolean autoRemove)

设置数据创建 Function 对象

Parameters:

buildFunction - Function 对象

autoRemove - 设置失效是否自动移除

Returns:

CachedHashMap 对象

getDestory

public BiFunction<K,V,Long> getDestory()

获取对象销毁函数

Returns:

对象销毁函数

destory

public CacheMap<K,V> destory(BiFunction<K,V,Long> destory)

设置对象销毁函数

Parameters:

destory - 对象销毁函数, 1.返回 null 则刷新为默认超时时间 2.小于0 的数据, 则移除对象 3.大于0的数据则重新设置返回值为新的超时时间

Returns:

CachedHashMap 对象

maxSize

public CacheMap<K,V> maxSize(int maxSize)

设置最大容量

Parameters:

maxSize - 最大容量

Returns:

CachedHashMap 对象

interval

public CacheMap<K,V> interval(int interval)

设置最失效对象检查周期

Parameters:

interval - 检查周期, 单位:秒, 小于零不做超时处理

Returns:

CachedHashMap 对象

autoRemove

public CacheMap<K,V> autoRemove(boolean autoRemove)

设置失效是否自动移除

Parameters:

autoRemove - true: 自动移除, false: 并不自动移除

Returns:

CachedHashMap 对象

getExpire

public long getExpire()

获取默认超时时间

Specified by:

getExpire in interface ICacheMap<K,V>

Returns:

获取超时时间

expire

public CacheMap<K,V> expire(long expire)

设置默认超时时间

Specified by:

expire in interface ICacheMap<K,V>

Parameters:

expire - 超时时间

Returns:

CachedHashMap 对象

getCacheMark

public ConcurrentHashMap<K,org.voovan.tools.collection.CacheMap.TimeMark> getCacheMark()

获取缓存标记对象

Returns:

缓存数据标记的键值对

create

public CacheMap<K,V> create()

创建CachedHashMap

Returns:

CachedHashMap 对象

checkAndDoExpire

public void checkAndDoExpire(K key)

检查指定的Key, 如果过期则处理过期的数据

Parameters:

key - 检查的 Key

get

public V get(Object key,
             Function<K,V> appointedSupplier,
             Long createExpire,
             boolean refresh)

获取对象 不会刷新对象的时间戳

Specified by:

get in interface ICacheMap<K,V>

Parameters:

key - 键

appointedSupplier - 指定的获取器

createExpire - 超时时间

refresh - 刷新超时时间

Returns:

值

putAll

public void putAll(Map<? extends K,? extends V> m)

Specified by:

putAll in interface Map<K,V>

putAll

public void putAll(Map<? extends K,? extends V> m,
                   long expire)

写入特定的整个 Map

Specified by:

putAll in interface ICacheMap<K,V>

Parameters:

m - Map对象

expire - 超时时间

size

public int size()

Specified by:

size in interface Map<K,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,V>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,V>

put

public V put(K key,
             V value)

Specified by:

put in interface Map<K,V>

put

public V put(K key,
             V value,
             long expire)

写入对象

Specified by:

put in interface ICacheMap<K,V>

Parameters:

key - 键

value - 值

expire - 超时时间

Returns:

被置入的对象

putIfAbsent

public V putIfAbsent(K key,
                     V value)

写入如果对象为空

Specified by:

putIfAbsent in interface Map<K,V>

Parameters:

key - 键

value - 值

Returns:

如果数据存在返回已经存在对象, 如果数据不存在,新的对象被置入,则返回: null

putIfAbsent

public V putIfAbsent(K key,
                     V value,
                     long expire)

写入如果对象为空

Specified by:

putIfAbsent in interface ICacheMap<K,V>

Parameters:

key - 键

value - 值

expire - 超时时间

Returns:

如果数据存在返回已经存在对象, 如果数据不存在,新的对象被置入,则返回: null

isExpire

public boolean isExpire(String key)

是否过期

Parameters:

key - 是否过期

Returns:

true: 过期, false: 未过去

getTTL

public long getTTL(K key)

Description copied from interface: ICacheMap

为 Key 获取 key 的超时时间

Specified by:

getTTL in interface ICacheMap<K,V>

Parameters:

key - key 名称

Returns:

超时时间

setTTL

public boolean setTTL(K key,
                      long expire)

更新某个对象的超时时间 可以为某个没有配置超时时间的键值对配置超时时间

Specified by:

setTTL in interface ICacheMap<K,V>

Parameters:

key - 键

expire - 超时时间

Returns:

true: 成功, false: 失败

remove

public V remove(Object key)

Specified by:

remove in interface Map<K,V>

remove

public boolean remove(Object key,
                      Object value)

Specified by:

remove in interface Map<K,V>

clear

public void clear()

Specified by:

clear in interface Map<K,V>

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

values

public Collection<V> values()

Specified by:

values in interface Map<K,V>

entrySet

public Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V>