OpenJDK8 Map相关内容

还记得之前有过源码学习记录，这次重新回顾，还是有一些新的收获。
今天的内容暂不包含JUC包下的Map类型，先上整体的类结构图。

所有的类型实现Map接口，最最常见的是Hashtable和HashMap。其中，Hashtable线程安全（从1.0版本就有），而HashMap非线程安全（1.2版本），下文主要以两者的区分进行源码分析。

1. Hashtable

1.1 数据结构

数组+链表

1.2 初始化

默认容量大小11
默认负载因子0.75

1.3 扩容时机

当put新元素时，先扩容再插入

	private void addEntry(int hash, K key, V value, int index) {
        modCount++;

        Entry<?,?> tab[] = table;
        if (count >= threshold) {
            // 当元素量达到阈值时（容量*0.75），进行rehash扩容操作
            rehash();

            tab = table;
            hash = key.hashCode();
            index = (hash & 0x7FFFFFFF) % tab.length;
        }

        // 头插法添加新的元素
        @SuppressWarnings("unchecked")
        Entry<K,V> e = (Entry<K,V>) tab[index];
        tab[index] = new Entry<>(hash, key, value, e);
        count++;
    }

1.4 扩容大小

源码主要在上面调用的rehash()

	protected void rehash() {
        int oldCapacity = table.length;
        Entry<?,?>[] oldMap = table;

        // 新的容量大小设置，正常情况都是按 newCap=2*oldCap+1
        int newCapacity = (oldCapacity << 1) + 1;
        if (newCapacity - MAX_ARRAY_SIZE > 0) {
            if (oldCapacity == MAX_ARRAY_SIZE)
                return;
            newCapacity = MAX_ARRAY_SIZE;
        }
        Entry<?,?>[] newMap = new Entry<?,?>[newCapacity];

        modCount++;
        threshold = (int)Math.min(newCapacity * loadFactor, MAX_ARRAY_SIZE + 1);
        table = newMap;
        
        // 旧的元素迁移到新分配的newMap中（hash+头插）
        for (int i = oldCapacity ; i-- > 0 ;) {
            for (Entry<K,V> old = (Entry<K,V>)oldMap[i] ; old != null ; ) {
                Entry<K,V> e = old;
                old = old.next;

                int index = (e.hash & 0x7FFFFFFF) % newCapacity;
                e.next = (Entry<K,V>)newMap[index];
                newMap[index] = e;
            }
        }
    }

扩容大小 int newCapacity = (oldCapacity << 1) + 1，即新容量=旧容量*2+1；
之所以要+1，是要尽量保持容量为质数，保证hash分布尽量均匀，以减少发生hash冲突的概率，同时能够减少单个桶内链表的长度；

1.5 遍历方式

支持旧的Enumeration方式（1.0版本既有）；
支持Iterator方式（1.2版本，官方推荐，支持fail-fast）

2. HashMap

2.1 数据结构

数组+链表/红黑树

2.2 初始化

默认容量大小16
默认负载因子0.75

2.3 扩容时机

当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;
        if ((p = tab[i = (n - 1) & hash]) == null)
            // 桶中无节点，直接新建链表节点
            tab[i] = newNode(hash, key, value, null);
        else {
            Node<K,V> e; K k;
            // 桶中刚好存在该key，且就在链表头
            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) {
                    // 现有hashMap中不存在该key
                    if ((e = p.next) == null) {
                        p.next = newNode(hash, key, value, null);
                        // 达到树形化阈值，将桶中元素树形化
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            treeifyBin(tab, hash);
                        break;
                    }
                    // 现有hashMap中已存在该key
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    p = e;
                }
            }
            // 替换原key中的旧值，并返回该旧值
            if (e != null) { 
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e);
                return oldValue;
            }
        }
        ++modCount;
        // 插入新元素后，元素量达到阈值，才执行resize扩容操作
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
    }

2.4 扩容大小

相关逻辑主要在上面调用的resize()方法。

final Node<K,V>[] resize() {
        Node<K,V>[] oldTab = table;
        int oldCap = (oldTab == null) ? 0 : oldTab.length;
        int oldThr = threshold;
        int newCap, newThr = 0;
        if (oldCap > 0) {
            if (oldCap >= MAXIMUM_CAPACITY) {
                threshold = Integer.MAX_VALUE;
                return oldTab;
            }
            // 新的容量大小扩大为原来的2倍
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                     oldCap >= DEFAULT_INITIAL_CAPACITY)
                newThr = oldThr << 1; // double threshold
        }
        else if (oldThr > 0) // initial capacity was placed in threshold
            newCap = oldThr;
        else {               // zero initial threshold signifies using defaults
            newCap = DEFAULT_INITIAL_CAPACITY;
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
        if (newThr == 0) {
            float ft = (float)newCap * loadFactor;
            newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
                      (int)ft : Integer.MAX_VALUE);
        }
        threshold = newThr;
        ...
        // 省略后面的大坨元素rehash步骤，
    }

