Android緩存機制-LRU cache原理與用法

在使用Android圖片加載框架時，常常會提到三級緩存，其中主要的是內存緩存和文件緩存。 兩個緩存都是用到了LruCache算法，在Android分別對應：LruCache和DiskLruCache。

LRU算法

操做系統中進行內存管理中時採用一些頁面置換算法，如LRU、LFU和FIFO等。
其中LRU(Least recently used,最近最少使用)算法，核心思想是當緩存達到上限時，會先淘汰最近最少使用的緩存。這樣能夠保證緩存處於一種可控的狀態,有效的防止OOM的出現。

LruCache用法

LruCache是從Android3.1開始支持，目前已經在androidx.collection支持。

初始化

LruCache初始化:

int maxCache = (int) (Runtime.getRuntime().maxMemory() / 1024);
//初始化大小:內存的1/8
int cacheSize = maxCache / 8;
memorySize = new LruCache<String, Bitmap>(512) {
    @Override
    protected int sizeOf(String key, Bitmap value) {
        //重寫該方法,計算每張要緩存的圖片大小
        return value.getByteCount() / 1024;
    }
};
複製代碼

方法

LruCache結構圖

方法	描述
get(K)	經過K獲取緩存
put(K,V)	設置K的值爲V
remove(K)	刪除K緩存
evictAll()	清除緩存
resize(int)	設置最大緩存大小
snapshot()	獲取緩存內容的鏡像

LruCache實現原理

LruCache初始化只要聲明 new LruCache(maxSize)，這個過程主要作了那些功能，看源碼：

public LruCache(int maxSize) {
    if (maxSize <= 0) {
        throw new IllegalArgumentException("maxSize <= 0");
    }
    //聲明最大緩存大小
    this.maxSize = maxSize;
    //重點,LinkedHashMap,LruCache的實現依賴
    this.map = new LinkedHashMap<K, V>(0, 0.75f, true);
}
複製代碼

LruCache核心思想就是淘汰最近最少使用的緩存，須要維護一個緩存對象列表，排列方式按照訪問順序實現。
把最近訪問過的對象放在隊頭，未訪問的對象放在隊尾，當前列表達到上限的時候，優先會淘汰隊尾的對象。
如圖(盜用下圖片)：

在Java中， LinkedHashMap比較適合實現這種算法。

LinkedHashMap

LinkedHashMap是一個關聯數組、哈希表，它是線程不安全的,繼承自HashMap，實現Map<K,V>接口。
內部維護了一個雙向鏈表，在插入數據、訪問，修改數據時，會增長節點、或調整鏈表的節點順序，雙向鏈表結構能夠實現插入順序或者訪問順序。 在LruCache初始化定義了this.map = new LinkedHashMap<K, V>(0, 0.75f, true) 。
LinkedHashMap的構造函數：

public LinkedHashMap(int initialCapacity, float loadFactor, boolean accessOrder) {
    super(initialCapacity, loadFactor);
    this.accessOrder = accessOrder;
}
複製代碼

布爾變量accessOrder定義了輸出的順序，true爲按照訪問順序，false爲按照插入順序。 accessOrder設置爲true正好知足LRU算法的核心思想。

LruCache源碼分析

既然LruCache底層使用LinkedHashMap，下面咱們來看看它怎麼實現緩存的操做的。 源碼分析是在Android API 28版本，

put

public final V put(K key, V value) {
    if (key == null || value == null) {
        throw new NullPointerException("key == null || value == null");
    }

    V previous;
    synchronized (this) {
        putCount++;
        //增長緩存大小
        size += safeSizeOf(key, value);
        //使用LinkedHashMap的put方法
        previous = map.put(key, value);
        if (previous != null) {
            //若是previous存在，減小對應緩存大小
            size -= safeSizeOf(key, previous);
        }
    }

    if (previous != null) {
        entryRemoved(false, key, previous, value);
    }

    //檢查緩存大小，刪除最近最少使用的緩存
    trimToSize(maxSize);
    return previous;
}
複製代碼

put方法主要是添加緩存對象後，調用trimToSize方法，保證緩存大小，刪除最近最少使用的緩存。具體的添加緩存，經過LinkedHashMapput方法實現。 LinkedHashMap繼承自HashMap，沒有重寫put方法，調用的是HashMap的put方法，在HashMap的putVal方法中有調用建立新節點的newNode方法，LinkedHashMap重寫了該方法。

Node<K,V> newNode(int hash, K key, V value, Node<K,V> e) {
    LinkedHashMapEntry<K,V> p =
        new LinkedHashMapEntry<K,V>(hash, key, value, e);
    linkNodeLast(p);
    return p;
}
// link at the end of list
private void linkNodeLast(LinkedHashMapEntry<K,V> p) {
    LinkedHashMapEntry<K,V> last = tail;
    tail = p;
    if (last == null)
        head = p;
    else {
        p.before = last;
        last.after = p;
    }
}
複製代碼

