圖解集合6：LinkedHashMap

五月的倉頡發表於2015-12-19
圖解HashMap

初識LinkedHashMap

上兩篇文章講了HashMap和HashMap在多執行緒下引發的問題，說明了，HashMap是一種非常常見、非常有用的集合，並且在多執行緒情況下使用不當會有執行緒安全問題。

大多數情況下，只要不涉及執行緒安全問題，Map基本都可以使用HashMap，不過HashMap有一個問題，就是迭代HashMap的順序並不是HashMap放置的順序，也就是無序。HashMap的這一缺點往往會帶來困擾，因為有些場景，我們期待一個有序的Map。

這個時候，LinkedHashMap就閃亮登場了，它雖然增加了時間和空間上的開銷，但是通過維護一個執行於所有條目的雙向連結串列，LinkedHashMap保證了元素迭代的順序。

 

四個關注點在LinkedHashMap上的答案

關  注  點 結      論
LinkedHashMap是否允許鍵值對為空 Key和Value都允許空
LinkedHashMap是否允許重複資料 Key重複會覆蓋、Value允許重複
LinkedHashMap是否有序 有序
LinkedHashMap是否執行緒安全 非執行緒安全

 

LinkedHashMap基本資料結構

關於LinkedHashMap，先提兩點：

1、LinkedHashMap可以認為是HashMap+LinkedList，即它既使用HashMap運算元據結構，又使用LinkedList維護插入元素的先後順序

2、LinkedHashMap的基本實現思想就是----多型。可以說，理解多型，再去理解LinkedHashMap原理會事半功倍；反之也是，對於LinkedHashMap原理的學習，也可以促進和加深對於多型的理解。

為什麼可以這麼說，首先看一下，LinkedHashMap的定義：

public class LinkedHashMap<K,V>
    extends HashMap<K,V>
    implements Map<K,V>
{
    ...
}

看到，LinkedHashMap是HashMap的子類，自然LinkedHashMap也就繼承了HashMap中所有非private的方法。再看一下LinkedHashMap中本身的方法：

看到LinkedHashMap中並沒有什麼運算元據結構的方法，也就是說LinkedHashMap運算元據結構（比如put一個資料），和HashMap運算元據的方法完全一樣，無非就是細節上有一些的不同罷了。

LinkedHashMap和HashMap的區別在於它們的基本資料結構上，看一下LinkedHashMap的基本資料結構，也就是Entry：

private static class Entry<K,V> extends HashMap.Entry<K,V> {
    // These fields comprise the doubly linked list used for iteration.
    Entry<K,V> before, after;

Entry(int hash, K key, V value, HashMap.Entry<K,V> next) {
        super(hash, key, value, next);
    }
    ...
}

列一下Entry裡面有的一些屬性吧：

  • K key
  • V value
  • Entry<K, V> next
  • int hash
  • Entry<K, V> before
  • Entry<K, V> after

其中前面四個，也就是紅色部分是從HashMap.Entry中繼承過來的；後面兩個，也就是藍色部分是LinkedHashMap獨有的。不要搞錯了next和before、After，next是用於維護HashMap指定table位置上連線的Entry的順序的，before、After是用於維護Entry插入的先後順序的。

還是用圖表示一下，列一下屬性而已：

 

初始化LinkedHashMap

假如有這麼一段程式碼：

1 public static void main(String[] args)
2 {
3     LinkedHashMap<String, String> linkedHashMap =
4             new LinkedHashMap<String, String>();
5     linkedHashMap.put("111", "111");
6     linkedHashMap.put("222", "222");
7 }

首先是第3行~第4行，new一個LinkedHashMap出來，看一下做了什麼：

 1 public LinkedHashMap() {
 2 super();
 3     accessOrder = false;
 4 }
1 public HashMap() {
2     this.loadFactor = DEFAULT_LOAD_FACTOR;
3     threshold = (int)(DEFAULT_INITIAL_CAPACITY * DEFAULT_LOAD_FACTOR);
4     table = new Entry[DEFAULT_INITIAL_CAPACITY];
5     init();
6 }
 1 void init() {
 2     header = new Entry<K,V>(-1, null, null, null);
 3     header.before = header.after = header;
 4 }
/**
 * The head of the doubly linked list.
 */
private transient Entry<K,V> header;

