LinkedHashMap源码分析

linkedHashMap是Map接口的一个实现类,主要用来存储(key,value)类型的数据,与hashMap的区别是linkedHashMap会对插入的元素的顺序进行维护,而hashMap是无序的。

本篇主要讨论一下linkedHashMap底层代码的实现。

LinkedHashMap的类定义

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

可以看到,LinkedHashMap继承了HashMap,所以LinkedHashMap与HashMap一致,也是基于数组+链表+红黑树实现的。
对于HashMap不熟悉的,可以先看一下 HashMap源码分析

局部变量

    //LinkedHashMap使用双向链表维护插入节点的顺序
    //head表示链表的头部指针,指向链表中的第一个元素
    transient LinkedHashMap.Entry<K,V> head;

    //tail表示链表的尾部指针,指向链表中的最后一个元素
    transient LinkedHashMap.Entry<K,V> tail;

    //为false时,表示不要对修改或者查询过的节点进行顺序的维护,按照插入的顺序保持链表中节点的顺序
    //为true时,表示如果对节点修改,需要将修改了的节点移动到链表的最尾部
    final boolean accessOrder;

Entry实现

   //LinkedHashMap中存储的节点为Entry,这里可以看出,该类继承了HashMap的Node类
   static class Entry<K,V> extends HashMap.Node<K,V> {
        //与HashMap的Node比较,Entry多了before和after两个局部变量,用来保存节点插入的顺序
        Entry<K,V> before, after;
        Entry(int hash, K key, V value, Node<K,V> next) {
            super(hash, key, value, next);
        }
    }

说明:
LinkedHashMap中的Entry也是继承自HashMap的Node类,只是比HashMap中的Node类多了before、after两个局部变量,用来指向当前entry的前后节点,保存了插入节点的顺序。

LinkedHashMap的无参构造函数

   public LinkedHashMap() {
        super();
        //将accessOrder设置为false,表示不要对修改的节点进行顺序的维护,按照插入的顺序保持链表中节点的顺序
        accessOrder = false;
    }

put(K key, V value)方法

    //linkedHashMap调用的是父类HashMap的put方法
    public V put(K key, V value) {
        return putVal(hash(key), key, value, false, true);
    }
    //HashMap的putVal方法
    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)
            //这里的实现不同,LinkedHashMap重写了该方法
            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;
                //这里的实现不同,LinkedHashMap重写了该方法
                //当最节点进行修改时,判断是否需要将节点移动到链表尾部
                afterNodeAccess(e);
                return oldValue;
            }
        }
        ++modCount;
        if (++size > threshold)
            resize();
        //该方法也会回调LinkedHashMap的实现,当无具体实现的功能
        afterNodeInsertion(evict);
        return null;
    }

    //LinkedHashMap重写了newNode方法
    Node<K,V> newNode(int hash, K key, V value, Node<K,V> e) {
        //新建立一个节点p
        LinkedHashMap.Entry<K,V> p =
            new LinkedHashMap.Entry<K,V>(hash, key, value, e);
        //将新增的节点p添加到链表最尾部
        linkNodeLast(p);
        return p;
    }
    //将新添加的节点增加到linkedHashMap链表的结尾
    private void linkNodeLast(LinkedHashMap.Entry<K,V> p) {
        //将tail赋予last局部变量
        LinkedHashMap.Entry<K,V> last = tail;
        //将新增的节点赋予tail,也就是将链表尾节点tail指向新增的节点
        tail = p;
        //last等于null,说明之前链表中没有元素
        if (last == null)
            //将链表头节点指向新增的节点
            head = p;
        else {
            //到这来说明之前链表中是有数据的
            //将新增的节点添加到链表最尾部,维护好before与after指针的关系
            p.before = last;
            last.after = p;
        }
    }

    //将节点e移动到链表的最尾部
    void afterNodeAccess(Node<K,V> e) { 
        LinkedHashMap.Entry<K,V> last;
        //accessOrder默认为false,表示不要对修改的节点进行顺序的维护,按照插入的顺序保持链表中节点的顺序
        if (accessOrder && (last = tail) != e) {
            //执行移动逻辑,将节点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;
        }
    }

说明:
LinkedHashMap的put函数,回调了HashMap的put函数,其中有两处不同:

  • newNode,创建新节点的方式调用LinkedHashMap自己的实现;
  • 当节点已经存在,并且修改了节点的值时,回调afterNodeAccess实现,该方法中执行是否需要将修改了的节点移动到链表的最尾部;

get(Object key)方法实现

   //根据key获取对应的值
   public V get(Object key) {
        Node<K,V> e;
        //调用hashMap的getNode方法获取节点
        if ((e = getNode(hash(key), key)) == null)
            return null;
        //判断是否需要对操作了的节点进行顺序的维护,也就是将操作了的节点移动到链表最尾部,默认是false
        if (accessOrder)
            afterNodeAccess(e);
        return e.value;
    }

remove(Object key)方法的实现

该方法回调HashMap的remove方法的实现,主要有的不同是HashMap的remove会回调LinkedHashMap的afterNodeRemoval方法。

   //从链表中删除节点e
   void afterNodeRemoval(Node<K,V> e) { 
        LinkedHashMap.Entry<K,V> p =
            (LinkedHashMap.Entry<K,V>)e, b = p.before, a = p.after;
        p.before = p.after = null;
        if (b == null)
            head = a;
        else
            b.after = a;
        if (a == null)
            tail = b;
        else
            a.before = b;
    }

forEach方法实现

   //该方法遍历链表中的每一个元素,传入一个函数式接口,也就是要回调的自定义函数
   public void forEach(BiConsumer<? super K, ? super V> action) {
        //如果回调函数为null,报空指针异常
        if (action == null)
            throw new NullPointerException();
        //将modCount赋予mc,后面判断如果在遍历之后,两个值不相等,则报错
        int mc = modCount;
        //按照链表中的顺序,遍历已经插入的节信息,并回调传入的自定义函数
        for (LinkedHashMap.Entry<K,V> e = head; e != null; e = e.after)
            action.accept(e.key, e.value);
        //如果modCount 与 mc不相等,则报ConcurrentModificationException,表示在遍历数组的时候,不允许对数组进行修改操作
        //在putVal,clear等修改操作的时候会对modCount执行加1的操作
        if (modCount != mc)
            throw new ConcurrentModificationException();
    }

说明:

  • 首先传入要对遍历节点操作的自定义函数
  • 当对链表中的元素进行遍历时,会在遍历之前,将modCount赋予一个临时遍历mc,遍历完后,在对最新的modCount与mc进行比较;
  • 这里的遍历方式是按照LinkedHashMap维护的链表顺序,遍历节点数据;
  • 遍历完后,如果最新的modCount与mc不相等,则报ConcurrentModificationException异常,表示不允许在遍历数据期间,对HashMap中的数据进行修改操作,当执行putValu,clear,remove等修改数据操作的时候,会对modCount执行加1的操作。
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,951评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,606评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,601评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,478评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,565评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,587评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,590评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,337评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,785评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,096评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,273评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,935评论 5 339
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,578评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,199评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,440评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,163评论 2 366
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,133评论 2 352

推荐阅读更多精彩内容