数据结构-LinkedHashMap源码分析

917 阅读6分钟

概述

LinkedHashMap是对HashMap功能进行的优化,解决HashMap无序的问题。HashMap分析参考我之前的文章数据结构-HashMap源码分析

主要呢 就是将之前HashMap里面的单链表维护成双链表以及维护了一个全局的头尾节点

注意:默认情况,遍历时的顺序是按照插入节点的顺序。这也是其与HashMap最大的区别。
也可以在构造时传入accessOrder参数,使得其遍历顺序按照访问的顺序输出。

LinkedHashMap使用

用法呢跟HashMap是一样的 其实里面调用的方法 大致也是一样的

LinkedHashMap<Object, Object> linkedHashMap = new LinkedHashMap<>();

linkedHashMap.putIfAbsent("2",new boolean[]);
linkedHashMap.put("dd",new HashMap<>());
linkedHashMap.remove("dddd");
linkedHashMap.remove("ddd",new boolean[]);
linkedHashMap.replace("ddd","dddd")
linkedHashMap.getOrDefault();

Set<Map.Entry<Object, Object>> entrySet = linkedHashMap.entrySet();
Iterator<Map.Entry<Object, Object>> iterator1 = entrySet.iterator();
while (iterator1.hasNext()) {
    iterator1.next();
}

LinkedHashMap构造函数

public LinkedHashMap() {
    super();
    accessOrder = false;
}

accessOrder 记住这个常量 非常关键!!!

putIfAbsent方法分析

@Override
public V putIfAbsent(K key, V value) {
    return putVal(hash(key), key, value, true, true);
}

发现没有 跟hashMap调用的方法是一样的。不了解hashMap的 一定要看之前写的文章

那LinkedHashMap多了哪些区别 或者是扩充呢?

1、LinkedHashMap使用的节点是LinkedHashMapEntry

//LinkedHashMap 每个节点元素 还包含了一个前后节点元素
static class LinkedHashMapEntry<K,V> extends HashMap.Node<K,V> {
    LinkedHashMapEntry<K,V> before, after;
    LinkedHashMapEntry(int hash, K key, V value, Node<K,V> next) {
        super(hash, key, value, next);
    }
}

2、重写了以下方法

void afterNodeAccess(Node<K,V> p) { }
void afterNodeInsertion(boolean evict) { }
void afterNodeRemoval(Node<K,V> p) { }

3、构造函数多了accessOrder变量

public LinkedHashMap() {
    super();
    accessOrder = false;
}

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;
    //关于(n - 1) & hash为什么等于 hash % n  https://blog.csdn.net/LeeMon23/article/details/120893190
    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)
            //树操作 此处不分析 涉及到平衡树跟红黑树 单链表长度大于7即会转变 为了查找更快
            e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
        else {
            for (int binCount = 0; ; ++binCount) {
                if ((e = p.next) == null) {
                    //如果找了一圈都没有 那就插到后面 此时这个地方的值还为null
                    p.next = newNode(hash, key, value, null);
                    //如果链表长度大于等于8 那就转成树
                    if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                        treeifyBin(tab, hash);
                    break;
                }
                //如果key相等 hash值相等 那就说明找到了 就是e
                if (e.hash == hash &&
                    ((k = e.key) == key || (key != null && key.equals(k))))
                    break;
                p = e;
            }
        }
        //不为null 说明之前这个地方有数据 那这种情况 数据也不需要扩容
        if (e != null) { // existing mapping for key
            //拿出旧数据
            V oldValue = e.value;
            //调用putIfAbsent方法 onlyIfAbsent值为true 调用put方法 该值为false
            if (!onlyIfAbsent || oldValue == null)
                //如果之前数据为null 那就直接将新数据放进去
                //或者 如果之前调用的是put方法 那也把新数据放进去 反之 如果调用的是putIfAbsent且之前有数据 那么新数据不会替换
                e.value = value;
            afterNodeAccess(e);
            //都是返回旧数据
            return oldValue;
        }
    }
    //修改次数
    ++modCount;
    //如果新增数据 大于阈值 那就重新计算 且把旧数据放到新map里
    if (++size > threshold)
        resize();
    afterNodeInsertion(evict);
    return null;
}

这个方法调涌跟hashmap一样 注意newNode跟afterNodeAccess、afterNodeInsertion方法

newNode方法

