集合框架（Java）之LinkedHashMap

LinkedHashMap

在上一篇文章中，介绍了HashMap的数据结构，是由数组 + 单向链表构成的，那么HashMap的这种散列元素的数据结构，也就注定它是无序的，因为每次算出的Index，都不是连续的，而是随机的，所以注定在迭代元素的时候，元素的取出顺序和存放顺序，是无序的。

LinkedHashMap则是解决无序的这个问题的。

LinkedHashMap继承自HashMap，并且内部维护了一个双向链表，用来记录所有插入的元素，因此可以保证元素的有序。

我们先来看LinkedHashMap的成员变量

    transient LinkedHashMap.Entry<K,V> head;    //记录头结点


    transient LinkedHashMap.Entry<K,V> tail;    //记录尾结点


    final boolean accessOrder;                  //有序标记,false为存储、取出顺序，true为方位次数顺序

再来看构造函数

    public LinkedHashMap(int initialCapacity, float loadFactor) {
        super(initialCapacity, loadFactor);        //调用HashMap的构造函数
        accessOrder = false;                       //指定LinkedHashMap为存储取出有序
    }

    public LinkedHashMap(int initialCapacity) {
        super(initialCapacity);     //调用HashMap构造函数
        accessOrder = false;        //指定存储取出顺序
    }

    public LinkedHashMap() {
        super();               //默认空参构造HashMap,容量16，扩容因子为0.75
        accessOrder = false;   //有序为存储取出有序
    }

    public LinkedHashMap(Map<? extends K, ? extends V> m) {
        super();                         //调用HashMap空参构造
        accessOrder = false;             //存储取出顺序
        putMapEntries(m, false);         //存入参数中的map
    }


    final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
        //检测是否需要扩容
        int s = m.size();
        if (s > 0) {
            if (table == null) { // pre-size
                float ft = ((float)s / loadFactor) + 1.0F;
                int t = ((ft < (float)MAXIMUM_CAPACITY) ?
                         (int)ft : MAXIMUM_CAPACITY);
                if (t > threshold)
                    threshold = tableSizeFor(t);
            }
            else if (s > threshold)
                resize();
         //检测是否需要扩容

            for (Map.Entry<? extends K, ? extends V> e : m.entrySet()) {
                K key = e.getKey();
                V value = e.getValue();
                //迭代元素，插入元素
                putVal(hash(key), key, value, false, evict);
            }
        }
    }

---

我们来看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);         //所有操作和HashMap一致，只是在这里根据排序规则做单独处理
                return oldValue;
            }
        }
        ++modCount;
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);  //所有操作和HashMap一致，只是在这里根据排序规则做单独处理
        return null;
    }

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

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

---

我们再来看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;
    }

---

总结：

   LinkedHashMap是HashMap的子类，它的出现主要是为了解决HashMap无序的问题。它内部维护了一个双向链表，用来记录元素的顺序，LinkedHashMap在构造时，accessOrder 变量用来记录排序方式，true代表使用次数排序，即使用次数越高，就排在链表的尾部。accessOrder为false时，代表插入取出的顺序，每次插入新元素，就放在链表的头部。因此LinkedHashMap是一个有序的HashMap。