java集合系列十：LinkedHashMap源码解析

你应该先阅读java集合系列一：前传

你应该先看HashMap

介绍

• 扩展HashMap类并实现了Map接口
• 哈希表+链表实现
• 有序的
• 键和值可以是任何类型，包括null
• 非线程安全的
• 具有fail-fast机制

继承关系 继承类介绍

继承自HashMap类并实现了Map接口

变量解析(所有代码都不是完整的源码,而是精简过后的源码！结合源码食用更佳)

由于其继承自HashMap,所以HashMap的一些参数对于LinkedHashMap也是一样,比如默认初始容量capacity及加载因子load factor等等.

  //双链表的头
  transient LinkedHashMap.Entry<K,V> head;
  //双链表的尾
  transient LinkedHashMap.Entry<K,V> tail;
  //排序模式
  //true:add或get等操作后 节点将移动到双链表尾部
  //false:默认值 不做任何改变
  final boolean accessOrder;

源码解析 常用方法解析

LinkedHashMap.Entry<K,V>,双链表

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

put(K key, V value)

在使用LinkedHashMap调用put时,该put方法是继承自其父类HashMap的,由于在HashMap中已经详细分析了put流程,这里就只关注关于LinkedHashMap的几个方法.newNode(),在HashMap中通过newNode方法来创建一个Node节点,在LinkedHashMap中它重写了这个方法,如下 ：

   //生成双链表的节点
  Node<K,V> newNode(int hash, K key, V value, Node<K,V> e) {
    LinkedHashMap.Entry<K,V> p =
        new LinkedHashMap.Entry<K,V>(hash, key, value, e);
    linkNodeLast(p);
  }

 //将此节点添加到链表尾部
 private void linkNodeLast(LinkedHashMap.Entry<K,V> p) {
      //记录此时双链表的最后一个节点 目的是往其指针after上链接p 假设模拟第一次put(下同) 此时last = null
    LinkedHashMap.Entry<K,V> last = tail;
    //记录下p 作为双链表的尾节点
    tail = p;
    // 判断是否是第一次使用双链表 满足条件则双链表的头指针指向p  此时p为first节点
    if (last == null)
        head = p;
    else {
        //假设此时不是第一次put了,else将满足条件,p是当前put生成的节点,它的上一个节点指针before指向当前双链表的last节点
        //last节点指针after也指向当前put生成的节点,也就完成将p添加到链表尾部的目的
		//当迭代时直接通过head.after即可保证元素是按插入顺序迭代
        p.before = last;
        last.after = p;
    }
  }

同时在put方法中还有两个方法需要讲一下afterNodeAccess，afterNodeInsertion
afterNodeAccess(Node<K,V> e)
作用:将e移动到双链表的尾部
不止put。还有add或get等操作后也会调用该方法,默认不启用因为accessOrder为false

//将节点移动到双链表尾部
void afterNodeAccess(Node<K,V> e) { // move node to last
      /当前双链表的最后一个节点 也就是tail
    LinkedHashMap.Entry<K,V> last;
    //判断是否具备移动的条件 accessOrder = true,或e已经是尾部节点
    if (accessOrder && (last = tail) != e) {
    //p = 当前待移动的节点e(下文统称为e)， b = e的上一个节点， a = e的下一个节点
        LinkedHashMap.Entry<K,V> p = (LinkedHashMap.Entry<K,V>)e, b = p.before, a = p.after;
        //将e的下一个节点指针置为null
        p.after = null;
        //判断e的上一个节点是否为null
        if (b == null)
            //说明e就是首节点 但是e肯定存在下一个节点 则将head指向a
            head = a;
        else
            //反之e的上一个节点的after指针将指向e的下一个节点
            b.after = a;
        //判断e的下一个节点是否为null
        if (a != null)
            //不为null e的下一个节点的a.before指针将指向e的上一个节点
            a.before = b;
        else
            //这里永远都走不到吧！因为a如果为null的话 e就是last节点了
            last = b;
         //最后判断last是否为null
        if (last == null)
            head = p;
        else {
            //将当前e的before指针指向last，last将作为它的上一个节点
            p.before = last;
            //last的after指针将指向e 此时就完成了e移动到双链表尾部的任务
            last.after = p;
        }
        //尾部指针重新赋值e
        tail = p;
        ++modCount;
    }
}

脑壳疼…其实就是换个位置,但是由于需要判断是否存在前后节点的问题,多了一些判断,而且它名字起的很随意,a.b.e.p的…只要知道是移位到双链表尾部就可以了,默认使用LinkedHashMap是不会开启这个功能的

afterNodeInsertion

作用：用于在put()等操作后(主要是put)删除双链表的首节点，默认不启用,启用需要继承LinkedHashMap重写removeEldestEntry方法,需要注意removeEldestEntry()一定要写条件比如size超过100后允许删除,直接返回true会导致每次put都删除

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

remove(Object key)

和put一样,remove也是其父类HashMap的方法,流程都一样,这里重点关注afterNodeRemoval这个方法

afterNodeRemoval

 //在链表中移除此节点,对e的上一个节点和e的下一个节点建立联系
void afterNodeRemoval(Node<K,V> e) { // unlink
    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;
}

replace(K key, V value)

此方法也是继承自HashMap，内部除了一个afterNodeAccess(e);其他和HashMap一致,而这个方法在上面也分析过了

get(Object key)

此方法被LinkedHashMap重写，虽然重写了get方法，但是逻辑是没变的，只是从三元改为普通的if,多一个afterNodeAccess,而这个方法在上面也分析过了

扩展知识点

• LinkedHashMap在Glide中的应用(Android知识)
  在Glide的LruCache中是这样使用的:

  private final LinkedHashMap<T, Y> cache = new LinkedHashMap<>(100, 0.75f, true);

它在构造中指定accessOrder为true，这个在上面已经分析过了,这样后续get对应图片之后,此图片就会移位到缓存的尾部,这样就形成了经常使用的图片永远都在尾部,不经常用的永远都在首部,再看下它的删除方法，

	 protected synchronized void trimToSize(int size) {
	    Map.Entry<T, Y> last;
	    while (currentSize > size) {
	      last = cache.entrySet().iterator().next();
	      final Y toRemove = last.getValue();
	      currentSize -= getSize(toRemove);
	      final T key = last.getKey();
	      cache.remove(key);
	      onItemEvicted(key, toRemove);
	    }
	}

由于LinkedHashMap是迭代有序的,可以看到遍历删除顶部的元素，删除长度由size控制,注意这里通过在循环内部获取迭代器可以避免并发异常,但是成本是每次都需要构建新的迭代器！