Java 集合框架源码分析(四)——LinkedHashMap

介绍

  今天我们继续Java集合框架探究之旅,来看LinkedHashMap 。和HashMap 相比,LinkedHashMap实际使用频率要低点,但并不意味它不重要,其实LinkedHashMap 是实现LRU缓存的首选方案,在 《Android LruCache 实现原理解析》一文中,简单分析了LruCache 利用LinkedHashMap 实现内存缓存的原理。当然只知道怎么用肯定对于我们来说是不够的,下面就详细分析一下这个集合类的实现。

LinkedHashMap 类层次结构如下

   LinkedHashMap是HashMap的子类,同时实现了Serializable 和 Cloneable接口,支持序列化克隆。 注意,LinkedHashMap也不是同步的,只适合单线程访问(也可以从下面的源码中得到验证,实际没有任何一处操作进行了同步加锁)。

LinkedHashMap 源码

以下是LinkedHashMap的源码(基于Sun JDK 1.7).

package java.util;
import java.io.*;

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

    private static final long serialVersionUID = 3801124242820219131L;

    //双向循环链表的头结点,整个LinkedHashMap中只有一个header, 
    //它将哈希表中所有的Entry贯穿起来,header中不保存key-value对,只保存前后节点的引用 
    private transient Entry<K,V> header;

    //双向链表中元素排序规则的标志位。 
    //accessOrder为false,表示按插入顺序排序 
    //accessOrder为true,表示按访问顺序排序 
    private final boolean accessOrder;

   //调用HashMap的构造方法来构造底层的数组 
    public LinkedHashMap(int initialCapacity, float loadFactor) {
        super(initialCapacity, loadFactor);
        accessOrder = false;
    }

     //加载因子取默认的0.75f 
    public LinkedHashMap(int initialCapacity) {
        super(initialCapacity);
        accessOrder = false;
    }

    //加载因子取默认的0.75f,容量取默认的16 
    public LinkedHashMap() {
        super();
        accessOrder = false;
    }

    //含有子Map的构造方法,同样调用HashMap的对应的构造方法 
    public LinkedHashMap(Map<? extends K, ? extends V> m) {
        super(m);
        accessOrder = false;
    }

    //该构造方法可以指定链表中的元素排序的规则

    public LinkedHashMap(int initialCapacity,
                         float loadFactor,
                         boolean accessOrder) {
        super(initialCapacity, loadFactor);
        this.accessOrder = accessOrder;
    }

    //覆写父类的init()方法(HashMap中的init方法为空), 
    //该方法在父类的构造方法和Clone、readObject中在插入元素前被调用, 
    //初始化一个空的双向循环链表,头结点中不保存数据,头结点的下一个节点才开始保存数据。
    @Override
    void init() {
        header = new Entry<>(-1, null, null, null);
        header.before = header.after = header;
    }

   //覆写HashMap中的transfer方法,它在父类的resize方法中被调用, 
    //扩容后,将key-value对重新映射到新的newTable中 
    //覆写该方法的目的是为了提高复制的效率, 
    //这里充分利用双向循环链表的特点进行迭代,不用对底层的数组进行for循环。 
    @Override
    void transfer(HashMap.Entry[] newTable, boolean rehash) {
        int newCapacity = newTable.length;
        for (Entry<K,V> e = header.after; e != header; e = e.after) {
            if (rehash)
                e.hash = (e.key == null) ? 0 : hash(e.key);
            int index = indexFor(e.hash, newCapacity);
            e.next = newTable[index];
            newTable[index] = e;
        }
    }


   //覆写HashMap中的containsValue方法, 
    //覆写该方法的目的同样是为了提高查询的效率, 
    //利用双向循环链表的特点进行查询,少了对数组的外层for循环
    public boolean containsValue(Object value) {
        // Overridden to take advantage of faster iterator
        if (value==null) {
            for (Entry e = header.after; e != header; e = e.after)
                if (e.value==null)
                    return true;
        } else {
            for (Entry e = header.after; e != header; e = e.after)
                if (value.equals(e.value))
                    return true;
        }
        return false;
    }

   //覆写HashMap中的get方法,通过getEntry方法获取Entry对象。 
    //注意这里的recordAccess方法, 
    //如果链表中元素的排序规则是按照插入的先后顺序排序的话,该方法什么也不做, 
    //如果链表中元素的排序规则是按照访问的先后顺序排序的话,则将e移到链表的末尾处。
    public V get(Object key) {
        Entry<K,V> e = (Entry<K,V>)getEntry(key);
        if (e == null)
            return null;
        e.recordAccess(this);
        return e.value;
    }

    //清空HashMap,并将双向链表还原为只有头结点的空链表
    public void clear() {
        super.clear();
        header.before = header.after = header;
    }

    //Enty的数据结构,多了两个指向前后节点的引用 
    private static class Entry<K,V> extends HashMap.Entry<K,V> {
        // These fields comprise the doubly linked list used for iteration.
        Entry<K,V> before, after;

         //调用父类的构造方法 
        Entry(int hash, K key, V value, HashMap.Entry<K,V> next) {
            super(hash, key, value, next);
        }

         //双向循环链表中,删除当前的Entry 
        private void remove() {
            before.after = after;
            after.before = before;
        }

        //双向循环立链表中,将当前的Entry插入到existingEntry的前面
        private void addBefore(Entry<K,V> existingEntry) {
            after  = existingEntry;
            before = existingEntry.before;
            before.after = this;
            after.before = this;
        }

        //覆写HashMap中的recordAccess方法(HashMap中该方法为空), 
        //当调用父类的put方法,在发现插入的key已经存在时,会调用该方法, 
        //调用LinkedHashmap覆写的get方法时,也会调用到该方法, 
        //该方法提供了LRU算法的实现,它将最近使用的Entry放到双向循环链表的尾部, 
        //accessOrder为true时,get方法会调用recordAccess方法 
        //put方法在覆盖key-value对时也会调用recordAccess方法 
        //它们导致Entry最近使用,因此将其移到双向链表的末尾 
        void recordAccess(HashMap<K,V> m) {
            LinkedHashMap<K,V> lm = (LinkedHashMap<K,V>)m;
            //如果链表中元素按照访问顺序排序,则将当前访问的Entry移到双向循环链表的尾部, 
            //如果是按照插入的先后顺序排序,则不做任何事情。
            if (lm.accessOrder) {
                lm.modCount++;
                remove();
                addBefore(lm.header);
            }
        }

        void recordRemoval(HashMap<K,V> m) {
            remove();
        }
    }
     //迭代器 
    private abstract class LinkedHashIterator<T> implements Iterator<T> {
        Entry<K,V> nextEntry    = header.after;
        Entry<K,V> lastReturned = null;

        /** * The modCount value that the iterator believes that the backing * List should have. If this expectation is violated, the iterator * has detected concurrent modification. */
        int expectedModCount = modCount;

        public boolean hasNext() {
            return nextEntry != header;
        }

        public void remove() {
            if (lastReturned == null)
                throw new IllegalStateException();
            if (modCount != expectedModCount)
                throw new ConcurrentModificationException();

            LinkedHashMap.this.remove(lastReturned.key);
            lastReturned = null;
            expectedModCount = modCount;
        }
          //从head的下一个节点开始迭代 
        Entry<K,V> nextEntry() {
            if (modCount != expectedModCount)
                throw new ConcurrentModificationException();
            if (nextEntry == header)
                throw new NoSuchElementException();

            Entry<K,V> e = lastReturned = nextEntry;
            nextEntry = e.after;
            return e;
        }
    }
     //key迭代器 
    private class KeyIterator extends LinkedHashIterator<K> {
        public K next() { return nextEntry().getKey(); }
    }
      //value迭代器 
    private class ValueIterator extends LinkedHashIterator<V> {
        public V next() { return nextEntry().value; }
    }
    //Entry迭代器 
    private class EntryIterator extends LinkedHashIterator<Map.Entry<K,V>> {
        public Map.Entry<K,V> next() { return nextEntry(); }
    }

    // These Overrides alter the behavior of superclass view iterator() methods
    Iterator<K> newKeyIterator()   { return new KeyIterator();   }
    Iterator<V> newValueIterator() { return new ValueIterator(); }
    Iterator<Map.Entry<K,V>> newEntryIterator() { return new EntryIterator(); }

     //覆写HashMap中的addEntry方法,LinkedHashmap并没有覆写HashMap中的put方法, 
    //而是覆写了put方法所调用的addEntry方法和recordAccess方法, 
    //put方法在插入的key已存在的情况下,会调用recordAccess方法, 
    //在插入的key不存在的情况下,要调用addEntry插入新的Entry 
    void addEntry(int hash, K key, V value, int bucketIndex) {
        super.addEntry(hash, key, value, bucketIndex);

      //如果有必要,则删除掉该近期最少使用的节点, 
        //这要看对removeEldestEntry的覆写,由于默认为false,因此默认是不做任何处理的。
        Entry<K,V> eldest = header.after;
        if (removeEldestEntry(eldest)) {
            removeEntryForKey(eldest.key);
        }
    }


    void createEntry(int hash, K key, V value, int bucketIndex) {
      //创建新的Entry,并将其插入到数组对应槽的单链表的头结点处,这点与HashMap中相同 
        HashMap.Entry<K,V> old = table[bucketIndex];
        Entry<K,V> e = new Entry<>(hash, key, value, old);
        table[bucketIndex] = e;
        //每次插入Entry时,都将其移到双向链表的尾部, 
        //这便会按照Entry插入LinkedHashMap的先后顺序来迭代元素, 
        //同时,新put进来的Entry是最近访问的Entry,把其放在链表末尾 ,符合LRU算法的实现 
        e.addBefore(header);
        size++;
    }

  //该方法是用来被覆写的,一般如果用LinkedHashmap实现LRU算法,就要覆写该方法, 
    //比如可以将该方法覆写为如果设定的内存已满,则返回true,这样当再次向LinkedHashMap中put 
    //Entry时,在调用的addEntry方法中便会将近期最少使用的节点删除掉(header后的那个节点)。
    protected boolean removeEldestEntry(Map.Entry<K,V> eldest) {
        return false;
    }
}

