LinkedHashMap 的理解以及借助其实现LRU

LinkedHashMap 的理解以及借助其实现LRU

LinkedHashMap中有一个参数 accessOrder，这个参数定义了LinkedHashMap的访问顺序。

LinkedHashMap中继承了Node，给Node新增了2个新的属性before和after

static class Entry<K,V> extends HashMap.Node<K,V> {
    Entry<K,V> before, after;
    Entry(int hash, K key, V value, Node<K,V> next) {
        super(hash, key, value, next);
    }
}

put方法

put方法LinkedHashMap没有重写，使用的是HashMap的put,但是其中还是有不同，重写了其中几个方法，先看代码：

final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
               boolean evict) {
    Node<K,V>[] tab; Node<K,V> p; int n, i;
    if ((tab = table) == null || (n = tab.length) == 0)
        n = (tab = resize()).length;
    if ((p = tab[i = (n - 1) & hash]) == null)
		//重写newNode方法
        tab[i] = newNode(hash, key, value, null);
    else {
        Node<K,V> e; K k;
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            e = p;
        else if (p instanceof TreeNode)
            e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
        else {
            for (int binCount = 0; ; ++binCount) {
                if ((e = p.next) == null) {
					//重写newNode方法
                    p.next = newNode(hash, key, value, null);
                    if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                        treeifyBin(tab, hash);
                    break;
                }
                if (e.hash == hash &&
                    ((k = e.key) == key || (key != null && key.equals(k))))
                    break;
                p = e;
            }
        }
        if (e != null) { // existing mapping for key
            V oldValue = e.value;
            if (!onlyIfAbsent || oldValue == null)
                e.value = value;
			//重写afterNodeAccess
            afterNodeAccess(e);
            return oldValue;
        }
    }
    ++modCount;
    if (++size > threshold)
        resize();
	//重写afterNodeInsertion
    afterNodeInsertion(evict);
    return null;
}

看下重写的这几个方法：

newNode方法:

实现了每调用一次newNode方法，利用before和after节点可把新节点插入到队尾。保证了一种调用newNode的顺序。

Node<K,V> newNode(int hash, K key, V value, Node<K,V> e) {
    LinkedHashMap.Entry<K,V> p =
        new LinkedHashMap.Entry<K,V>(hash, key, value, e);
    linkNodeLast(p);
    return p;
}


private void linkNodeLast(LinkedHashMap.Entry<K,V> p) {
    LinkedHashMap.Entry<K,V> last = tail;
    tail = p;
    if (last == null)
        head = p;
    else {
        p.before = last;
        last.after = p;
    }
}

afterNodeAccess方法：

在put一个已存在的key时且 accessOrder 为true 时会调用，此方法会这个节点放到队伍的最后。

void afterNodeAccess(Node<K,V> e) { // move node to last
    LinkedHashMap.Entry<K,V> last;
    if (accessOrder && (last = tail) != e) {
        LinkedHashMap.Entry<K,V> p =
            (LinkedHashMap.Entry<K,V>)e, b = p.before, a = p.after;
        p.after = null;
        if (b == null)
            head = a;
        else
            b.after = a;
        if (a != null)
            a.before = b;
        else
            last = b;
        if (last == null)
            head = p;
        else {
            p.before = last;
            last.after = p;
        }
        tail = p;
        ++modCount;
    }
}

afterNodeInsertion方法

有新的Node时会调用，默认removeEldestEntry返回false,所以这一个方法什么都不做。不过可以看下如果返回不是false，则会删除head节点。这也是实现LRU的一个基础。

void afterNodeInsertion(boolean evict) { // possibly remove eldest
    LinkedHashMap.Entry<K,V> first;
    if (evict && (first = head) != null && removeEldestEntry(first)) {
        K key = first.key;
        removeNode(hash(key), key, null, false, true);
    }
}

protected boolean removeEldestEntry(Map.Entry<K,V> eldest) {
    return false;
}

get方法

get方法 会在accessOrder为true时把这个节点放到以before ,after为基础的一个双向链表的队尾。

public V get(Object key) {
    Node<K,V> e;
    if ((e = getNode(hash(key), key)) == null)
        return null;
    if (accessOrder)
        afterNodeAccess(e);
    return e.value;
}

foreach,keySet,entrySet遍历方法

所有的遍历在LinkedHashMap里都会重写，都是按照以before ,after为基础的一个双向链表的顺序进行遍历。

accessOrder变量

从上面的get和put过程可以发现，access为false时,则双向链表会变成一个按照插入顺序的链表。如果为true,则会变成按照访问顺序的一个链表。

如何借助LinkedHashMap来实现LRU

上面看到有一个方法removeEldestEntry，默认返回false，这个方法，顾名思义就是删除双向链表最开头的头部节点。

所以要实现LRU,只需要这样即可：

传入accessOrder为true,重写removeEldestEntry，根据缓存目标设置的size来决定在达到多少时来进行remove。

class LRU<K,V> extends LinkedHashMap<K, V>{
	public LRU(int initialCapacity,
            float loadFactor,
            boolean accessOrder) {
		super(initialCapacity,loadFactor,accessOrder);
	}
	
	@Override
	protected boolean removeEldestEntry(java.util.Map.Entry<K, V> eldest) {
		if (this.size()>4) {
			return true;
		}
		return super.removeEldestEntry(eldest);
	}


}