HashMap

JDK 1.8

HashMap 是 Map 实现中最常使用数据结构。下面将从 HashMap 的具体实现入手探究其内部原理，主要从以下几个方面入手：

1. 内部存储结构；
2. 初始化过程；
3. 元素的插入；
4. 元素的获取；

内部结构

内部的存储结构是一个 Node 数组，并且看注释上说明：数组会在 HashMap 第一次使用时初始化；数组在必要的时候会做扩容；数组长度会保持为2的幂次。

/**
 * The table, initialized on first use, and resized as
 * necessary. When allocated, length is always a power of two.
 * (We also tolerate length zero in some operations to allow
 * bootstrapping mechanics that are currently not needed.)
 */
transient Node<K,V>[] table;

Node 实现了 Map.Entry 接口，其数据字段：

• hash hash(key) 键的 hash 值，用于寻址
• key 键
• value 值
• next 解决碰撞时的引用

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

    Node(int hash, K key, V value, Node<K,V> next) {
        this.hash = hash;
        this.key = key;
        this.value = value;
        this.next = next;
    }

    public final K getKey()        { return key; }
    public final V getValue()      { return value; }
    public final String toString() { return key + "=" + value; }

    public final int hashCode() {
        return Objects.hashCode(key) ^ Objects.hashCode(value);
    }

    public final V setValue(V newValue) {
        V oldValue = value;
        value = newValue;
        return oldValue;
    }

    public final boolean equals(Object o) {
        if (o == this)
            return true;
        if (o instanceof Map.Entry) {
            Map.Entry<?,?> e = (Map.Entry<?,?>)o;
            if (Objects.equals(key, e.getKey()) &&
                Objects.equals(value, e.getValue()))
                return true;
        }
        return false;
    }
}

初始化过程

无参构造函数

public HashMap() {
    this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
}

发现构造函数里面并没有对上面提到的Node<K,V>[] table进行初始化，只是设置了一个默认的负载因子。

put()

实际上，HashMap 的初始化发生在第一次使用的时候（第一次调用put()），下面是put()的实现：

public V put(K key, V value) {
    return putVal(hash(key), key, value, false, true);
}

hash(key)

实际上调用的 putVal(...)，这个方法需要计算健的hash值，这个hash值将用于后续元素在数组中位置的计算中，这也是为什么作为 HashMap 的键的类一定要重写其 hashcode() 函数。

static final int hash(Object key) {
    int h;
    return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}

hash 值的算法（(h = key.hashCode()) ^ (h >>> 16)）主要是基于数组长度是2的n次幂考虑，为了减少冲突。

putVal(...)

在putVal(...)中进行数据插入时才真正的开始初始化。

• (1) : 第一次调用，table 为空，因此进入 resize 阶段
• (2) : resize() 的过程才是真正的初始化过程
• (3) : 超过阀值也会重新计算数组大小

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) // (1)
        n = (tab = resize()).length;                    // (2)
    // 省略...
    if (++size > threshold)         // (3)
        resize();
    // 省略...
    
}

resize()

• (0) : threshold 是根据初始化指定的容量计算得来，具体计算过程参考 tableSizeFor(initCapacity)，无参构造函数下大小为 16；
• (1) : 第一次初始化时 newCap 就是这个值；
• (2) : 新的阀值计算方式，通过负载因子计算得来；

final Node<K,V>[] resize() {
    Node<K,V>[] oldTab = table;
    int oldCap = (oldTab == null) ? 0 : oldTab.length;
    int oldThr = threshold; // (0)
    int newCap, newThr = 0;
    if (oldCap > 0) {
        // ...
    }
    else if (oldThr > 0) // (1) 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) { // (2)
        float ft = (float)newCap * loadFactor;
        newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ? (int)ft : Integer.MAX_VALUE);
    }
    threshold = newThr;
    @SuppressWarnings({"rawtypes","unchecked"})
    Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
    table = newTab;
    // ...
    return newTab;
}

tableSizeFor(initCapacity)

前面我们知道，不带参数的构造函数将会将 HashMap 的大小阈值 threshold 设置成默认值16。但是在带参数的构造函数中，HashMap 需要计算这个阈值以保证 HashMap 的大小为2的整数次幂。

/**
 * Returns a power of two size for the given target capacity.
 */
static final int tableSizeFor(int cap) {
    int n = cap - 1;
    n |= n >>> 1;
    n |= n >>> 2;
    n |= n >>> 4;
    n |= n >>> 8;
    n |= n >>> 16;
    return (n < 0) ? 1 : (n >= MAXIMUM_CAPACITY) ? MAXIMUM_CAPACITY : n + 1;
}

