cn.hutool.cache.impl

类 AbstractCache<K,V>

java.lang.Object

cn.hutool.cache.impl.AbstractCache<K,V>

类型参数:

K - 键类型

V - 值类型

所有已实现的接口:

Cache<K,V>, Serializable, Iterable<V>

直接已知子类:

FIFOCache, LFUCache, LRUCache, TimedCache

public abstract class AbstractCache<K,V>
extends Object
implements Cache<K,V>

超时和限制大小的缓存的默认实现
继承此抽象缓存需要：

• 创建一个新的Map
• 实现 prune 策略

作者:

Looly,jodd

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段和说明
protected Map<K,CacheObj<K,V>>	cacheMap
protected int	capacity 返回缓存容量，0表示无大小限制
protected boolean	existCustomTimeout 每个对象是否有单独的失效时长，用于决定清理过期对象是否有必要。
protected int	hitCount 命中数
protected int	missCount 丢失数
protected long	timeout 缓存失效时长， 0 表示无限制，单位毫秒

构造器概要

构造器

构造器和说明
AbstractCache()

方法概要

方法

限定符和类型	方法和说明
Iterator<CacheObj<K,V>>	cacheObjIterator() 返回包含键和值得迭代器
int	capacity() 返回缓存容量，0表示无大小限制
void	clear() 清空缓存
boolean	containsKey(K key) 是否包含key
V	get(K key) 从缓存中获得对象，当对象不在缓存中或已经过期返回null 调用此方法时，会检查上次调用时间，如果与当前时间差值大于超时时间返回null，否则返回值。
V	get(K key, boolean isUpdateLastAccess) 从缓存中获得对象，当对象不在缓存中或已经过期返回null 调用此方法时，会检查上次调用时间，如果与当前时间差值大于超时时间返回null，否则返回值。
V	get(K key, Func0<V> supplier) 从缓存中获得对象，当对象不在缓存中或已经过期返回Func0回调产生的对象
int	getHitCount()
int	getMissCount()
boolean	isEmpty() 缓存是否为空
boolean	isFull() 缓存是否已满，仅用于有空间限制的缓存对象
protected boolean	isPruneExpiredActive() 只有设置公共缓存失效时长或每个对象单独的失效时长时清理可用
Iterator<V>	iterator() 返回缓存迭代器
protected void	onRemove(K key, V cachedObject) 对象移除回调。
int	prune() 从缓存中清理过期对象，清理策略取决于具体实现
protected abstract int	pruneCache() 清理实现
void	put(K key, V object) 将对象加入到缓存，使用默认失效时长
void	put(K key, V object, long timeout) 将对象加入到缓存，使用指定失效时长 如果缓存空间满了，Cache.prune() 将被调用以获得空间来存放新对象
void	remove(K key) 从缓存中移除对象
int	size() 缓存的对象数量
long	timeout() 缓存失效时长， 0 表示没有设置，单位毫秒
String	toString()

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

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

字段详细资料

cacheMap

protected Map<K,CacheObj<K,V>> cacheMap

capacity

protected int capacity

返回缓存容量，0表示无大小限制

timeout

protected long timeout

缓存失效时长， 0 表示无限制，单位毫秒

existCustomTimeout

protected boolean existCustomTimeout

每个对象是否有单独的失效时长，用于决定清理过期对象是否有必要。

hitCount

protected int hitCount

命中数

missCount

protected int missCount

丢失数

构造器详细资料

AbstractCache

public AbstractCache()

方法详细资料

put

public void put(K key,
       V object)

从接口复制的说明: Cache

将对象加入到缓存，使用默认失效时长

指定者:

put 在接口中 Cache<K,V>

参数:

key - 键

object - 缓存的对象

另请参阅:

Cache.put(Object, Object, long)

put

public void put(K key,
       V object,
       long timeout)

从接口复制的说明: Cache

将对象加入到缓存，使用指定失效时长
如果缓存空间满了，Cache.prune() 将被调用以获得空间来存放新对象

指定者:

put 在接口中 Cache<K,V>

参数:

key - 键

object - 缓存的对象

timeout - 失效时长，单位毫秒

另请参阅:

Cache.put(Object, Object, long)

