Java LinkedHashMap

Java LinkedHashMap

前言

Map是我们在实际使用过程中常用的集合，HashMap在Java的实际开发中出镜率很高，它通过hash算法实现了高效的非线程安全的集合，它有一个缺点就是，用户插入集合的数据时无序，在我们需要一些有序的map的时候，我们就需要引入另外一个集合：LinkedHashMap。
LinkedHashMap是一个有序的非线程安全的集合，它是HashMap的子类，基本特性跟HashMap一致。
本文基于java 1.7

LinkedHashMap的原理

LinkedHashMap是如何实现有序的呢？它实际上实在HashMap的基础上，维护了一个双向链表，有这个链表来保证插入的有序性。
LinkedHashMap增加了一个head节点，这个节点本省是空的，用来双向链表的头节点，后续的节点都在head节点之后插入。
LinkedHashMap在HashMap Entry类的基础上，增加了after和before用来标识链表的方向，Entry类见下：

LinkedHashMap的类图：

LinkedHashMap的构造

LinkedHashMap支持2种模式的双向链表，一种就是我们常用的按照插入顺序的链表，另外一种是LRU的链表，按照访问顺序排序。

    public LinkedHashMap(int initialCapacity,
                         float loadFactor,
                         boolean accessOrder) {
        super(initialCapacity, loadFactor);
        //accessOrder:true access-order; false insertion-order
        this.accessOrder = accessOrder;
    }

插入

LinkedHashMap使用父类的put方法，插入数据，基本流程一致，想参考的可以参看上一篇博客Java hashmap，只是在addEntry调用自己的实现：

    void addEntry(int hash, K key, V value, int bucketIndex) {
        //调用父类的addEntry，在父类的addEntry方法中会调用LinkedHashMap的createEntry来创建节点
        super.addEntry(hash, key, value, bucketIndex);

        // Remove eldest entry if instructed
        Entry<K,V> eldest = header.after;
        if (removeEldestEntry(eldest)) {
            removeEntryForKey(eldest.key);
        }
    }
    void createEntry(int hash, K key, V value, int bucketIndex) {
        HashMap.Entry<K,V> old = table[bucketIndex];
        Entry<K,V> e = new Entry<>(hash, key, value, old);
        table[bucketIndex] = e;
        //重点部分，用来实现双向链表，在尾部插入，由于header的before指向了尾部，这里调用header来进行插入
        e.addBefore(header);
        size++;
    }

    private void addBefore(Entry<K,V> existingEntry) {
        //existingEntry表示head节点，当前节点的后一个节点是head
            after  = existingEntry;
            //当前节点的前一个节点是head的前一个节点，就是尾节点
            before = existingEntry.before;
            //尾节点的后一个节点是当前插入的节点
            before.after = this;
            //将head.befor指向当前节点
            after.before = this;
        }

通过addBefore，就构成了用来保存插入顺序的双向链表

获取

LinkedHashMap的get跟它的父类基本一致，只是当accessOrder设置为true时，需要调整链表的顺序。

    public V get(Object key) {
        Entry<K,V> e = (Entry<K,V>)getEntry(key);
        if (e == null)
            return null;
        //记录访问顺序，当accessOrder为true时生效，设置为false，不起作用
        e.recordAccess(this);
        return e.value;
    }
    void recordAccess(HashMap<K,V> m) {
            LinkedHashMap<K,V> lm = (LinkedHashMap<K,V>)m;
            if (lm.accessOrder) {
                //true，LRU，调整访问顺序
                lm.modCount++;
                //在链表上将当前节点移除
                remove();
                //将当前节点重新添加到链表尾部
                addBefore(lm.header);
            }
        }