n 分为三种情况：

• n < 0 ：计算出的值将为1；
• n = 0 ：计算出的值将为1；
• n > 0 ：上面的计算方法将会将所有位从低至高置成连续的1，最后的 n+1 将保证 capacity 大小为2的整数次幂。

tableSizeFor(-1) = 1
tableSizeFor(0) = 1
tableSizeFor(1) = 1
tableSizeFor(3) = 4
tableSizeFor(4) = 4
tableSizeFor(5) = 8
tableSizeFor(10) = 16
tableSizeFor(30) = 32
tableSizeFor(1048576) = 1048576

到这里基本上了解了 HashMap 的初始化过程，不带参数和带参数的构造函数的区别，下面我们来看看看 HashMap 的 put(...) 过程是什么样的。

put(...) 操作

前面提到 HashMap 其实是在第一次 put(...) 操作时进行的初始化操作，put() 方法实际调用了 putVal() 方法。

final V putVal(int hash, K key, V value, boolean onlyIfAbsent, boolean evict) {
    Node<K,V>[] tab;    // 指向 table 数组引用
    Node<K,V> p;        // p: 指向 table[i] 的值
    int n, i;           // n: 当前 table 的大小；i: 计算出的 value 存放在数组中的位置 
    if ((tab = table) == null || (n = tab.length) == 0)     // (1)
        n = (tab = resize()).length;
    if ((p = tab[i = (n - 1) & hash]) == null)              // (2)
        tab[i] = newNode(hash, key, value, null);
    else {                                                  // (3)
        Node<K,V> e; 
        K k;
        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) {
                if ((e = p.next) == null) {
                    p.next = newNode(hash, key, value, null);
                    if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                        treeifyBin(tab, hash);
                    break;
                }
                if (e.hash == hash && ((k = e.key) == key || (key != null && key.equals(k))))
                    break;
                p = e;
            }
        }
        if (e != null) { // existing mapping for key
            V oldValue = e.value;
            if (!onlyIfAbsent || oldValue == null)
                e.value = value;
            afterNodeAccess(e);
            return oldValue;
        }
    }
    ++modCount;
    if (++size > threshold)
        resize();
    afterNodeInsertion(evict);
    return null;
}

• (1) 判断 table 数组是否为空（也就是是否是第一次调用该方法），这里也会对 tab 和 n 临时变量赋值；
  • true: 对数组进行初始化操作，也就是前面我们提到的内容
  • false: 表示数组已经初始化
• (2) 通过算法 (n-1)&hash(key) 来确定当前要放入的 value 的位置，并取得该位置上的值判断是否为空；
  • == null: 表示该位置上还没有放入过值，直接放入一个新建的 Node 对象
  • != null: 表示该位置上已经放入过值，需要处理碰撞
• (3) 处理碰撞
  • IF 满足p.hash == hash && p.key == key || (key != null && key.equals(p.key)) 也就是说当插入元素与碰撞位置的元素 hash(key) 相同，并且 key 也相同时，认为他们是同一个元素。这里我们在将自定义对象作为 HashMap 键的时候一定要重写其 hashCode() 函数，并且还要保证hashCode相同的两个对象 equlas() 应该也为 true。
  • IF 当不满足上面的条件，并且碰撞位置的元素是一个 TreeNode，将向树中插入元素。（通常我们知道 HashMap 处理冲突的方式是链表，但是当碰撞元素过多时，HashMap 采用的是树的方式处理）
  • ELSE 这里将遍历碰撞链表，判断方式和第一步相同，但是，当链表元素超过 TREEIFY_THRESHOLD 时，将会采用树的存储方式来处理冲突，这也是为什么会存在第二种 IF 条件的原因。

关于 HashMap 中树的部分，可以继续追踪其源码，这里暂不做深究

get(...) 操作

get操作相对简单，它实际调用的是 getNode(...) 方法。

final Node<K,V> getNode(int hash, Object key) {
    Node<K,V>[] tab; 
    Node<K,V> first, e; 
    int n; 
    K k;
    if ((tab = table) != null && (n = tab.length) > 0 && (first = tab[(n - 1) & hash]) != null) {
        if (first.hash == hash && // always check first node
            ((k = first.key) == key || (key != null && key.equals(k))))
            return first;
        if ((e = first.next) != null) {
            if (first instanceof TreeNode)
                return ((TreeNode<K,V>)first).getTreeNode(hash, key);
            do {
                if (e.hash == hash &&
                    ((k = e.key) == key || (key != null && key.equals(k))))
                    return e;
            } while ((e = e.next) != null);
        }
    }
    return null;
}