LinkedHashMap 底层分析_链表

众所周知 HashMap 是一个无序的 ​Map​​,因为每次根据 ​key​​ 的 ​hashcode​​ 映射到 ​Entry​ 数组上,所以遍历出来的顺序并不是写入的顺序。

因此 JDK 推出一个基于 ​HashMap​​ 但具有顺序的 ​LinkedHashMap​ 来解决有排序需求的场景。

它的底层是继承于 ​HashMap​ 实现的,由一个双向链表所构成。

LinkedHashMap​ 的排序方式有两种:

  • 根据写入顺序排序。
  • 根据访问顺序排序。

其中根据访问顺序排序时,每次 ​get​ 都会将访问的值移动到链表末尾,这样重复操作就能的到一个按照访问顺序排序的链表。

数据结构

  1.    @Test
  2.    public void test(){
  3.        Map<String, Integer> map = new LinkedHashMap<String, Integer>();
  4.        map.put("1",1) ;
  5.        map.put("2",2) ;
  6.        map.put("3",3) ;
  7.        map.put("4",4) ;
  8.        map.put("5",5) ;
  9.        System.out.println(map.toString());

  10.    }

调试可以看到 ​map​ 的组成:

LinkedHashMap 底层分析_构造方法_02

打开源码可以看到:

  1.    /**
  2.     * The head of the doubly linked list.
  3.     */
  4.    private transient Entry<K,V> header;

  5.    /**
  6.     * The iteration ordering method for this linked hash map: <tt>true</tt>
  7.     * for access-order, <tt>false</tt> for insertion-order.
  8.     *
  9.     * @serial
  10.     */
  11.    private final boolean accessOrder;

  12.    private static class Entry<K,V> extends HashMap.Entry<K,V> {
  13.        // These fields comprise the doubly linked list used for iteration.
  14.        Entry<K,V> before, after;

  15.        Entry(int hash, K key, V value, HashMap.Entry<K,V> next) {
  16.            super(hash, key, value, next);
  17.        }
  18.    }  

其中 ​Entry​​ 继承于 ​HashMap​​ 的 ​Entry​,并新增了上下节点的指针,也就形成了双向链表。

还有一个 ​header​ 的成员变量,是这个双向链表的头结点。

上边的 demo 总结成一张图如下:

LinkedHashMap 底层分析_链表_03

第一个类似于 ​HashMap​​ 的结构,利用 ​Entry​​ 中的 ​next​ 指针进行关联。

下边则是 ​LinkedHashMap​ 如何达到有序的关键。

就是利用了头节点和其余的各个节点之间通过 ​Entry​​ 中的 ​after​​ 和 ​before​ 指针进行关联。

其中还有一个 ​accessOrder​​ 成员变量,默认是 ​false​​,默认按照插入顺序排序,为 ​true​ 时按照访问顺序排序,也可以调用:

  1.    public LinkedHashMap(int initialCapacity,
  2.                         float loadFactor,
  3.                         boolean accessOrder) {
  4.        super(initialCapacity, loadFactor);
  5.        this.accessOrder = accessOrder;
  6.    }

这个构造方法可以显示的传入 ​accessOrder​。

构造方法

LinkedHashMap​ 的构造方法:

  1.    public LinkedHashMap() {
  2.        super();
  3.        accessOrder = false;
  4.    }

其实就是调用的 ​HashMap​ 的构造方法:

HashMap​ 实现:

  1.    public HashMap(int initialCapacity, float loadFactor) {
  2.        if (initialCapacity < 0)
  3.            throw new IllegalArgumentException("Illegal initial capacity: " +
  4.                                               initialCapacity);
  5.        if (initialCapacity > MAXIMUM_CAPACITY)
  6.            initialCapacity = MAXIMUM_CAPACITY;
  7.        if (loadFactor <= 0 || Float.isNaN(loadFactor))
  8.            throw new IllegalArgumentException("Illegal load factor: " +
  9.                                               loadFactor);

  10.        this.loadFactor = loadFactor;
  11.        threshold = initialCapacity;
  12.        //HashMap 只是定义了改方法,具体实现交给了 LinkedHashMap
  13.        init();
  14.    }

可以看到里面有一个空的 ​init()​​,具体是由 ​LinkedHashMap​ 来实现的:

  1.    @Override
  2.    void init() {
  3.        header = new Entry<>(-1, null, null, null);
  4.        header.before = header.after = header;
  5.    }

其实也就是对 ​header​ 进行了初始化。

put() 方法

