com.github.netty.core.util

类 ExpiryLRUMap<K,V>

java.lang.Object

java.util.AbstractMap<K,V>

com.github.netty.core.util.ExpiryLRUMap<K,V>

所有已实现的接口:

ConcurrentMap<K,V>, Map<K,V>

public class ExpiryLRUMap<K,V>
extends AbstractMap<K,V>
implements ConcurrentMap<K,V>

定时过期Map 会自动过期删除

支持项 ： 1.定时过期(过期事件通知) setOnExpiryConsumer(Consumer) onExpiry(Node) 2. LRU淘汰机制(淘汰事件通知) setOnEvictionConsumer(Consumer) onEviction(Node) 3. Map操作 4. 并发操作(线程安全) ConcurrentMap 5. gc回收 Reference(Weak,Soft,strong). ExpiryLRUMap(int, long, long, ConcurrentLinkedHashMap.Weigher, Class) 6. 统计功能(miss, hit) getHitCount() getMissCount() 7. null值替换, 防止缓存击穿 setReplaceNullValueFlag(boolean) NULL if(data == ExpiryLRUMap.NULL)

常用场景 ： localCache

作者:

wangzihao

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	ExpiryLRUMap.ExpiresNotify
static class	ExpiryLRUMap.ExpiresScan
static class	ExpiryLRUMap.Node<KEY,VALUE>

从类继承的嵌套类/接口 java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

从接口继承的嵌套类/接口 java.util.Map

Map.Entry<K,V>

字段概要

字段

限定符和类型	字段和说明
static Object	NULL

构造器概要

构造器

构造器和说明
ExpiryLRUMap() 默认永不过期 (相当于普通的 ConcurrentMap)
ExpiryLRUMap(int initialCapacity, long maxCacheSize, long defaultExpiryTime, ConcurrentLinkedHashMap.Weigher<ExpiryLRUMap.Node<K,V>> weigher)
ExpiryLRUMap(int initialCapacity, long maxCacheSize, long defaultExpiryTime, ConcurrentLinkedHashMap.Weigher<ExpiryLRUMap.Node<K,V>> weigher, Class<? extends Reference> referenceType)
ExpiryLRUMap(long defaultExpiryTime)

方法概要

限定符和类型	方法和说明
V	atomicGet(K key, Supplier<V> supplier)
void	clear()
V	compute(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
V	computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction)
V	computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<K,V>>	entrySet()
boolean	equals(Object o)
void	forEach(BiConsumer<? super K,? super V> action)
V	get(Object key)
long	getDefaultExpiryTime()
static BlockingQueue<ExpiryLRUMap.Node<?,?>>	getExpiryNotifyQueue()
long	getHitCount()
static Set<ExpiryLRUMap>	getInstanceSet()
long	getMaxCacheSize()
long	getMissCount()
Consumer<ExpiryLRUMap.Node<K,V>>	getOnEvictionConsumer()
Consumer<ExpiryLRUMap.Node<K,V>>	getOnExpiryConsumer()
V	getOrDefault(Object key, V defaultValue)
int	hashCode()
boolean	isEmpty()
static boolean	isExpiry(ExpiryLRUMap.Node node)
boolean	isReplaceNullValueFlag()
Set<K>	keySet()
static void	main(String[] args)
V	merge(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction)
void	notifyRemove(ExpiryLRUMap.Node<K,V> node)
void	onEviction(ExpiryLRUMap.Node<K,V> node)
void	onExpiry(ExpiryLRUMap.Node<K,V> node)
void	onRemove(ExpiryLRUMap.Node<K,V> node)
V	put(K key, V value)
V	put(K key, V value, long timeout)
V	putIfAbsent(K key, V value)
V	remove(Object key)
boolean	remove(Object key, Object value)
V	replace(K key, V newValue)
boolean	replace(K key, V oldValue, V newValue)
void	replaceAll(BiFunction<? super K,? super V,? extends V> function)
void	setDefaultExpiryTime(long defaultExpiryTime)
void	setMaxCacheSize(long maxCacheSize)
void	setOnEvictionConsumer(Consumer<ExpiryLRUMap.Node<K,V>> onEvictionConsumer)
void	setOnExpiryConsumer(Consumer<ExpiryLRUMap.Node<K,V>> onExpiryConsumer)
void	setOnRemoveConsumer(Consumer<ExpiryLRUMap.Node<K,V>> onRemoveConsumer)
void	setReplaceNullValueFlag(boolean replaceNullValueFlag)
int	size()
String	toString()
Collection<V>	values()
long	weightedSize()

