HashMap源代码阅读

Posted 2020-09-11 brucemengbm

Map类结构

Java的集合类主要由两个接口派生出来，Collection和Map，上一节我们讨论过Collection接口结构，如今来看下Map接口。

HashMap	一种存储键/值关联的数据结构
Hashtable	一种用synchronized包裹其内部方法的映射表。保证线程安全
TreeMap	一种有序排列的映射表
EnumMap	一种属于枚举类型的映射表，枚举类型元素集的高效实现，採用位序列实现
LinkedHashMap	一种能够记住键/值加入顺序的映射表
WeakHashMap	一种其值无用武之地能够被垃圾回收器回收的映射表
IdentityHashMap	一种用==而不是equals比較键值的映射表

HashMap

HashMap中get和put操作平均是常数时间，元素能平均的映射到每个桶中。遍历映射表的性能和其容量成正相关。若须要保证遍历的高性能，映射表的初始大小不能太大以及装填因子不能设置太小。

HashMap有两个因素影响其性能：初始容量和装填因子，容量指的是映射表中桶的数量，装填因子用于衡量映射表装满的程度。当映射表中元素数量超过装填因子和当前容量的乘积时，映射表将会加倍其容量，并对元素进化重hash操作。

默认装填因子是0.75。能在时间和空间上保持一个较好的平衡。

若有大量元素须要增加HashMap，初始化一个足够大的映射表来容纳这些元素，其性能比让HashMap自己主动扩容和重哈希效率要高。

HashMap的实现是非synchronized。其相应同步版本号是Hashtable，多线程环境下须要保证映射表没有产生并发的结构改动(包含加入和删除元素)。若须要并发改动容器结构。须要保证同步改动散列表的结构，或者能够採用Collections.synchronizedMap(new HashMap(...))。

HashMap的实现

类定义

public class HashMap<K,V>
    extends AbstractMap<K,V>
    implements Map<K,V>, Cloneable, Serializable

成员

HashMap实际是一个数组，数组中每一个元素都是一个链表。

static final float DEFAULT_LOAD_FACTOR = 0.75f; //默认装填因子
/**
 * The table, resized as necessary. Length MUST Always be a power of two.
 */
transient Entry[] table;
transient int size;
/**
 * The next size value at which to resize (capacity * load factor).
 */
int threshold;
final float loadFactor; 

• 哈希表table，注意其长度必须是2的幂，这和採用hash算法有关系。

  一般採用取模运算index = hash_code % size保证元素在合理范围，可是取模运算效率不高。JDK採用了更快的算法，这个更快的算法源于一个数学规律，size是2的N次方，那么数X对size的模运算结果等价于X和size-1的按位与运算。也就是 X % size <=> X & (size -1)。

• threshold阈值等于capacity * load factor，超过阈值时须要加倍扩容并重哈希，注意loadFactor声明为final设置以后不能改动。

内部类Entry实际是一个链表，定义例如以下。

static class Entry<K,V> implements Map.Entry<K,V> {
    final K key;
    V value;
    Entry<K,V> next;
    final int hash;
}

方法

构造方法，能够看到数组的大小保证为2的幂且不小于initialCapacity

public HashMap(int initialCapacity, float loadFactor) {
    if (initialCapacity < 0)
        throw new IllegalArgumentException("Illegal initial capacity: " +
                                           initialCapacity);
    if (initialCapacity > MAXIMUM_CAPACITY)
        initialCapacity = MAXIMUM_CAPACITY;
    if (loadFactor <= 0 || Float.isNaN(loadFactor))
        throw new IllegalArgumentException("Illegal load factor: " +
                                           loadFactor);
    // Find a power of 2 >= initialCapacity
    int capacity = 1;
    while (capacity < initialCapacity) //保证capacity为2的幂。且不小于initialCapacity
        capacity <<= 1;

    this.loadFactor = loadFactor;
    threshold = (int)(capacity * loadFactor);
    table = new Entry[capacity];
    init(); //empty function
}