重点解析

1.原理图

为了便于理解,我画了一张图,简单描述一下LinkedHashMap的结构

Java 集合框架源码分析(四)——LinkedHashMap_第1张图片
如上图所示,假设LinkedHashMap put(K,V)操作依次为A,B,C,D,E,F,G,H,I,G,K,L,那么数组加 单链表部分,则描述了HashMap的存储方式,而LinkedHashMap则结合了LinkedList和HashMap的优点,为每个Entry链表结点增加了前驱和后继,并增加了一个为null头结点,构造了一个双向循环链表,每次put进来Entry,除了将其保存到对哈希表中对应的位置上外,还要将其插入到双向循环链表的尾部。

2. K,V要求

LinkedHashMap由于继承自HashMap,因此它具有HashMap的所有特性,同样允许key和value为null。

3. accessOrder标志位

注意源码中的accessOrder标志位,
为false时,表示双向链表中的元素按照Entry插入LinkedHashMap到中的先后顺序排序,即每次put到LinkedHashMap中的Entry都放在双向链表的尾部,这样遍历双向链表时,Entry的输出顺序便和插入的顺序一致,这也是默认的双向链表的存储顺序;

为true时,表示双向链表中的元素按照访问的先后顺序排列,可以看到,虽然Entry插入链表的顺序依然是按照其put到LinkedHashMap中的顺序,但put和get方法均有调用recordAccess方法(put方法在key相同,覆盖原有的Entry的情况下调用recordAccess方法),该方法判断accessOrder是否为true,如果是,则将当前访问的Entry(put进来的Entry或get出来的Entry)移到双向链表的尾部(key不相同时,put新Entry时,会调用addEntry,它会调用creatEntry,该方法同样将新插入的元素放入到双向链表的尾部,既符合插入的先后顺序,又符合访问的先后顺序,因为这时该Entry也被访问了),否则,什么也不做。

