基于LinkedHashMap实现LRU缓存调度算法原理及应用

 在Android中实用LRU+软引用（弱引用）的方法来缓存图片，可以减少内存溢出的情况。

实现思路：

在把图片保存到LRU集合中的时候，同时保存在一个弱引用的集合之中，如果此元素被LRU算法删除，可能垃圾回收器还并没有回收，可以通过弱引用的集合获取到此引用。

public LinkedHashMap (int initialCapacity, float loadFactor, boolean accessOrder)；

 initialCapacity   初始容量

 loadFactor    加载因子，一般是 0.75f

 accessOrder   false 基于插入顺序  true  基于访问顺序（get一个元素后，这个元素被加到最后，使用了LRU  最近最少被使用的调度算法）

当有新元素加入Map的时候会调用Entry的addEntry方法，会调用removeEldestEntry方法，这里就是实现LRU元素过期机制的地方，默认的情况下removeEldestEntry方法只返回false表示元素永远不过期。 

如 boolean accessOrder = true；       Map<String, String> m = new LinkedHashMap<String, String>(20, .80f,  accessOrder  );      m.put("1", "my"));

      m.put("2", "map"));

      m.put("3", "test"));

      m.get("1");

      m.get("2");

      Log.d("tag",  m);

     若 accessOrder == true;  输出 {3=test, 1=my, 2=map}

         accessOrder == false;  输出 {1=my, 2=map，3=test}

LinkedHashMap已经为我们自己实现LRU算法提供了便利。 
LinkedHashMap继承了HashMap底层是通过Hash表+单向链表实现Hash算法，内部自己维护了一套元素访问顺序的列表。 
Java代码  