从类继承的方法 java.util.AbstractMap

putAll

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

getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 java.util.Map

putAll

字段详细资料

NULL

public static final Object NULL

构造器详细资料

ExpiryLRUMap

public ExpiryLRUMap()

默认永不过期 (相当于普通的 ConcurrentMap)

ExpiryLRUMap

public ExpiryLRUMap(long defaultExpiryTime)

ExpiryLRUMap

public ExpiryLRUMap(int initialCapacity,
                    long maxCacheSize,
                    long defaultExpiryTime,
                    ConcurrentLinkedHashMap.Weigher<ExpiryLRUMap.Node<K,V>> weigher)

ExpiryLRUMap

public ExpiryLRUMap(int initialCapacity,
                    long maxCacheSize,
                    long defaultExpiryTime,
                    ConcurrentLinkedHashMap.Weigher<ExpiryLRUMap.Node<K,V>> weigher,
                    Class<? extends Reference> referenceType)

参数:

initialCapacity - initialCapacity

maxCacheSize - maxCacheSize

defaultExpiryTime - defaultExpiryTime

weigher - weigher

referenceType - null is FinalReference. else if WeakReference else if SoftReference

方法详细资料

getInstanceSet

public static Set<ExpiryLRUMap> getInstanceSet()

getExpiryNotifyQueue

public static BlockingQueue<ExpiryLRUMap.Node<?,?>> getExpiryNotifyQueue()

isExpiry

public static boolean isExpiry(ExpiryLRUMap.Node node)

main

public static void main(String[] args)
                 throws InterruptedException

抛出:

InterruptedException

weightedSize

public long weightedSize()

getMaxCacheSize

public long getMaxCacheSize()

setMaxCacheSize

public void setMaxCacheSize(long maxCacheSize)

getOnEvictionConsumer

public Consumer<ExpiryLRUMap.Node<K,V>> getOnEvictionConsumer()

setOnEvictionConsumer

public void setOnEvictionConsumer(Consumer<ExpiryLRUMap.Node<K,V>> onEvictionConsumer)

getMissCount

public long getMissCount()

getHitCount

public long getHitCount()

getOnExpiryConsumer

public Consumer<ExpiryLRUMap.Node<K,V>> getOnExpiryConsumer()

setOnExpiryConsumer

public void setOnExpiryConsumer(Consumer<ExpiryLRUMap.Node<K,V>> onExpiryConsumer)

setOnRemoveConsumer

public void setOnRemoveConsumer(Consumer<ExpiryLRUMap.Node<K,V>> onRemoveConsumer)

isReplaceNullValueFlag

public boolean isReplaceNullValueFlag()

setReplaceNullValueFlag

public void setReplaceNullValueFlag(boolean replaceNullValueFlag)

put

public V put(K key,
             V value)

指定者:

put 在接口中 Map<K,V>

覆盖:

put 在类中 AbstractMap<K,V>

put

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

参数:

key - key

value - value

timeout - 键值对有效期 毫秒(Long.MAX_VALUE 表示永不过期)

返回:

旧值

containsKey

public boolean containsKey(Object key)

指定者:

containsKey 在接口中 Map<K,V>

覆盖:

containsKey 在类中 AbstractMap<K,V>

size

public int size()

指定者:

size 在接口中 Map<K,V>

覆盖:

size 在类中 AbstractMap<K,V>

isEmpty

public boolean isEmpty()

指定者:

isEmpty 在接口中 Map<K,V>

覆盖:

isEmpty 在类中 AbstractMap<K,V>

containsValue

public boolean containsValue(Object value)

指定者:

containsValue 在接口中 Map<K,V>

覆盖:

containsValue 在类中 AbstractMap<K,V>

remove

public V remove(Object key)

指定者:

remove 在接口中 Map<K,V>