newCap = oldCap*2,且容量永远为2的幂次大小。
补充点：

1. jdk8中对HashMap的rehash做了优化，通过(e.hash & oldCap)==0来判断将原元素放回原来的j桶还是挪到新的j+oldCap桶中。这也是HashMap保持2的幂次容量的优势所在。感兴趣的话，可以自行服用
2. 同时必须提一点：JDK7之前，resize过程中采用类似Hashtable中的头插法， 这在多线程环境下可能产生链表循环导致死锁，因此JDK8中做了改进，采用尾插法处理桶中元素，避免了死锁。

2.5 遍历方式

只支持Iterator迭代器方式

3. 附上Hashtable与HashMap主要的异同点整理

	Hashtable	HashMap	IdentityHashMap
数据结构	数组+链表	数组+链表/红黑树	数组
默认容量	11	16	64
负载因子	0.75	0.75	-
扩容时机	先扩容再插入	先插入再扩容	先计数再扩容最后插入
扩容大小	2*n+1	2*n	2*n
扩容元素rehash	头插法	尾插法	数组遍历
迭代方式	Enumeration、Iterator	Iterator	-
线程安全性	安全	不安全	不安全

4. jdk8中对Map接口的扩充

	 /**
     * 如果key存在，返回key对应的值；
     * 如果key不存在，返回默认值defaultValue
     * @since 1.8
     */
    default V getOrDefault(Object key, V defaultValue) 

    /**
     * @since 1.8
     */
    default void forEach(BiConsumer<? super K, ? super V> action) 

    /**
     * @since 1.8
     */
    default void replaceAll(BiFunction<? super K, ? super V, ? extends V> function)

    /**
     * 如果key存在，不变，返回原来的值
     * 如果key不存在，设置value值，并返回null
     * @since 1.8
     */
    default V putIfAbsent(K key, V value) 

    /**
     * 如果存在指定键值对（key,value都要一致），删除指定键值对的元素，返回true
     * 如果不存在指定键值对，删除指定键值对的元素，返回false
     * @since 1.8
     */
    default boolean remove(Object key, Object value) 

    /**
     * 根据指定键值对，设置新值
     * @since 1.8
     */
    default boolean replace(K key, V oldValue, V newValue) 

    /**
     * 如果存在key，替换值，返回旧值
     * 如果不存在key，不作操作，返回null
     * @since 1.8
     */
    default V replace(K key, V value) 

    /**
     * @since 1.8
     */
    default V computeIfAbsent(K key, Function<? super K, ? extends V> mappingFunction) 

    /**
     * @since 1.8
     */
    default V computeIfPresent(K key,
            BiFunction<? super K, ? super V, ? extends V> remappingFunction)

    /**
     * @since 1.8
     */
    default V compute(K key,BiFunction<? super K, ? super V, ? extends V> remappingFunction)

     /**
     * @since 1.8
     */
    default V merge(K key, V value, BiFunction<? super V, ? super V, ? extends V> remappingFunction)

5. 其它结构

5.1 LinkedHashMap

继承自HashMap类，其中的Entry元素内部添加了两个指针，分别表示前继元素和后继元素，从而实现带有双向链表的HashMap结构。
主要的三个属性

    /**
     * 双向链表的头节点（最老）
     */
    transient LinkedHashMap.Entry<K,V> head;

    /**
     * 双向链表的尾节点（最新）
     */
    transient LinkedHashMap.Entry<K,V> tail;

    /**
     * 链式hashmap的迭代顺序
     * true 基于访问顺序
     * false 基于插入顺序（默认）
     * 定义为final， 初始化后不能改变，不然计算modCount结构变动次数会乱
     * @serial
     */
    final boolean accessOrder;

其中，可以关注的是accessOrder属性，分为两种模式：

1）true : 基于访问顺序方式。

由于LinkedHashMap重写了父类get及getOrDefault方法，每次get某个key时，会调用afterNodeAccess(e)，将最近查询的节点挪到链表末尾，从而很容易就能实现LRU等类似的缓存逻辑。

 /**
     * 根据键获取值
     * 重写方法，追加访问序时的结构变动记录
     */
    public V get(Object key) {
        Node<K,V> e;
        if ((e = getNode(hash(key), key)) == null)
            return null;
        if (accessOrder)
            afterNodeAccess(e);
        return e.value;
    }

    /**
     * 重写方法，追加访问序时的结构变动记录
     * {@inheritDoc}
     */
    public V getOrDefault(Object key, V defaultValue) {
       Node<K,V> e;
       if ((e = getNode(hash(key), key)) == null)
           return defaultValue;
       if (accessOrder)
           afterNodeAccess(e);
       return e.value;
   }