其中LinkedHashMapEntry定義：

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

/** * The head (eldest) of the doubly linked list. */
transient LinkedHashMap.Entry<K,V> head;

/** * The tail (youngest) of the doubly linked list. */
transient LinkedHashMap.Entry<K,V> tail;
複製代碼

LinkedHashMapEntry用來存儲數據，定義了before,after顯示上一個元素和下一個元素。
下面的操做：

LinkedHashMap<Integer, Integer> map = new LinkedHashMap<>(10, 0.75f, true);
map.put(1,1);
複製代碼

再執行 map.put(2,2)

繼續執行 map.put(3,3)

若是put了相同key的話，會作什麼操做。這個一塊兒放到get方法中講解。

get

public final V get(K key) {
    if (key == null) {
        throw new NullPointerException("key == null");
    }

    V mapValue;
    synchronized (this) {
        mapValue = map.get(key);
        if (mapValue != null) {
            hitCount++;
            return mapValue;
        }
        missCount++;
    }

    //基本不會執行到這裏,除了重寫create方法
    /* * Attempt to create a value. This may take a long time, and the map * may be different when create() returns. If a conflicting value was * added to the map while create() was working, we leave that value in * the map and release the created value. */

    V createdValue = create(key);
    if (createdValue == null) {
        return null;
    }

    synchronized (this) {
        createCount++;
        mapValue = map.put(key, createdValue);

        if (mapValue != null) {
            // There was a conflict so undo that last put
            map.put(key, mapValue);
        } else {
            size += safeSizeOf(key, createdValue);
        }
    }

    if (mapValue != null) {
        entryRemoved(false, key, createdValue, mapValue);
        return mapValue;
    } else {
        trimToSize(maxSize);
        return createdValue;
    }
}
複製代碼

這裏主要就是調用LinkedHashMap的get方法。 LinkedHashMap的get方法：

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;
}
複製代碼

afterNodeAccess方法：

void afterNodeAccess(Node<K,V> e) { // move node to last
    LinkedHashMapEntry<K,V> last;
    if (accessOrder && (last = tail) != e) {
        LinkedHashMapEntry<K,V> p =
            (LinkedHashMapEntry<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;
    }
}
複製代碼

afterNodeAccess方法會將當前被訪問的節點e，移動到內部雙向鏈表的尾部。 在put方法，map已經有三個數據。 如今操做map.get(1)，具體的邏輯在afterNodeAccess方法，看下每步操做後值的變化。

if (accessOrder && (last = tail) != e) {
        LinkedHashMapEntry<K,V> p =
            (LinkedHashMapEntry<K,V>)e, b = p.before, a = p.after;
        p.after = null;
        ...
}        
複製代碼

變量	值	before	after
head	1	null	2
tail	3	2	null
last	(tail)3	2	null
p	1	null	null
b	null
a	2	1	3

if (b == null)
    head = a;
else
    b.after = a;
if (a != null)
    a.before = b;
else
    last = b;
複製代碼

變量	值	before	after
head	(a)2	null	3
tail	3	2	null
last	3	2	null
p	1	null	null
b	null
a	2	null	3

if (last == null)
    head = p;
else {
    p.before = last;
    last.after = p;
}
tail = p;
複製代碼

變量	值	before	after
head	2	null	3
tail	1	3	null
last	3	2	(p)1
p	1	(last)3	null
b	null
a	2	null	3

最後的操做結果:

trimToSize

get和put方法都會調用到

public void trimToSize(int maxSize) {
    while (true) {
        K key;
        V value;
        synchronized (this) {
            if (size < 0 || (map.isEmpty() && size != 0)) {
                throw new IllegalStateException(getClass().getName()
                        + ".sizeOf() is reporting inconsistent results!");
            }

            if (size <= maxSize || map.isEmpty()) {
                break;
            }

            Map.Entry<K, V> toEvict = map.entrySet().iterator().next();
            key = toEvict.getKey();
            value = toEvict.getValue();
            map.remove(key);
            size -= safeSizeOf(key, value);
            evictionCount++;
        }

        entryRemoved(true, key, value, null);
    }
}
複製代碼

當map的size大於maxSize，會一直循環刪除最近最少使用的緩存對象，直到緩存大小小於 maxSize。

以上就是LruCache基本原理，理解了LinkedHashMap,能夠更加輕鬆地理解LruCache原理。
DiskLruCache內部實現也有一部分基於LinkedHashMap。

參考

• LruCache
• 完全解析Android緩存機制——LruCache
• LruCache原理和用法與LinkedHashMap
• Android DiskLruCache徹底解析，硬盤緩存的最佳方案
• Android 三大圖片緩存原理、特性對比