Node<K,V> newNode(int hash, K key, V value, Node<K,V> e) {
    LinkedHashMapEntry<K,V> p =
        new LinkedHashMapEntry<K,V>(hash, key, value, e);
    linkNodeLast(p);
    return p;
}
private void  linkNodeLast(LinkedHashMapEntry<K,V> p) {
    //tail是全局维护的尾节点 假设第一次put 那么tail是null 后续尾节点都是指向新增的节点
    LinkedHashMapEntry<K,V> last = tail;
    //p是新加的节点 通过引用的方式 使得尾节点指向当前p对象
    tail = p;
    if (last == null)
        //那么此刻全局维护的头节点head 指向这个新节点 这个节点就是源头
        head = p;
    else {
        //否则当前节点类内部的前节点 指向链表上最后一个节点
        p.before = last;
        //链表上前一个节点的后节点指向当前新加入的节点 这样就形成了双链表
        last.after = p;
    }
}

这里就用到了双链表跟头尾节点 那我们遍历数据就是通过head节点去遍历 而不是数组,所以我们先看遍历操作。

遍历

Set<Map.Entry<Object, Object>> entrySet = linkedHashMap.entrySet();
Iterator<Map.Entry<Object, Object>> iterator1 = entrySet.iterator();
while (iterator1.hasNext()) {
    iterator1.next();
}

iterator1的实现类就是LinkedEntryIterator

final class LinkedEntryIterator extends LinkedHashIterator
    implements Iterator<Map.Entry<K,V>> {
    public final Map.Entry<K,V> next() { return nextNode(); }
}
abstract class LinkedHashIterator {
    LinkedHashMapEntry<K,V> next;
    LinkedHashMapEntry<K,V> current;
    int expectedModCount;

    LinkedHashIterator() {
        //头节点
        next = head;
        expectedModCount = modCount;
        current = null;
    }

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

    final LinkedHashMapEntry<K,V> nextNode() {
        LinkedHashMapEntry<K,V> e = next;
        if (modCount != expectedModCount)
            throw new ConcurrentModificationException();
        if (e == null)
            //如果数组没有数据 抛异常
            throw new NoSuchElementException();
        current = e;
        //按照链表顺序找
        next = e.after;
        return e;
    }

再回到afterNodeAccess方法 accessOrder使用也在里面

image.png 方法调用的前提 是put了一个已经存在的数据

//假设 当前顺序是p1 p2 p3 现在e 是p2
void afterNodeAccess(Node<K,V> e) { // move node to last
    LinkedHashMapEntry<K,V> last;
    //tail是尾节点 是个全局变量 accessOrder 默认是false 正常情况下 是不会进入后续判断的 false: 基于插入顺序     true:  基于访问顺序
    //last = tail) != e 什么情况下值为true呢 就是当调用了get方法 且不是key不是最后加入的节点 或者put的新节点 之前数组里已经存在
    if (accessOrder && (last = tail) != e) {
        //获取当前节点的前节点b跟后节点a
        LinkedHashMapEntry<K,V> p =
                //b = p.before 那就指向前一个节点 b=p1 a=p3
            (LinkedHashMapEntry<K,V>)e, b = p.before, a = p.after;
        //将当前节点后置节点指针置空
        p.after = null;
        //如果当前put节点的前一个b为null 说明这个是数组第一个节点
        if (b == null)
            //那么head就指向 当前节点的下一个节点 (因为当前节点 后续会移到链表的尾部) 如果p是p1 那么head就指向p2
            head = a;
        else
            //如果当前节点存在前节点 那么就将当前节点的前一个节点的后置节点指针指向
        //就是将p1的后置节点指向p3
            b.after = a;
        if (a != null)//此刻a=p3
            //如果当前节点前节点不为null 那就将当前节点的前置节点存储指向当前节点前一个节点
            //那就是p3.before = p1
            a.before = b;
        else
            last = b;
        if (last == null)//last = p3
            //将当前节点放在表头
            head = p;
        else {
            //将p2.before = p3
            p.before = last;
            //p3.after =p2 这样操作后 就将p2挪到了最后
            last.after = p;
        }
        //尾节点指向p2
        tail = p;
        ++modCount;
    }
}

总结

我是通过代码层面去分析的,没有相关图解,理解起来有点困难,我自己是结合画图才理解的。我觉得可以参考我后续的参考文章去理解,他们讲解的非常清楚!

参考文章