put方法。JDK中没有直接用key的hash code而是再对其进行一次hash计算保证值尽可能分散，通过取模运算找到table中相应的位置，并加入该位置的链表头部。若存在同样元素(hash code相等、equals为true)，则直接替换原来值。

public V put(K key, V value) {
    if (key == null)
        return putForNullKey(value); //key为null元素放在table[0]位置
    int hash = hash(key.hashCode()); //对key的hash code再进行hash计算
    int i = indexFor(hash, table.length); //找到table中应当加入的位置[0,length)
    for (Entry<K,V> e = table[i]; e != null; e = e.next) {
        Object k;
        if (e.hash == hash && ((k = e.key) == key || key.equals(k))) {//替换同样元素
            V oldValue = e.value;
            e.value = value;
            e.recordAccess(this);
            return oldValue;
        }
    }
    modCount++;
    addEntry(hash, key, value, i); //都是加入加在头部
    return null;
}

static int indexFor(int h, int length) {
    return h & (length-1); //高效的hash取代h % length
}

void addEntry(int hash, K key, V value, int bucketIndex) {
    Entry<K,V> e = table[bucketIndex];
    table[bucketIndex] = new Entry<K,V>(hash, key, value, e);
    if (size++ >= threshold)
        resize(2 * table.length);
}

加入元素后size++。并推断是否须要扩容，每次扩容都是原来大小的两倍(扩容后大小相同也是2的幂)。扩容以后元素转移到新的table中。table中每一个链表元素实际被逆置了。

void resize(int newCapacity) {
    Entry[] oldTable = table;
    int oldCapacity = oldTable.length;
    if (oldCapacity == MAXIMUM_CAPACITY) {
        threshold = Integer.MAX_VALUE;
        return;
    }
    Entry[] newTable = new Entry[newCapacity];
    transfer(newTable);
    table = newTable;
    threshold = (int)(newCapacity * loadFactor);
}

/**
 * Transfers all entries from current table to newTable.
 */
void transfer(Entry[] newTable) {
    Entry[] src = table;
    int newCapacity = newTable.length;
    for (int j = 0; j < src.length; j++) {
        Entry<K,V> e = src[j];
        if (e != null) {
            src[j] = null;
            do {
                Entry<K,V> next = e.next;
                int i = indexFor(e.hash, newCapacity);
                e.next = newTable[i];
                newTable[i] = e; //e总是加在头部
                e = next;
            } while (e != null);
        }
    }
}

get方法，事实上put方法中也有get的逻辑，先通过hash找到在table中位置，然后再在链表中查找。

public V get(Object key) {
    if (key == null)
        return getForNullKey();
    int hash = hash(key.hashCode());
    for (Entry<K,V> e = table[indexFor(hash, table.length)];
         e != null; e = e.next) {
        Object k;
        if (e.hash == hash && ((k = e.key) == key || key.equals(k)))
            return e.value;
    }
    return null;
}

remove方法，也是先通过hash找到table中位置。然后在链表中删除对应元素。

public V remove(Object key) {
    Entry<K,V> e = removeEntryForKey(key);
    return (e == null ? null : e.value);
}

final Entry<K,V> removeEntryForKey(Object key) {
    int hash = (key == null) ? 0 : hash(key.hashCode());
    int i = indexFor(hash, table.length);
    Entry<K,V> prev = table[i]; 
    Entry<K,V> e = prev;
    while (e != null) {
        Entry<K,V> next = e.next;
        Object k;
        if (e.hash == hash &&
            ((k = e.key) == key || (key != null && key.equals(k)))) {
            modCount++;
            size--;
            if (prev == e) //删除链表头
                table[i] = next;
            else
                prev.next = next;
            e.recordRemoval(this);
            return e;
        }
        prev = e;
        e = next;
    }

    return e;
}

HashMap的视图

集合框架并没有把散列表当作一个集合。Map本身是一个顶层接口。只是提供了3个集合类视图：键集合、值集合、键值对集合。分别相应keySet()、values()、entrySet()三个方法的返回值。

