Java源码阅读之LinkHashMap基于JDK1.8

LinkHashMap是按照插入顺序保存的一个HashMap,继承于HashMap,在HashMap的结构基础上再维护一个双向链表，使得我们可以在遍历数据时按照插入的顺序读取。

目录

类结构

域

构造方法

节点结构

插入

移除

迭代

总结

---

类结构

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

可以看到LinkedHashMap继承于HashMap，增删改查操作都是HashMap中的方法。

 

域

//链表的表头
transient LinkedHashMap.Entry<K,V> head;
//链表的末尾
transient LinkedHashMap.Entry<K,V> tail;
//true的时候表示链表按照节点的存取顺序，false表示按照节点的插入顺序
final boolean accessOrder;

 

构造方法

在LinkedHashMap中一共有5个构造方法，只有最后一个构造方法可以设置accessOrder的值,其他构造方法都是

accessOrder = false，一般我们使用LinkHashMap都是按照插入顺序来维护链表的。

public LinkedHashMap(int initialCapacity, float loadFactor) {
    super(initialCapacity, loadFactor);
    accessOrder = false;
}
public LinkedHashMap(int initialCapacity) {
    super(initialCapacity);
    accessOrder = false;
}
public LinkedHashMap() {
    super();
    accessOrder = false;
}
public LinkedHashMap(Map<? extends K, ? extends V> m) {
    super();
    accessOrder = false;
    putMapEntries(m, false);
}
public LinkedHashMap(int initialCapacity,
                     float loadFactor,
                     boolean accessOrder) {
    super(initialCapacity, loadFactor);
    this.accessOrder = 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);
    }
}

定义了一个内部类继承于HashMap的Node节点，可以看到在Node结构的基础上，声明了双向链表特性的

Entry<K,V> before, after属性

 

 

LinkedHashMap继承于HashMap,增删改查都是通过HashMap去实现的，那么在LinkedHashMap中是怎么来维护顺序链表的操作呢？答案是重写HashMap的一些方法。阅读LinkedHashMap源码发现LinkedHashMap重写了父类的newNode方法，并在里面调用了linkNodeLast方法实现链表的新增节点操作。LinkedHashMap还重写了

afterNodeRemoval，afterNodeInsertion，afterNodeAccess，这3个方法在HashMap是空方法，主要作用是在插入/修改/删除后调用，回调给子类去做一些操作

 

 

插入

上面说到LinkedHashMap重写了newNode方法，从HashMap的源码中可以看到newNode的调用发生在putVal方法中，putVal方法

是HashMap的插入方法，由此可以在基于HashMap基础结构的插入上通过重写newNode方法实现链表的维护。

以下是HashMap的putVal方法，可以看到不仅调用了newNode方法，也调用了afterNodeInsertion，afterNodeAccess方法

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

LinkedHashMap重写的newNode方法

Node<K,V> newNode(int hash, K key, V value, Node<K,V> e) {
    //创建一个LinkedHashMap的节点对象，添加到链表的尾部，返回向上转型的节点
    LinkedHashMap.Entry<K,V> p = new LinkedHashMap.Entry<K,V>(hash, key, value, e);
    linkNodeLast(p);
    return p;
}

链表的添加操作方法

private void linkNodeLast(LinkedHashMap.Entry<K,V> p) {
    //获取到新节点插入前的尾节点
    LinkedHashMap.Entry<K,V> last = tail;
    //维护尾节点，新增节点必定是尾节点
    tail = p;
    //如果尾部节点为Null,则新节点既为尾节点，也为头节点
    if (last == null)
        head = p;
    else {
    //尾部节点不为Null,则新节点的before指向前尾节点，前尾节点的after指向新节点
        p.before = last;
        last.after = p;
    }
}

通过重写newNode方法，在HashMap的结构基础上，LinkedHashMap也能维护本身的按规格顺序的链表

 

 

移除

移除操作是通过重写afterNodeRemoval方法来实现的，在HashMap基础结构中移除节点后会调用afterNodeRemoval方法,

如下所示

HashMap的removeNode方法

final Node<K,V> removeNode(int hash, Object key, Object value,
                           boolean matchValue, boolean movable) {
    Node<K,V>[] tab; Node<K,V> p; int n, index;
    if ((tab = table) != null && (n = tab.length) > 0 &&
        (p = tab[index = (n - 1) & hash]) != null) {
        Node<K,V> node = null, e; K k; V v;
        ......略
        if (node != null && (!matchValue || (v = node.value) == value ||
                             (value != null && value.equals(v)))) {
       	    ......略
            ++modCount;
            --size;
            afterNodeRemoval(node);
            return node;
        }
    }
    return null;
}

可以看到HashMap在HashMap结构的移除后会调用afterNodeRemoval(node)方法，接下来看下在LinkedHashMap重写的实现

void afterNodeRemoval(Node<K,V> e) { // unlink
    //向下转型为LinkHashMap的entry节点，并获得该节点的上一个节点对象b，下一个节点的对象a
    LinkedHashMap.Entry<K,V> p =
        (LinkedHashMap.Entry<K,V>)e, b = p.before, a = p.after;
    //移除目标节点的前后引用关系 置位null
    p.before = p.after = null;
    //如果上一个节点为null，则表明目标节点为头节点，此时目标节点的下一个节点a则为新的头结点
    //否则，将上一个节b点的after引用指向下一个节点的对象a
    if (b == null)
        head = a;
    else
        b.after = a;
    //如果下一个节点为null，则表明目标节点为尾节点，此时目标节点的上一个节点b则为新的头结点
    //否则，将下一个节a点的before引用指向上一个节点的对象b
    if (a == null)
        tail = b;
    else
        a.before = b;
}

 

 