這裡出現了第一個多型：init()方法。儘管init()方法定義在HashMap中，但是由於：

1、LinkedHashMap重寫了init方法

2、例項化出來的是LinkedHashMap

因此實際呼叫的init方法是LinkedHashMap重寫的init方法。假設header的地址是0x00000000，那麼初始化完畢，實際上是這樣的：

 

LinkedHashMap新增元素

繼續看LinkedHashMap新增元素，也就是put("111","111")做了什麼，首先當然是呼叫HashMap的put方法：

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

第17行又是一個多型，因為LinkedHashMap重寫了addEntry方法，因此addEntry呼叫的是LinkedHashMap重寫了的方法：

 1 void addEntry(int hash, K key, V value, int bucketIndex) {
 2     createEntry(hash, key, value, bucketIndex);
 3 
 4     // Remove eldest entry if instructed, else grow capacity if appropriate
 5     Entry<K,V> eldest = header.after;
 6     if (removeEldestEntry(eldest)) {
 7         removeEntryForKey(eldest.key);
 8     } else {
 9         if (size >= threshold)
10             resize(2 * table.length);
11     }
12 }

因為LinkedHashMap由於其本身維護了插入的先後順序，因此LinkedHashMap可以用來做快取，第5行~第7行是用來支援FIFO演算法的，這裡暫時不用去關心它。看一下createEntry方法：

1 void createEntry(int hash, K key, V value, int bucketIndex) {
2     HashMap.Entry<K,V> old = table[bucketIndex];
3     Entry<K,V> e = new Entry<K,V>(hash, key, value, old);
4     table[bucketIndex] = e;
5     e.addBefore(header);
6     size++;
7 }
private void addBefore(Entry<K,V> existingEntry) {
    after  = existingEntry;
    before = existingEntry.before;
    before.after = this;
    after.before = this;
}

第2行~第4行的程式碼和HashMap沒有什麼不同，新新增的元素放在table[i]上，差別在於LinkedHashMap還做了addBefore操作，這四行程式碼的意思就是讓新的Entry和原連結串列生成一個雙向連結串列。假設字串111放在位置table[1]上，生成的Entry地址為0x00000001，那麼用圖表示是這樣的：

如果熟悉LinkedList的原始碼應該不難理解，還是解釋一下，注意下existingEntry表示的是header：

1、after=existingEntry，即新增的Entry的after=header地址，即after=0x00000000

2、before=existingEntry.before，即新增的Entry的before是header的before的地址，header的before此時是0x00000000，因此新增的Entry的before=0x00000000

3、before.after=this，新增的Entry的before此時為0x00000000即header，header的after=this，即header的after=0x00000001

4、after.before=this，新增的Entry的after此時為0x00000000即header，header的before=this，即header的before=0x00000001

這樣，header與新增的Entry的一個雙向連結串列就形成了。再看，新增了字串222之後是什麼樣的，假設新增的Entry的地址為0x00000002，生成到table[2]上，用圖表示是這樣的：

就不細解釋了，只要before、after清除地知道代表的是哪個Entry的就不會有什麼問題。

總得來看，再說明一遍，LinkedHashMap的實現就是HashMap+LinkedList的實現方式，以HashMap維護資料結構，以LinkList的方式維護資料插入順序。

 

利用LinkedHashMap實現LRU演算法快取

前面講了LinkedHashMap新增元素，刪除、修改元素就不說了，比較簡單，和HashMap+LinkedList的刪除、修改元素大同小異，下面講一個新的內容。

LinkedHashMap可以用來作快取，比方說LRUCache，看一下這個類的程式碼，很簡單，就十幾行而已：

public class LRUCache extends LinkedHashMap
{
    public LRUCache(int maxSize)
    {
        super(maxSize, 0.75F, true);
        maxElements = maxSize;
    }

    protected boolean removeEldestEntry(java.util.Map.Entry eldest)
    {
        return size() > maxElements;
    }

    private static final long serialVersionUID = 1L;
    protected int maxElements;
}

顧名思義，LRUCache就是基於LRU演算法的Cache（快取），這個類繼承自LinkedHashMap，而類中看到沒有什麼特別的方法，這說明LRUCache實現快取LRU功能都是源自LinkedHashMap的。LinkedHashMap可以實現LRU演算法的快取基於兩點：

1、LinkedList首先它是一個Map，Map是基於K-V的，和快取一致