4. removeEldestEntry方法说明

 protected boolean removeEldestEntry(Map.Entry<K,V> eldest) {
        return false;
    }
}

该方法默认返回false,我们一般在用LinkedHashMap实现LRU算法时,要覆写该方法,一般的实现是,当设定的内存(这里指节点个数)达到最大值时,返回true,这样put新的Entry(该Entry的key在哈希表中没有已经存在)时,就会调用removeEntryForKey方法,将最近最少使用的节点删除(head后面的那个节点,实际上是最近没有使用)。

5.LRU(Least Recent Used)实现方式

最后说说LinkedHashMap是如何实现LRU的。
首先,当accessOrder为true时,才会开启按访问顺序排序的模式,才能用来实现LRU算法。我们可以看到,无论是put方法还是get方法,都会导致目标Entry成为最近访问的Entry,因此便把该Entry加入到了双向链表的末尾(get方法通过调用recordAccess方法来实现,put方法在覆盖已有key的情况下,也是通过调用recordAccess方法来实现,在插入新的Entry时,则是通过createEntry中的addBefore方法来实现),这样便把最近使用了的Entry放入到了双向链表的后面,多次操作后,双向链表前面的Entry便是最近没有使用的,这样当节点个数满的时候,删除的最前面的Entry(head后面的那个Entry)便是最近最少使用的Entry。

你可能感兴趣的:(java,源码,android,框架,缓存)