迭代

对于Map的遍历一般都会使用以下EntrySet来进行遍历的，既然LinkedHashMap维护了一条按插入顺序的链表，所以迭代时也是按插入顺序进行迭代，与HashMap的迭代实现有些区别，HashMap的迭代时按照数组+链表/红黑二叉树进行迭代，即先从数组遍历，找到数组不为null的下标，再迭代该下标对应的链表或者红黑二叉树;而LinkedHashMap是链表迭代。

所以在EntrySet的实现上与HashMap不同

 

LinkedHashMap获取EntrySet的方法：

public Set<Map.Entry<K,V>> entrySet() {
    Set<Map.Entry<K,V>> es;
    //如果为空，则初始化LinkedEntrySet对象并赋值给entrySet ，不为空则直接返回
    return (es = entrySet) == null ? (entrySet = new LinkedEntrySet()) : es;
}

 

LinkedEntrySet结构

final class LinkedEntrySet extends AbstractSet<Map.Entry<K,V>> {
    public final int size()                 { return size; }
    public final void clear()               { LinkedHashMap.this.clear(); }
    public final Iterator<Map.Entry<K,V>> iterator() {
        //返回一个迭代器
        return new LinkedEntryIterator();
    }
    public final boolean contains(Object o) {
        if (!(o instanceof Map.Entry))
            return false;
        Map.Entry<?,?> e = (Map.Entry<?,?>) o;
        Object key = e.getKey();
        Node<K,V> candidate = getNode(hash(key), key);
        return candidate != null && candidate.equals(e);
    }
    public final boolean remove(Object o) {
        if (o instanceof Map.Entry) {
            Map.Entry<?,?> e = (Map.Entry<?,?>) o;
            Object key = e.getKey();
            Object value = e.getValue();
            return removeNode(hash(key), key, value, true, true) != null;
        }
        return false;
    }
    public final Spliterator<Map.Entry<K,V>> spliterator() {
        return Spliterators.spliterator(this, Spliterator.SIZED |
                                        Spliterator.ORDERED |
                                        Spliterator.DISTINCT);
    }
    public final void forEach(Consumer<? super Map.Entry<K,V>> action) {
        if (action == null)
            throw new NullPointerException();
        int mc = modCount;
        for (LinkedHashMap.Entry<K,V> e = head; e != null; e = e.after)
            action.accept(e);
        if (modCount != mc)
            throw new ConcurrentModificationException();
    }
}

从结构上看LinkedEntrySet是LinkedHashMap的一个内部类，继承于AbstractSet类，AbstractSet实现了set接口。

通过LinkedEntrySet可以获得一个LinkedEntryIterator迭代器,该迭代器按照链表特性进行迭代

LinkedEntryIterator是一个内部类，继承于LinkedHashIterator，结构如下:

f

final class LinkedEntryIterator extends LinkedHashIterator
    implements Iterator<Map.Entry<K,V>> {
    public final Map.Entry<K,V> next() { 
        //nextNode是父类LinkedHashIterator的方法
        return nextNode();
    }
}

 

LinkedHashIterator结构如下:

abstract class LinkedHashIterator {
    LinkedHashMap.Entry<K,V> next;
    LinkedHashMap.Entry<K,V> current;
    int expectedModCount;

    LinkedHashIterator() {
        next = head;
        expectedModCount = modCount;
        current = null;
    }

    public final boolean hasNext() {
        return next != null;
    }

    final LinkedHashMap.Entry<K,V> nextNode() {
        LinkedHashMap.Entry<K,V> e = next;
        if (modCount != expectedModCount)
            throw new ConcurrentModificationException();
        if (e == null)
            throw new NoSuchElementException();
        current = e;
        next = e.after;
        return e;
    }

    public final void remove() {
        Node<K,V> p = current;
        if (p == null)
            throw new IllegalStateException();
        if (modCount != expectedModCount)
            throw new ConcurrentModificationException();
        current = null;
        K key = p.key;
        removeNode(hash(key), key, null, false, false);
        expectedModCount = modCount;
    }
}

在构造函数初始化了next指向链表的头部head,nextNode方法是从首部开始遍历的，通过节点的after引用取出下一个节点

 

 

在entrySet()的源码注释中有一段是这样描述的

返回的是set集合是Map映射的一个视图，Map中发生了修改，视图也会发生修改，所以set集合也会自动发生变化，

至于为什么是这样，我也不清楚

 

entrySet是一个set<Entry<K,V>>的set集合

关于entrySet，在HashMap中的代码putVal我们没有发现对entrySet有过任何的操作，那么是怎么维护set集合的呢

不解，是在什么时候往这个set集合添加了元素

 

 

总结

LinkedHashMap是基于HashMap实现的，在HashMap数组+链表/红黑二叉树的基础上额外维护了一条顺序的双向链表，主要应用场景为按照插入的顺序读取元素。