2、LinkedList提供了一個boolean值可以讓使用者指定是否實現LRU

那麼，首先我們瞭解一下什麼是LRU：LRU即Least Recently Used，最近最少使用，也就是說，當快取滿了，會優先淘汰那些最近最不常訪問的資料。比方說資料a，1天前訪問了；資料b，2天前訪問了，快取滿了，優先會淘汰資料b。

我們看一下LinkedList帶boolean型引數的構造方法：

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

就是這個accessOrder，它表示：

（1）false，所有的Entry按照插入的順序排列

（2）true，所有的Entry按照訪問的順序排列

第二點的意思就是，如果有1 2 3這3個Entry，那麼訪問了1，就把1移到尾部去，即2 3 1。每次訪問都把訪問的那個資料移到雙向佇列的尾部去，那麼每次要淘汰資料的時候，雙向佇列最頭的那個資料不就是最不常訪問的那個資料了嗎？換句話說，雙向連結串列最頭的那個資料就是要淘汰的資料。

"訪問"，這個詞有兩層意思：

1、根據Key拿到Value，也就是get方法

2、修改Key對應的Value，也就是put方法

首先看一下get方法，它在LinkedHashMap中被重寫：

public V get(Object key) {
    Entry<K,V> e = (Entry<K,V>)getEntry(key);
    if (e == null)
        return null;
    e.recordAccess(this);
    return e.value;
}

然後是put方法，沿用父類HashMap的：

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

修改資料也就是第6行~第14行的程式碼。看到兩端程式碼都有一個共同點：都呼叫了recordAccess方法，且這個方法是Entry中的方法，也就是說每次的recordAccess操作的都是某一個固定的Entry。

recordAccess，顧名思義，記錄訪問，也就是說你這次訪問了雙向連結串列，我就把你記錄下來，怎麼記錄？把你訪問的Entry移到尾部去。這個方法在HashMap中是一個空方法，就是用來給子類記錄訪問用的，看一下LinkedHashMap中的實現：

void recordAccess(HashMap<K,V> m) {
    LinkedHashMap<K,V> lm = (LinkedHashMap<K,V>)m;
    if (lm.accessOrder) {
        lm.modCount++;
        remove();
        addBefore(lm.header);
    }
}
private void remove() {
    before.after = after;
    after.before = before;
}
private void addBefore(Entry<K,V> existingEntry) {
    after  = existingEntry;
    before = existingEntry.before;
    before.after = this;
    after.before = this;
}

看到每次recordAccess的時候做了兩件事情：

1、把待移動的Entry的前後Entry相連

2、把待移動的Entry移動到尾部

當然，這一切都是基於accessOrder=true的情況下。最後用一張圖表示一下整個recordAccess的過程吧：

 

程式碼演示LinkedHashMap按照訪問順序排序的效果

最後程式碼演示一下LinkedList按照訪問順序排序的效果，驗證一下上一部分LinkedHashMap的LRU功能：

public static void main(String[] args)
{
    LinkedHashMap<String, String> linkedHashMap =
            new LinkedHashMap<String, String>(16, 0.75f, true);
    linkedHashMap.put("111", "111");
    linkedHashMap.put("222", "222");
    linkedHashMap.put("333", "333");
    linkedHashMap.put("444", "444");
    loopLinkedHashMap(linkedHashMap);
    linkedHashMap.get("111");
    loopLinkedHashMap(linkedHashMap);
    linkedHashMap.put("222", "2222");
    loopLinkedHashMap(linkedHashMap);
}
    
public static void loopLinkedHashMap(LinkedHashMap<String, String> linkedHashMap)
{
    Set<Map.Entry<String, String>> set = inkedHashMap.entrySet();
    Iterator<Map.Entry<String, String>> iterator = set.iterator();
    
    while (iterator.hasNext())
    {
        System.out.print(iterator.next() + "\t");
    }
    System.out.println();
}

注意這裡的構造方法要用三個引數那個且最後的要傳入true，這樣才表示按照訪問順序排序。看一下程式碼執行結果：

111=111    222=222    333=333    444=444    
222=222    333=333    444=444    111=111    
333=333    444=444    111=111    222=2222

程式碼執行結果證明了兩點：

1、LinkedList是有序的

2、每次訪問一個元素（get或put），被訪問的元素都被提到最後面去了

 

相關文章