【数据结构与算法】LRU cache

LRUCace

least recently used cache，使用最近最少使用淘汰策略的缓存。
put和get操作都会更新缓存的时间戳。

可以基于时间戳实现。但是java里面有现成的实现：linkedHashMap。

除了map接口的api，该类内部有一个指针，按照插入顺序链接起来。当然我们可以指定参数accessOrder为true，来让map把刚get过的key移至链表尾部。默认是false的，即get不改变优先级。如果要淘汰，链表的第一个元素就是要淘汰的。

实现：

public class LRUCache {

    LinkedHashMap<Integer, Integer> cache;
    int capacity;

    public static void main(String args[]){
        LRUCache cache = new LRUCache(2);
        cache.put(1,1);
        cache.put(2,2);
        cache.get(1);
        cache.put(3,3);
        System.out.println(cache.get(2));
        System.out.println(cache.cache.size());
    }

    public LRUCache(int capacity) {
        this.cache = new LinkedHashMap<Integer, Integer>(capacity, 0.75f, true){
            protected boolean removeEldestEntry(Map.Entry<Integer, Integer> eldest) {
                return this.size() > capacity;
            }
        };
        this.capacity = capacity;
    }

    public int get(int key) {
        return cache.getOrDefault(key, -1);
    }

    public void put(int key, int value) {
        cache.put(key, value);
    }
}

这里借鉴了leetcode的代码。几个关键点：
1）LinkedHashMap构造器
这里因为需要考虑读取改变优先级，所以需要启动accessOrder=true的参数，那么LinkedHashMap就必须使用3个参数的构造器。
LinkedHashMap重写了get相关方法，加入了afterNodeAccess钩子函数。如果accessOrder==true，就调用，会把该entry移至链表尾部。
 

    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;
    }

    /**
     * {@inheritDoc}
     */
    public V getOrDefault(Object key, V defaultValue) {
       Node<K,V> e;
       if ((e = getNode(hash(key), key)) == null)
           return defaultValue;
       if (accessOrder)
           afterNodeAccess(e);
       return e.value;
   }
    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;
        }
    }

2）匿名内部类
该内部类其实是LinkedHashMap的子类，重写了removeEldestEntry方法。这个方法在原本的LinkedHashMap内是直接返回false的。
 

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

该方法用于指定淘汰的条件。默认不淘汰。
该方法会在每一次put后面被调用。

    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);
        }
    }

那我们的淘汰逻辑就可以在这个方法内部完成。比方说上面的例子。

3）put代码
每一次put都会覆盖以前的节点或者new新节点。无论哪种都要更新优先级。

先看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)
            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) {
                        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(e);
                return oldValue;
            }
        }
        ++modCount;
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
    }

新的node，在hashMap基类里，如果发现没有key，就会调用newNode方法创建，linkedHashMap重写了该方法：

    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;
    }
    // link at the end of list
    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;
        }
    }

所以，新建node是可以更新优先级的。

对于已有的key，在hashMap里走到afterNodeAccess方法，这个方法前面见过，在get方法里面有，也会更新节点的优先级，所以对于有key的优先级更新就和get是一样的逻辑了。均在afterNodeAccess方法内完成。所以如果accessOrder为false，那么对于已有key的put将不会改变优先级。比如：

        LRUCache cache = new LRUCache(2);
        cache.put(1,1);
        cache.put(2,2);
        cache.put(1,22);
        cache.put(3,3);
        System.out.println(cache.get(1));

key=1的entry将会被淘汰，输出为-1。

 

当然还有其他的不借助linkedHashMap的方式，比方说下面的hashMap+双向链表的方式。