containsKey

public boolean containsKey(K key)

从接口复制的说明: Cache

是否包含key

指定者:

containsKey 在接口中 Cache<K,V>

参数:

key - KEY

返回:

是否包含key

getHitCount

public int getHitCount()

返回:

命中数

getMissCount

public int getMissCount()

返回:

丢失数

get

public V get(K key)

从接口复制的说明: Cache

从缓存中获得对象，当对象不在缓存中或已经过期返回null

调用此方法时，会检查上次调用时间，如果与当前时间差值大于超时时间返回null，否则返回值。

每次调用此方法会刷新最后访问时间，也就是说会重新计算超时时间。

指定者:

get 在接口中 Cache<K,V>

参数:

key - 键

返回:

键对应的对象

另请参阅:

Cache.get(Object, boolean)

get

public V get(K key,
    Func0<V> supplier)

从接口复制的说明: Cache

从缓存中获得对象，当对象不在缓存中或已经过期返回Func0回调产生的对象

指定者:

get 在接口中 Cache<K,V>

参数:

key - 键

supplier - 如果不存在回调方法，用于生产值对象

返回:

值对象

get

public V get(K key,
    boolean isUpdateLastAccess)

从接口复制的说明: Cache

从缓存中获得对象，当对象不在缓存中或已经过期返回null

调用此方法时，会检查上次调用时间，如果与当前时间差值大于超时时间返回null，否则返回值。

指定者:

get 在接口中 Cache<K,V>

参数:

key - 键

isUpdateLastAccess - 是否更新最后访问时间，即重新计算超时时间。

返回:

键对应的对象

iterator

public Iterator<V> iterator()

从接口复制的说明: Cache

返回缓存迭代器

指定者:

iterator 在接口中 Cache<K,V>

指定者:

iterator 在接口中 Iterable<V>

返回:

缓存迭代器

cacheObjIterator

public Iterator<CacheObj<K,V>> cacheObjIterator()

从接口复制的说明: Cache

返回包含键和值得迭代器

指定者:

cacheObjIterator 在接口中 Cache<K,V>

返回:

缓存对象迭代器

pruneCache

protected abstract int pruneCache()

清理实现

返回:

清理数

prune

public final int prune()

从接口复制的说明: Cache

从缓存中清理过期对象，清理策略取决于具体实现

指定者:

prune 在接口中 Cache<K,V>

返回:

清理的缓存对象个数

capacity

public int capacity()

从接口复制的说明: Cache

返回缓存容量，0表示无大小限制

指定者:

capacity 在接口中 Cache<K,V>

返回:

返回缓存容量，0表示无大小限制

timeout

public long timeout()

从接口复制的说明: Cache

缓存失效时长， 0 表示没有设置，单位毫秒

指定者:

timeout 在接口中 Cache<K,V>

返回:

默认缓存失效时长。
每个对象可以单独设置失效时长

isPruneExpiredActive

protected boolean isPruneExpiredActive()

只有设置公共缓存失效时长或每个对象单独的失效时长时清理可用

返回:

过期对象清理是否可用，内部使用

isFull

public boolean isFull()

从接口复制的说明: Cache

缓存是否已满，仅用于有空间限制的缓存对象

指定者:

isFull 在接口中 Cache<K,V>

返回:

缓存是否已满，仅用于有空间限制的缓存对象

remove

public void remove(K key)

从接口复制的说明: Cache

从缓存中移除对象

指定者:

remove 在接口中 Cache<K,V>

参数:

key - 键

clear

public void clear()

从接口复制的说明: Cache

清空缓存

指定者:

clear 在接口中 Cache<K,V>

size

public int size()

从接口复制的说明: Cache

缓存的对象数量

指定者:

size 在接口中 Cache<K,V>

返回:

缓存的对象数量

isEmpty

public boolean isEmpty()

从接口复制的说明: Cache

缓存是否为空

指定者:

isEmpty 在接口中 Cache<K,V>

返回:

缓存是否为空

toString

public String toString()

覆盖:

toString 在类中 Object

onRemove

protected void onRemove(K key,
            V cachedObject)

对象移除回调。默认无动作

参数:

key - 键

cachedObject - 被缓存的对象