覆盖:

remove 在类中 AbstractMap<K,V>

notifyRemove

public void notifyRemove(ExpiryLRUMap.Node<K,V> node)

atomicGet

public V atomicGet(K key,
                   Supplier<V> supplier)

get

public V get(Object key)

指定者:

get 在接口中 Map<K,V>

覆盖:

get 在类中 AbstractMap<K,V>

keySet

public Set<K> keySet()

指定者:

keySet 在接口中 Map<K,V>

覆盖:

keySet 在类中 AbstractMap<K,V>

clear

public void clear()

指定者:

clear 在接口中 Map<K,V>

覆盖:

clear 在类中 AbstractMap<K,V>

values

public Collection<V> values()

指定者:

values 在接口中 Map<K,V>

覆盖:

values 在类中 AbstractMap<K,V>

entrySet

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

指定者:

entrySet 在接口中 Map<K,V>

指定者:

entrySet 在类中 AbstractMap<K,V>

getOrDefault

public V getOrDefault(Object key,
                      V defaultValue)

指定者:

getOrDefault 在接口中 ConcurrentMap<K,V>

指定者:

getOrDefault 在接口中 Map<K,V>

forEach

public void forEach(BiConsumer<? super K,? super V> action)

指定者:

forEach 在接口中 ConcurrentMap<K,V>

指定者:

forEach 在接口中 Map<K,V>

remove

public boolean remove(Object key,
                      Object value)

指定者:

remove 在接口中 ConcurrentMap<K,V>

指定者:

remove 在接口中 Map<K,V>

replace

public V replace(K key,
                 V newValue)

指定者:

replace 在接口中 ConcurrentMap<K,V>

指定者:

replace 在接口中 Map<K,V>

replace

public boolean replace(K key,
                       V oldValue,
                       V newValue)

指定者:

replace 在接口中 ConcurrentMap<K,V>

指定者:

replace 在接口中 Map<K,V>

replaceAll

public void replaceAll(BiFunction<? super K,? super V,? extends V> function)

指定者:

replaceAll 在接口中 ConcurrentMap<K,V>

指定者:

replaceAll 在接口中 Map<K,V>

computeIfAbsent

public V computeIfAbsent(K key,
                         Function<? super K,? extends V> mappingFunction)

指定者:

computeIfAbsent 在接口中 ConcurrentMap<K,V>

指定者:

computeIfAbsent 在接口中 Map<K,V>

computeIfPresent

public V computeIfPresent(K key,
                          BiFunction<? super K,? super V,? extends V> remappingFunction)

指定者:

computeIfPresent 在接口中 ConcurrentMap<K,V>

指定者:

computeIfPresent 在接口中 Map<K,V>

compute

public V compute(K key,
                 BiFunction<? super K,? super V,? extends V> remappingFunction)

指定者:

compute 在接口中 ConcurrentMap<K,V>

指定者:

compute 在接口中 Map<K,V>

merge

public V merge(K key,
               V value,
               BiFunction<? super V,? super V,? extends V> remappingFunction)

指定者:

merge 在接口中 ConcurrentMap<K,V>

指定者:

merge 在接口中 Map<K,V>

putIfAbsent

public V putIfAbsent(K key,
                     V value)

指定者:

putIfAbsent 在接口中 ConcurrentMap<K,V>

指定者:

putIfAbsent 在接口中 Map<K,V>

getDefaultExpiryTime

public long getDefaultExpiryTime()

setDefaultExpiryTime

public void setDefaultExpiryTime(long defaultExpiryTime)

toString

public String toString()

覆盖:

toString 在类中 AbstractMap<K,V>

onExpiry

public void onExpiry(ExpiryLRUMap.Node<K,V> node)

onEviction

public void onEviction(ExpiryLRUMap.Node<K,V> node)

onRemove

public void onRemove(ExpiryLRUMap.Node<K,V> node)

equals

public boolean equals(Object o)

指定者:

equals 在接口中 Map<K,V>

覆盖:

equals 在类中 AbstractMap<K,V>

hashCode

public int hashCode()

指定者:

hashCode 在接口中 Map<K,V>

覆盖:

hashCode 在类中 AbstractMap<K,V>