1. /** 
2.   * The head of the doubly linked list. 
3.   */  
4.  private transient Entry<K,V> header;  
5.  .....  
6. /** 
7.   * LinkedHashMap entry. 
8.   */  
9.  private static class Entry<K,V> extends HashMap.Entry<K,V> {  
10.      // These fields comprise the doubly linked list used for iteration.  
11.      Entry<K,V> before, after;  

HashMap构造函数中回调了子类的init方法实现对元素初始化 
Java代码  

1. void init() {  
2.     header = new Entry<K,V>(-1, null, null, null);  
3.     header.before = header.after = header;  
4. }  

LinkedHashMap中有一个属性可以执行列表元素的排序算法 
Java代码  

1. /** 
2.   * The iteration ordering method for this linked hash map: <tt>true</tt> 
3.   * for access-order, <tt>false</tt> for insertion-order. 
4.   * 
5.   * @serial 
6.   */  
7.  private final boolean accessOrder;  

注释已经写的很明白，accessOrder为true使用访问顺序排序，false使用插入顺序排序那么在哪里可以设置这个值。 
Java代码  

1. /** 
2.   * Constructs an empty <tt>LinkedHashMap</tt> instance with the 
3.   * specified initial capacity, load factor and ordering mode. 
4.   * 
5.   * @param  initialCapacity the initial capacity. 
6.   * @param  loadFactor      the load factor. 
7.   * @param  accessOrder     the ordering mode - <tt>true</tt> for 
8.   *         access-order, <tt>false</tt> for insertion-order. 
9.   * @throws IllegalArgumentException if the initial capacity is negative 
10.   *         or the load factor is nonpositive. 
11.   */  
12.  public LinkedHashMap(int initialCapacity,  
13.  float loadFactor,  
14.                       boolean accessOrder) {  
15.      super(initialCapacity, loadFactor);  
16.      this.accessOrder = accessOrder;  
17.  }  

那么我们就行有访问顺序排序方式实现LRU,那么哪里LinkedHashMap是如何实现LRU的呢？ 
Java代码  

1.    //LinkedHashMap方法  
2.    public V get(Object key) {  
3.        Entry<K,V> e = (Entry<K,V>)getEntry(key);  
4.        if (e == null)  
5.            return null;  
6.        e.recordAccess(this);  
7.        return e.value;  
8.    }  
9.    //HashMap方法  
10.    public V put(K key, V value) {  
11. if (key == null)  
12.     return putForNullKey(value);  
13.        int hash = hash(key.hashCode());  
14.        int i = indexFor(hash, table.length);  
15.        for (Entry<K,V> e = table[i]; e != null; e = e.next) {  
16.            Object k;  
17.            if (e.hash == hash && ((k = e.key) == key || key.equals(k))) {  
18.                V oldValue = e.value;  
19.                e.value = value;  
20.                e.recordAccess(this);  
21.                return oldValue;  
22.            }  
23.        }  
24.   
25.        modCount++;  
26.        addEntry(hash, key, value, i);  
27.        return null;  
28.    }  

当调用get或者put方法的时候，如果K-V已经存在，会回调Entry.recordAccess()方法 
我们再看一下LinkedHashMap的Entry实现 
Java代码  

1. /** 
2.   * This method is invoked by the superclass whenever the value 
3.   * of a pre-existing entry is read by Map.get or modified by Map.set. 
4.   * If the enclosing Map is access-ordered, it moves the entry 
5.   * to the end of the list; otherwise, it does nothing.  
6.   */  
7.  void recordAccess(HashMap<K,V> m) {  
8.      LinkedHashMap<K,V> lm = (LinkedHashMap<K,V>)m;  
9.      if (lm.accessOrder) {  
10.          lm.modCount++;  
11.          remove();  
12.          addBefore(lm.header);  
13.      }  
14.  }  
15.   
16.  /** 
17.   * Remove this entry from the linked list. 
18.   */  
19.  private void remove() {  
20.      before.after = after;  
21.      after.before = before;  
22.  }  
23.   
24.  /**                                              
25.   * Insert this entry before the specified existing entry in the list. 
26.   */  
27.  private void addBefore(Entry<K,V> existingEntry) {  
28.      after  = existingEntry;  
29.      before = existingEntry.before;  
30.      before.after = this;  
31.      after.before = this;  
32.  }  

recordAccess方法会accessOrder为true会先调用remove清楚的当前首尾元素的指向关系，之后调用addBefore方法，将当前元素加入header之前。 

当有新元素加入Map的时候会调用Entry的addEntry方法，会调用removeEldestEntry方法，这里就是实现LRU元素过期机制的地方，默认的情况下removeEldestEntry方法只返回false表示元素永远不过期。 
Java代码  

1.   /** 
2.     * This override alters behavior of superclass put method. It causes newly 
3.     * allocated entry to get inserted at the end of the linked list and 
4.     * removes the eldest entry if appropriate. 
5.     */  
6.    void addEntry(int hash, K key, V value, int bucketIndex) {  
7.        createEntry(hash, key, value, bucketIndex);  
8.   
9.        // Remove eldest entry if instructed, else grow capacity if appropriate  
10.        Entry<K,V> eldest = header.after;  
11.        if (removeEldestEntry(eldest)) {  
12.            removeEntryForKey(eldest.key);  
13.        } else {  
14.            if (size >= threshold)   
15.                resize(2 * table.length);  
16.        }  
17.    }  
18.   
19.    /** 
20.     * This override differs from addEntry in that it doesn't resize the 
21.     * table or remove the eldest entry. 
22.     */  
23.    void createEntry(int hash, K key, V value, int bucketIndex) {  
24.        HashMap.Entry<K,V> old = table[bucketIndex];  
25. Entry<K,V> e = new Entry<K,V>(hash, key, value, old);  
26.        table[bucketIndex] = e;  
27.        e.addBefore(header);  
28.        size++;  
29.    }  
30.   
31.    protected boolean removeEldestEntry(Map.Entry<K,V> eldest) {  
32.        return false;  
33.    }  

基本的原理已经介绍完了，那基于LinkedHashMap我们看一下是该如何实现呢？ 
Java代码  

1. public static class LRULinkedHashMap<K, V> extends LinkedHashMap<K, V> {  
2.   
3.         /** serialVersionUID */  
4.         private static final long serialVersionUID = -5933045562735378538L;  
5.   
6.         /** 最大数据存储容量 */  
7.         private static final int  LRU_MAX_CAPACITY     = 1024;  
8.   
9.         /** 存储数据容量  */  
10.         private int               capacity;  
11.   
12.         /** 
13.          * 默认构造方法 
14.          */  
15.         public LRULinkedHashMap() {  
16.             super();  
17.         }  
18.   
19.         /** 
20.          * 带参数构造方法 
21.          * @param initialCapacity   容量 
22.          * @param loadFactor        装载因子 
23.          * @param isLRU             是否使用lru算法，true：使用（按方案顺序排序）;false：不使用（按存储顺序排序） 
24.          */  
25.         public LRULinkedHashMap(int initialCapacity, float loadFactor, boolean isLRU) {  
26.             super(initialCapacity, loadFactor, true);  
27.             capacity = LRU_MAX_CAPACITY;  
28.         }  
29.   
30.         /** 
31.          * 带参数构造方法 
32.          * @param initialCapacity   容量 
33.          * @param loadFactor        装载因子 
34.          * @param isLRU             是否使用lru算法，true：使用（按方案顺序排序）;false：不使用（按存储顺序排序） 
35.          * @param lruCapacity       lru存储数据容量        
36.          */  
37.         public LRULinkedHashMap(int initialCapacity, float loadFactor, boolean isLRU, int lruCapacity) {  
38.             super(initialCapacity, loadFactor, true);  
39.             this.capacity = lruCapacity;  
40.         }  
41.   
42.         /**  
43.          * @see java.util.LinkedHashMap#removeEldestEntry(java.util.Map.Entry) 
44.          */  
45.         @Override  
46.         protected boolean removeEldestEntry(Entry<K, V> eldest) {  
47.             System.out.println(eldest.getKey() + "=" + eldest.getValue());  
48.               
49.             if(size() > capacity) {  
50.                 return true;  
51.             }  
52.             return false;  
53.         }  
54.     }  

测试代码： 
Java代码  

1. public static void main(String[] args) {  
2.   
3.     LinkedHashMap<String, String> map = new LRULinkedHashMap<String, String>(16, 0.75f, true);  
4.     map.put("a", "a"); //a  a  
5.     map.put("b", "b"); //a  a b  
6.     map.put("c", "c"); //a  a b c  
7.     map.put("a", "a"); //   b c a       
8.     map.put("d", "d"); //b  b c a d  
9.     map.put("a", "a"); //   b c d a  
10.     map.put("b", "b"); //   c d a b       
11.     map.put("f", "f"); //c  c d a b f  
12.     map.put("g", "g"); //c  c d a b f g  
13.   
14.     map.get("d"); //c a b f g d  
15.     for (Entry<String, String> entry : map.entrySet()) {  
16.         System.out.print(entry.getValue() + ", ");  
17.     }  
18.     System.out.println();  
19.   
20.     map.get("a"); //c b f g d a  
21.     for (Entry<String, String> entry : map.entrySet()) {  
22.         System.out.print(entry.getValue() + ", ");  
23.     }  
24.     System.out.println();  
25.   
26.     map.get("c"); //b f g d a c  
27.     for (Entry<String, String> entry : map.entrySet()) {  
28.         System.out.print(entry.getValue() + ", ");  
29.     }  
30.     System.out.println();  
31.   
32.     map.get("b"); //f g d a c b  
33.     for (Entry<String, String> entry : map.entrySet()) {  
34.         System.out.print(entry.getValue() + ", ");  
35.     }  
36.     System.out.println();  
37.   
38.     map.put("h", "h"); //f  f g d a c b h  
39.     for (Entry<String, String> entry : map.entrySet()) {  
40.         System.out.print(entry.getValue() + ", ");  
41.     }  
42.     System.out.println();  
43. }  

运行结果： 
a=a 
a=a 
a=a 
b=b 
c=c 
c=c 
c, a, b, f, g, d, 
c, b, f, g, d, a, 
b, f, g, d, a, c, 
f, g, d, a, c, b, 
f=f 
f, g, d, a, c, b, h,