【Java基礎】LinkedHashMap

HashMap是根據key的hash值進行散列存儲的，每個節點間是無序的。而LinkedHashMap可以實現有序的存儲鍵值對。

LinkedHashMap是繼承於HashMap的，所以它的很多屬性和方法都是HashMap中的，那麼它是怎麼實現有序存儲的呢？

1、屬性

/**
 * 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;

/**
 * The iteration ordering method for this linked hash map: <tt>true</tt>
 * for access-order, <tt>false</tt> for insertion-order.
 *
 * @serial
 */
final boolean accessOrder;

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

三個重要屬性:head、tail、accessOrder，一個重要結構：基礎Entry

從註釋中都可以看出他們的用途，head節點指向最先存進map的鍵值對，tail節點指向最後存進map的鍵值對

節點Entry繼承自HashMap的基礎節點Node，然後又新增了屬性before和after，看名字就知道它們是用來和前後節點串成雙向鏈表的。

accessOrder決定了鏈表中鍵值對是依照什麼順序來相互串聯的，true表示鍵值對的訪問順序，false表示插入順序，默認是false。

自此，LinkedHashMap的思想就出來了，本身還是和HashMap一樣都是根據Hash求索引，散列等等。同時它自身的每個節點又根據訪問順序或者插入順序串聯成雙向鏈表，head、tail指向鏈表的頭和尾。

那麼它是怎麼實現有序存儲的呢？

2、方法

看下它的方法，發現它沒有覆寫put方法，只覆寫了get方法

看下HashMap中的put方法

public V put(K key, V value) {
        return putVal(hash(key), key, value, false, true);
    }


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

關鍵就在newNode這個地方（當然newNode在HashMap中不止此處會用到），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;
    }
}

所以，每個新的節點生成的時候，都會把它和前一個節點串聯起來，而且隊首head指向第一個生成的節點，隊尾tail指向最新生成的節點。

看個例子

public static void main(String[] args) {
    Map<String, String> map = new LinkedHashMap<>();

    map.put("k1", "v1");
    map.put("k2", "v2");

    Set<Map.Entry<String, String>> entries = map.entrySet();
    for (Map.Entry entry : entries) {
        log.info("key:{}, value:{}", entry.getKey(), entry.getValue());
    }
}

執行過程如下：

這裏只做示意，如果後面hash衝突，需要在桶上加節點或樹節點，按照順序也是會和前後的節點進行串聯，和上圖的原理類似。

這是按照插入順序進行排序的。如果想按訪問順序進行排序，則需要調用另一個構造函數。

可以看到，當指定訪問順序進行排序的時候，最新被訪問的節點會被放到鏈表的末尾。

如何實現呢？看下HashMap的put方法

public static void main(String[] args) {
    Map<String, String> map = new LinkedHashMap<>(16, 0.75f, true);

    map.put("k1", "v1");
    map.put("k2", "v2");
    map.put("k3", "v3");

    Set<Map.Entry<String, String>> entries = map.entrySet();
    for (Map.Entry entry : entries) {
        log.info("key:{}, value:{}", entry.getKey(), entry.getValue());
    }

    map.get("k2");

    for (Map.Entry entry : entries) {
        log.info("key:{}, value:{}", entry.getKey(), entry.getValue());
    }
}


public LinkedHashMap(int initialCapacity,
                     float loadFactor,
                     boolean accessOrder) {
    super(initialCapacity, loadFactor);
    //其他構造函數會將accessOrder設置爲false
    this.accessOrder = accessOrder;
}


輸出結果爲：
key:k1, value:v1
key:k2, value:v2
key:k3, value:v3

key:k1, value:v1
key:k3, value:v3
key:k2, value:v2

HashMap中專門定義了三個給LinkedHashMap覆寫的方法，用於做一些後處理。

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

// Callbacks to allow LinkedHashMap post-actions
void afterNodeAccess(Node<K,V> p) { }
void afterNodeInsertion(boolean evict) { }
void afterNodeRemoval(Node<K,V> p) { }

覆寫的這三個方法都是在進行完基本的鍵值對插入刪除操作後，對雙向鏈表進行調整。如afterNodeInsertion方法就是在Hash數組插入新的Node節點後，根據緩存機制（removeEldestEntry默認是緩存機制不生效，可以覆寫實現自己的緩存機制）決定是否刪除雙向鏈表head節點所指向的節點。

當鍵值對第一次put進來時，如果是生成新的節點調用afterNodeInsertion，則此時和插入順序一致，該節點位於隊尾。當調用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方法，將訪問的這個節點調整到隊尾。如果在put時，更新某個節點的value，此時也會調用afterNodeAccess，即實現了一旦某個節點被訪問（插入、獲取、更新）時，該節點被調整到隊尾。

刪除時，會調用afterNodeRemoval將節點從雙向鏈表中移除，和之前的原來類似，不再展開。

3、用途

LinkedHashMap能用來做什麼呢，由於它自身維護了一個雙向鏈表，保證節點的順序是按照插入或者訪問的順序連接的，所以這種特性在某些場景下就很有用，比如LRU。

什麼是LRU，Least Recently Used，最近最少使用。比如一個Map我最多允許存放10個鍵值對，那麼當第11個鍵值對要插入的時候，我要把已有的10箇中裏使用頻率最低的一個移除。

@Slf4j
public class MapTest {
    public static void main(String[] args) {
        LRUExample<String, String> lruExample = new LRUExample<>(4);
        int i = 0;

        for (; i < 4; i++) {
            lruExample.put("k" + i, "v" + i);
        }
        log.info("插入完4個鍵值對後");
        Set<Map.Entry<String, String>> entries = lruExample.entrySet();
        for (Map.Entry<String, String> entry : entries) {
            log.info("key:{}, value:{}", entry.getKey(), entry.getValue());
        }

        lruExample.get("k1");
        log.info("訪問k1後");
        for (Map.Entry<String, String> entry : entries) {
            log.info("key:{}, value:{}", entry.getKey(), entry.getValue());
        }

        lruExample.put("k5", "v5");
        log.info("插入完第5個鍵值對後");
        for (Map.Entry<String, String> entry : entries) {
            log.info("key:{}, value:{}", entry.getKey(), entry.getValue());
        }
    }
}

class LRUExample<K, V> extends LinkedHashMap<K, V> {
    final int maxSize;
    LRUExample(int maxSize) {
        super(maxSize, 0.75f, true);
        this.maxSize = maxSize;
    }

    @Override
    protected boolean removeEldestEntry(Map.Entry<K, V> eldest) {
        return size() > maxSize;
    }
}

輸出結果爲：
插入完4個鍵值對後
key:k0, value:v0
key:k1, value:v1
key:k2, value:v2
key:k3, value:v3
訪問k0後
key:k1, value:v1
key:k2, value:v2
key:k3, value:v3
key:k0, value:v0
插入完第5個鍵值對後
key:k2, value:v2
key:k3, value:v3
key:k0, value:v0
key:k5, value:v5

當插入到第5個時，此時訪問頻率最低的就是head節點指向的k1-v1，所以當k5-v5插入的時候，觸發了緩存清除時，k0-v0被移除，k5-v5加入到隊尾。

【Java基礎】LinkedHashMap

mysql的一次報錯排查

【Java併發】CountDownLatch

【Java基礎】初始化時代碼塊執行順序

【Java併發】AQS

FactoryBean與ObjectFactory

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結