注意点：
由于每次调用get(Object key)时，LinkedHashMap会将最近访问的元素挪到链表末尾，因此迭代时不能使用get方法，否则会报ConcurrentModifedException.

2）false: 基于插入顺序方式（默认）

链表按key的插入顺序进行维护，更新已有的键值对不会更新现有的链表顺序。

5.2 TreeMap

继承自AbstractMap和SortedMap基于红黑树存储的实现，其中元素顺序遵从key排序，同时支持自定义key的比较器。

  /**
     * 决定节点排序的自定义比较器
     * @serial
     */
    private final Comparator<? super K> comparator;

    /**
     * 红黑树的根节点
     */
    private transient Entry<K,V> root;

因为采用了树形结构，所以并不需要像HashMap和Hashtable中那样的resize及rehash操作。
TreeMap（1.6）提供了一系列方便获取节点的操作，简单列举如下：

	/**
     * 返回小于指定key的元素（键值对）
     * @since 1.6
     */
    public Map.Entry<K,V> lowerEntry(K key)
    /**
     * 返回小于指定key的键
     * @since 1.6
     */
    public K lowerKey(K key) 
    /**
     * 返回小于等于指定key 的最大元素（键值对）
     * @since 1.6
     */
    public Map.Entry<K,V> floorEntry(K key)
    /**
     * 返回小于等于指定key的最大key
     * @since 1.6
     */
    public K floorKey(K key) 
    /**
     * 返回大于等于指定key的最小元素
     * @since 1.6
     */
    public Map.Entry<K,V> ceilingEntry(K key)
    /**
     * 返回大于等于指定key的最小key
     * @since 1.6
     */
    public K ceilingKey(K key)
    /**
     * 返回大于指定key的最小元素
     * @since 1.6
     */
    public Map.Entry<K,V> higherEntry(K key)
    /**
     * 返回大于指定key的最小key
     * @since 1.6
     */
    public K higherKey(K key) 

截取子map操作

/**
     * 截取子map，支持指定左边界、右边界自定义
     * @since 1.6
     */
    public NavigableMap<K,V> subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)
    public NavigableMap<K,V> headMap(K toKey, boolean inclusive)
    public NavigableMap<K,V> tailMap(K fromKey, boolean inclusive)
    public SortedMap<K,V> subMap(K fromKey, K toKey)
    public SortedMap<K,V> headMap(K toKey) 
    public SortedMap<K,V> tailMap(K fromKey)

5.3 IdentityHashMap

继承自AbstractMap，而不是HashMap。主要区别在于其它类型都是针对key的equals方法查找目的元素，而IdentityHashMap是针对key的引用（"=="）查找。

5.3.1 数据结构

采用数组。key和value连着存储，占两个数组索引

5.3.2 初始化

初始化容量（没有实际属性）： 32
初始化table大小： 容量*2

5.3.3 扩容时机

当前元素size*3> table大小时，触发扩容。
总的来说是：先计数，再扩容，最后插入元素

public V put(K key, V value) {
        final Object k = maskNull(key);

        retryAfterResize: for (;;) {
           ...

            // 先计数
            final int s = size + 1;
            // Use optimized form of 3 * s.
            // Next capacity is len, 2 * current capacity.
            // 扩容
            if (s + (s << 1) > len && resize(len))
                continue retryAfterResize;

            modCount++;
            // 插入k-v
            tab[i] = k;
            tab[i + 1] = value;
            size = s;
            return null;
        }
    }

5.3.4 扩容大小

新容量扩为原来的2倍

private boolean resize(int newCapacity) {
        // 新容量扩大为2倍
        int newLength = newCapacity * 2;

        Object[] oldTable = table;
        int oldLength = oldTable.length;
        if (oldLength == 2 * MAXIMUM_CAPACITY) { // can't expand any further
            if (size == MAXIMUM_CAPACITY - 1)
                throw new IllegalStateException("Capacity exhausted.");
            return false;
        }
        if (oldLength >= newLength)
            return false;

        Object[] newTable = new Object[newLength];

        for (int j = 0; j < oldLength; j += 2) {
            Object key = oldTable[j];
            if (key != null) {
                Object value = oldTable[j+1];
                oldTable[j] = null;
                oldTable[j+1] = null;
                int i = hash(key, newLength);
                // 发生hash冲突，往右边遍历找空位
                while (newTable[i] != null)
                    i = nextKeyIndex(i, newLength);
                newTable[i] = key;
                newTable[i + 1] = value;
            }
        }
        table = newTable;
        return true;
    }

---

以上主要是我个人阅读源码的一点记录汇总，不得不说整理还是比较耗时间的，我人又不是那么勤快，所以每次只能弄一部分。
如果内容有所纰漏，请及时指出，我会及时修正，谢谢！