看 ​LinkedHashMap​​ 的 ​put()​​ 方法之前先看看 ​HashMap​​ 的 ​put​ 方法:

  1.    public V put(K key, V value) {
  2.        if (table == EMPTY_TABLE) {
  3.            inflateTable(threshold);
  4.        }
  5.        if (key == null)
  6.            return putForNullKey(value);
  7.        int hash = hash(key);
  8.        int i = indexFor(hash, table.length);
  9.        for (Entry<K,V> e = table[i]; e != null; e = e.next) {
  10.            Object k;
  11.            if (e.hash == hash && ((k = e.key) == key || key.equals(k))) {
  12.                V oldValue = e.value;
  13.                e.value = value;
  14.                //空实现,交给 LinkedHashMap 自己实现
  15.                e.recordAccess(this);
  16.                return oldValue;
  17.            }
  18.        }
  19.        modCount++;
  20.        // LinkedHashMap 对其重写
  21.        addEntry(hash, key, value, i);
  22.        return null;
  23.    }
  24.    // LinkedHashMap 对其重写
  25.    void addEntry(int hash, K key, V value, int bucketIndex) {
  26.        if ((size >= threshold) && (null != table[bucketIndex])) {
  27.            resize(2 * table.length);
  28.            hash = (null != key) ? hash(key) : 0;
  29.            bucketIndex = indexFor(hash, table.length);
  30.        }
  31.        createEntry(hash, key, value, bucketIndex);
  32.    }
  33.    // LinkedHashMap 对其重写
  34.    void createEntry(int hash, K key, V value, int bucketIndex) {
  35.        Entry<K,V> e = table[bucketIndex];
  36.        table[bucketIndex] = new Entry<>(hash, key, value, e);
  37.        size++;
  38.    }      

主体的实现都是借助于 ​HashMap​​ 来完成的,只是对其中的 ​recordAccess(),addEntry(),createEntry()​进行了重写。

LinkedHashMap​ 的实现:

  1.        //就是判断是否是根据访问顺序排序,如果是则需要将当前这个 Entry 移动到链表的末尾
  2.        void recordAccess(HashMap<K,V> m) {
  3.            LinkedHashMap<K,V> lm = (LinkedHashMap<K,V>)m;
  4.            if (lm.accessOrder) {
  5.                lm.modCount++;
  6.                remove();
  7.                addBefore(lm.header);
  8.            }
  9.        }


  10.    //调用了 HashMap 的实现,并判断是否需要删除最少使用的 Entry(默认不删除)    
  11.    void addEntry(int hash, K key, V value, int bucketIndex) {
  12.        super.addEntry(hash, key, value, bucketIndex);

  13.        // Remove eldest entry if instructed
  14.        Entry<K,V> eldest = header.after;
  15.        if (removeEldestEntry(eldest)) {
  16.            removeEntryForKey(eldest.key);
  17.        }
  18.    }

  19.    void createEntry(int hash, K key, V value, int bucketIndex) {
  20.        HashMap.Entry<K,V> old = table[bucketIndex];
  21.        Entry<K,V> e = new Entry<>(hash, key, value, old);
  22.        //就多了这一步,将新增的 Entry 加入到 header 双向链表中
  23.        table[bucketIndex] = e;
  24.        e.addBefore(header);
  25.        size++;
  26.    }

  27.        //写入到双向链表中
  28.        private void addBefore(Entry<K,V> existingEntry) {
  29.            after  = existingEntry;
  30.            before = existingEntry.before;
  31.            before.after = this;
  32.            after.before = this;
  33.        }  

get 方法

LinkedHashMap 的 ​get()​ 方法也重写了:

  1.    public V get(Object key) {
  2.        Entry<K,V> e = (Entry<K,V>)getEntry(key);
  3.        if (e == null)
  4.            return null;

  5.        //多了一个判断是否是按照访问顺序排序,是则将当前的 Entry 移动到链表末尾  
  6.        e.recordAccess(this);
  7.        return e.value;
  8.    }

clear()​ 清空就要比较简单了:

  1.    //只需要把指针都指向自己即可,原本那些 Entry 没有引用之后就会被 JVM 自动回收。
  2.    public void clear() {
  3.        super.clear();
  4.        header.before = header.after = header;
  5.    }

总结

总的来说 ​LinkedHashMap​​ 其实就是对 ​HashMap​ 进行了拓展,使用了双向链表来保证了顺序性。

因为是继承与 ​HashMap​​ 的,所以一些 ​HashMap​​ 存在的问题 ​LinkedHashMap​ 也会存在,比如不支持并发等。

号外

最近在总结一些 Java 相关的知识点,感兴趣的朋友可以一起维护。

地址: https://github.com/crossoverJie/Java-Interview