在抽象父类AbstractMap中定义了键集和值集的引用。因为这些视图是无状态的。不是必需每次都又一次创建。

ketSet方法返回一个内部类HashMap$KeySet实例。其本身并没有不论什么成员和数据结构。都是直接引用外部类的属性和方法来完毕相关操作(因此是stateless)。

transient volatile Set<K>        keySet = null;
transient volatile Collection<V> values = null; //define in AbstractMap
private transient Set<Map.Entry<K,V>> entrySet = null; //define in HashMap

public Set<K> keySet() {
    Set<K> ks = keySet;
    return (ks != null ?
 ks : (keySet = new KeySet()));
}

private final class KeySet extends AbstractSet<K> {
    public Iterator<K> iterator() {
        return newKeyIterator();
    }
    public int size() {
        return size;
    }
    public boolean contains(Object o) {
        return containsKey(o);
    }
    public boolean remove(Object o) {
        return HashMap.this.removeEntryForKey(o) != null;
    }
    public void clear() {
        HashMap.this.clear();
    }
}

KeySet的迭代器返回内部类KeyIterator实例，其继承自HashIterator,实际HashIterator实现了整个Entry的迭代，首先找到table中第一个不为空的元素。遍历下一个元素的时候，先推断当前位置所在链表有没有后继节点。有的话往后遍历。否则继续到table中找下一个非空元素。

实际三个视图的迭代器都是其子类，仅仅是next返回值不同，可能是key、value或entry。

Iterator<K> newKeyIterator()   {
    return new KeyIterator();
}

private final class KeyIterator extends HashIterator<K> {
    public K next() {
        return nextEntry().getKey();
    }
}

private final class ValueIterator extends HashIterator<V> {
    public V next() {
        return nextEntry().value;
    }
}

private final class EntryIterator extends HashIterator<Map.Entry<K,V>> {
    public Map.Entry<K,V> next() {
        return nextEntry();
    }
}

private abstract class HashIterator<E> implements Iterator<E> {
    Entry<K,V> next;    // next entry to return
    int expectedModCount;   // For fast-fail
    int index;      // current slot
    Entry<K,V> current; // current entry

    HashIterator() {
        expectedModCount = modCount;
        if (size > 0) { // advance to first entry
            Entry[] t = table;
            while (index < t.length && (next = t[index++]) == null)
                ;
        }
    }

    public final boolean hasNext() {
        return next != null;
    }

    final Entry<K,V> nextEntry() {
        if (modCount != expectedModCount)
            throw new ConcurrentModificationException();
        Entry<K,V> e = next;
        if (e == null)
            throw new NoSuchElementException();
        if ((next = e.next) == null) { //table[index]链表下一个为空
            Entry[] t = table;
            while (index < t.length && (next = t[index++]) == null) //table中循环找下一个不为空
                ;
        }
        current = e;
        return e;
    }
}

两位两个视图值集合values()和键值对集合entrySet()不一一介绍，注意一点值集合是Collectiont<V>对象。键值对集合是Set<Map.Entry<K,V>>对象。

private final class Values extends AbstractCollection<V> { 
        ... 
}
private final class EntrySet extends AbstractSet<Map.Entry<K,V>> {
        ... 
}

总结

1. HashMap本身是一个有数组和链表组成的数据结构，其插入和查找元素的消耗能够看成O(1)。默认散列表内部数组大小保证为2的幂次，因为内部採用了位运算取代了传统取模运算来确定元素插入位置。
2. HashMap性能由散列表的容量和装填因子两部分决定，当中装填因子默认是0.75。容量默认是16。
3. Map是独立接口，并不是Collection子接口。可是提供三个集合类视图：键集合、值集合、键值对集合。分别相应keySet()、values()、entrySet()三个方法的返回值，这三个集合视图是无状态的，本身依赖Map实例本身。遍历元素能够依据须要採用集合类相应的迭代器进行迭代。迭代支持fail-fast。