com.xiaoleilu.hutool.cache

类 AbstractCache<K,V>

java.lang.Object

com.xiaoleilu.hutool.cache.AbstractCache<K,V>

类型参数:

K - 键类型

V - 值类型

所有已实现的接口:

Cache<K,V>, Iterable<V>

直接已知子类:

FIFOCache, LFUCache, LRUCache, TimedCache

public abstract class AbstractCache<K,V>
extends Object
implements Cache<K,V>, Iterable<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()

方法概要

方法

限定符和类型	方法和说明
int	capacity()
void	clear() 清空缓存
V	get(K key) 从缓存中获得对象，当对象不在缓存中或已经过期返回null
int	getHitCount()
int	getMissCount()
boolean	isEmpty()
boolean	isFull()
protected boolean	isPruneExpiredActive() 只有设置公共缓存失效时长或每个对象单独的失效时长时清理可用
Iterator<V>	iterator()
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()
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)

getHitCount

public int getHitCount()

返回:

命中数

getMissCount

public int getMissCount()

返回:

丢失数

get

public V get(K key)

从接口复制的说明: Cache

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

指定者:

get 在接口中 Cache<K,V>

参数:

key - 键

返回:

键对应的对象

iterator

public Iterator<V> iterator()

指定者:

iterator 在接口中 Cache<K,V>

指定者:

iterator 在接口中 Iterable<V>

返回:

返回缓存迭代器

pruneCache

protected abstract int pruneCache()

清理实现

返回:

清理数

prune

public final int prune()

从接口复制的说明: Cache

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

指定者:

prune 在接口中 Cache<K,V>

返回:

清理的缓存对象个数

capacity

public int capacity()

指定者:

capacity 在接口中 Cache<K,V>

返回:

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

timeout

public long timeout()

指定者:

timeout 在接口中 Cache<K,V>

返回:

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

isPruneExpiredActive

protected boolean isPruneExpiredActive()

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

返回:

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

isFull

public boolean isFull()

指定者:

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()

指定者:

size 在接口中 Cache<K,V>

返回:

缓存的对象数量

isEmpty

public boolean isEmpty()

指定者:

isEmpty 在接口中 Cache<K,V>

返回:

缓存是否为空

toString

public String toString()

覆盖:

toString 在类中 Object