HashMap介绍

一、HashMap介绍

1.1 HashMap 特性

* HashMap 存储键值对实现快速存取，允许为 null。key值不可重复，若key值重复则覆盖。
* 非同步，线程不安全。
* 底层是hash表，不保证有序(比如插入的顺序)

1.2 HashMap 底层原理

基于 hashing 的原理，jdk8 后采用数组+链表+红黑树的数据结构。我们通过 put 和 get 存储和获取对象。当我们给 put()方法传递键和值时，先对键做一个 hashCode() 的计算来得到它在 bucket 数组中的位置来存储 Entry对象。当获取对象时，通过 get 获取到 bucket 的位置，再通过键对象的 equals()方法找到正确的键值对，然后在返回值对象。
    
当链表长度大于 TREEIFY_THRESHOLD（默认为8）时，将链表转换为红黑树，当小于 UNTREEIFY_THRESHOLD （默认为6）时，又会转回链表以达到性能均衡。 

1.3 HashMap 结构图

1.4 HashMap 思维导图

二、构造函数

2.1 无参构造函数

// 哈希表使用的负载因子
final float loadFactor;
// 默认负载因子
static final float DEFAULT_LOAD_FACTOR = 0.75f;
// 默认的初始容量-必须为2的幂
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // 也等于 16

// 构建一个初始容量为16，负载因子为 0.75 的 HashMap 对象
public HashMap() {
    this.loadFactor = DEFAULT_LOAD_FACTOR;
    // 其他字段采用默认值
}

2.2 指定初始容量构造函数

// 创建一个指定初始容量，负载因子为 0.75 的 HashMap 对象
public HashMap(int initialCapacity) {
    this(initialCapacity, DEFAULT_LOAD_FACTOR);
}

2.3 指定初始容量和负载因子构造函数

// 最大容量
static final int MAXIMUM_CAPACITY = 1 << 30;
// 阀值（容量*负载系数）
int threshold;

// 创建一个指定初始容量和负载因子的 HashMap 对象
public HashMap(int initialCapacity, float loadFactor) {
    // 判断初始容量不能小于0
    if (initialCapacity < 0)
        throw new IllegalArgumentException("Illegal initial capacity: " +
                                           initialCapacity);
    // 初始容量不能大于最大值
    if (initialCapacity > MAXIMUM_CAPACITY)
        initialCapacity = MAXIMUM_CAPACITY;
    // 负载因子不能等于0并且必须是数字
    if (loadFactor <= 0 || Float.isNaN(loadFactor))
        throw new IllegalArgumentException("Illegal load factor: " +
                                           loadFactor);
    this.loadFactor = loadFactor;
    // 设置真实存储的容量也叫做阀值，当 HashMap 的 size 等于 threshold 时，就需要进行扩容(resize)操作
    this.threshold = tableSizeFor(initialCapacity);
}

查看 tableSizeFor 方法：

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;
}

这个方法的作用是 返回大于输入参数且最近的2的整数次幂的数。

int n = cap - 1;

这是为了防止 cap 已经是2的幂。如果 cap 已经是2的幂， 又没有执行这个减1操作，则执行完后面的几条无符号右移操作之后，返回的 capacity 将是这个 cap 的2倍。
    
如二进制1000，十进制数值为8。如果不对它减1而直接操作，将得到答案10000，即16。减1后二进制为111，再进行操作则会得到原来的数值1000，即8。  

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的二进制为01xxx...xxx。接着

对n右移1位：001xx...xxx，再位或：011xx...xxx

对n右移2为：00011...xxx，再位或：01111...xxx

此时前面已经有四个1了，再右移4位且位或可得8个1

同理，有8个1，右移8位肯定会让后八位也为1。

综上可得，该算法让最高位的1后面的位全变为1。

最后再让结果n+1，即得到了2的整数次幂的值了。

按理我们认为 threshold 的赋值应该是这样的：

this.threshold = tableSizeFor(initialCapacity) * this.loadFactor;

然而实际上却是：

this.threshold = tableSizeFor(initialCapacity);

这是因为在构造方法中，并没有对 table 这个成员变量进行初始化，table 的初始化被推迟到了 put 方法中，在 put 方法中会对 threshold 重新计算。

2.4 根据指定Map构建 Map对象

public HashMap(Map<? extends K, ? extends V> m) {
    this.loadFactor = DEFAULT_LOAD_FACTOR; // 0.75f
    // 将 m 的所有元素存入当前 HashMap 实例中
    putMapEntries(m, false);
}

我们来看下 putMapEntries 方法：

final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
	// 获取 m 中的元素个数
    int s = m.size();
    //当 m 中有元素时，则需将 m 中的元素放入当前 HashMap 实例中
    if (s > 0) {
        // 判断 table 是否已经初始化，如果未初始化，则需要先初始化一些变量。（table初始化是在put时）
        if (table == null) { // pre-size
            // 根据 m 中的元素个数计算要创建的　HashMap 的容量。
            float ft = ((float)s / loadFactor) + 1.0F;
            // 创建的容量不能超过限定最大值 
            int t = ((ft < (float)MAXIMUM_CAPACITY) ?
                     (int)ft : MAXIMUM_CAPACITY);
            // 把要创建的　HashMap 的容量存在　threshold　中
            if (t > threshold)
                threshold = tableSizeFor(t);
        }
        // 如果 table 已经被初始化并且容量小于要存储的元素个数，则需要进行扩容操作
        else if (s > threshold)
            resize();
        // 开始遍历要插入的 map ，将每一个 <Key,Value> 插入到当前 HashMap 实例中
        for (Map.Entry<? extends K, ? extends V> e : m.entrySet()) {
            K key = e.getKey();
            V value = e.getValue();
            // 等同于 put 操作
            putVal(hash(key), key, value, false, evict);
        }
    }
}

三、相关操作方法

3.1 put

在介绍 put 方法前，我们再来了解下 HashMap 其他几个成员变量：

// 实际存储 key,value 的数组，key,value 被封装成 Node 对象，在 put 操作时被初始化
transient Node<K,V>[] table;
// HashMap 中元素的数量
transient int size;
// HashMap 结构修改的次数
transient int modCount;

接下来我们来看下 put 方法：

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

可以看出先对 key 进行 哈希操作，然后再进行存储操作，我们来看下 hash 的行为：

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

可以看出是对 key.hashCode() 进行**与高16位做异或运算 **。

我们在来看下 putVal 方法

final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
               boolean evict) {
    Node<K,V>[] tab; Node<K,V> p; int n, i;
    // 如果 table 为空或者长度为0，则进行初始化操作
    if ((tab = table) == null || (n = tab.length) == 0)
        n = (tab = resize()).length;
    // 根据算法 (n - 1) & hash 获取到数组槽的位置，如果为null 表示是第一个，直接添加
    if ((p = tab[i = (n - 1) & hash]) == null)
        tab[i] = newNode(hash, key, value, null);
    // 如果不为空的话，有如下两种情况：
    // 1. key值是一样的，替换value值
    // 2. key值不一样，判断当前存储结构是链表还是红黑树，然后添加进去
    else {        
        Node<K,V> e; K k;
        // 第一个 node 的 hash 值即为要加入元素的 hash
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            e = p;
        // 如果是红黑树结构，进行 putTreeVal 操作
        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;
            }
        }
        // 如果e不为空就替换旧的oldValue值
        if (e != null) { // existing mapping for key
            V oldValue = e.value;
            if (!onlyIfAbsent || oldValue == null)
                e.value = value;
            afterNodeAccess(e);
            return oldValue;
        }
    }
    // map结构修改次数自增
    ++modCount;
    // map元素个数自增，如果大于阀值则进行扩容操作
    if (++size > threshold)
        resize();
    // 添加节点
    afterNodeInsertion(evict);
    return null;
}

3.2 get

接下来我们看看 get 方法：

public V get(Object key) {
    Node<K,V> e;
    return (e = getNode(hash(key), key)) == null ? null : e.value;
}

可以看到也是先对 key 进行哈希操作，然后获取节点：

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;
}

3.3 remove

public V remove(Object key) {
    Node<K,V> e;
    return (e = removeNode(hash(key), key, null, false, true)) == null ?
        null : e.value;
}

可以看到也是先对 key 进行哈希操作，然后进行删除节点操作：

final Node<K,V> removeNode(int hash, Object key, Object value,
                           boolean matchValue, boolean movable) {
    Node<K,V>[] tab; Node<K,V> p; int n, index;
    if ((tab = table) != null && (n = tab.length) > 0 &&
        (p = tab[index = (n - 1) & hash]) != null) {
        Node<K,V> node = null, e; K k; V v;
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            node = p;
        else if ((e = p.next) != null) {
            if (p instanceof TreeNode)
                node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
            else {
                do {
                    if (e.hash == hash &&
                        ((k = e.key) == key ||
                         (key != null && key.equals(k)))) {
                        node = e;
                        break;
                    }
                    p = e;
                } while ((e = e.next) != null);
            }
        }
        if (node != null && (!matchValue || (v = node.value) == value ||
                             (value != null && value.equals(v)))) {
            if (node instanceof TreeNode)
                ((TreeNode<K,V>)node).removeTreeNode(this, tab, movable);
            else if (node == p)
                tab[index] = node.next;
            else
                p.next = node.next;
            ++modCount;
            --size;
            afterNodeRemoval(node);
            return node;
        }
    }
    return null;
}

四、resize

4.1 什么是扩容

重新计算出所需容器的大小之后重新定义一个新的容器，将原来容器中的元素放入其中。

4.2 什么时候进行扩容操作

* 进行 put 操作时

4.3 代码分析

final Node<K,V>[] resize() {
    // 保存当前 table
    Node<K,V>[] oldTab = table;
    // 保存当前 table 的容量
    int oldCap = (oldTab == null) ? 0 : oldTab.length;
    // 保存当前阈值
    int oldThr = threshold;
    // 初始化新的 table 容量和阈值 
    int newCap, newThr = 0;
    // 当 oldTab > 0 时代表原来的 table 表非空，oldCap 为原表的大小，oldThr(threshold)为 oldCap * load_factor
    if (oldCap > 0) {
        // 如果旧 table 容量已超过最大容量，更新阈值为 Integer.MAX_VALUE(最大整形值)不再做扩容操作
        if (oldCap >= MAXIMUM_CAPACITY) {
            threshold = Integer.MAX_VALUE;
            return oldTab;
        }
        // 设置容量翻倍，使用左移效率更高
        else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                 oldCap >= DEFAULT_INITIAL_CAPACITY)
            newThr = oldThr << 1; // double threshold
    }
    // 在table为空时被调用。oldCap 小于等于 0 且 oldThr 大于0，代表用户创建了一个 HashMap，但是使用的构造函数是有参构造函数，导致 oldTab 为 null，oldCap 为0， oldThr 为用户指定的 HashMap的初始容量
    else if (oldThr > 0) // initial capacity was placed in threshold
        // 当 table 没初始化时，threshold 持有初始容量
        // 还记得 threshold = tableSizeFor(t)方法嘛
        newCap = oldThr;
    // 在table为空被调用。oldCap 小于等于 0 且 oldThr 等于0，用户调用无参构造函数创建的　HashMap，所有值均采用默认值，oldTab（Table）表为空，oldCap为0，oldThr等于0，
    else {               // zero initial threshold signifies using defaults
        newCap = DEFAULT_INITIAL_CAPACITY;
        newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
    }
     // 新阈值为0
    if (newThr == 0) {
        float ft = (float)newCap * loadFactor;
        newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
                  (int)ft : Integer.MAX_VALUE);
    }
    threshold = newThr;
    // 初始化table
    @SuppressWarnings({"rawtypes","unchecked"})
        Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
    table = newTab;
    if (oldTab != null) {
         // 把 oldTab 中的节点　reHash 到　newTab 中去
        for (int j = 0; j < oldCap; ++j) {
            Node<K,V> e;
            if ((e = oldTab[j]) != null) {
                oldTab[j] = null;
                // 若节点是单个节点，直接在 newTab　中进行重定位
                if (e.next == null)
                    newTab[e.hash & (newCap - 1)] = e;
                 // 若节点是TreeNode 节点，要进行 红黑树的 rehash　操作
                else if (e instanceof TreeNode)
                    ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
                 // 若是链表，进行链表的 rehash　操作
                else { // preserve order
                    Node<K,V> loHead = null, loTail = null;
                    Node<K,V> hiHead = null, hiTail = null;
                    Node<K,V> next;
                    // 将同一桶中的元素根据(e.hash & oldCap)是否为0进行分割，分成两个不同的链表，完成 rehash 操作
                    do {
                        next = e.next;
                        // 根据算法　e.hash & oldCap 判断节点位置 rehash　后是否发生改变 最高位==0，这是索引不变的链表。
                        if ((e.hash & oldCap) == 0) {
                            if (loTail == null)
                                loHead = e;
                            else
                                loTail.next = e;
                            loTail = e;
                        }
                         // 最高位==1 （这是索引发生改变的链表）
                        else {
                            if (hiTail == null)
                                hiHead = e;
                            else
                                hiTail.next = e;
                            hiTail = e;
                        }
                    } while ((e = next) != null);
                    // 原bucket位置的尾指针不为空(即还有node)  
                    if (loTail != null) { 
                        // 链表最后得有个null
                        loTail.next = null;
                        // 链表头指针放在新桶的相同下标(j)处
                        newTab[j] = loHead;
                    }
                    if (hiTail != null) {
                        hiTail.next = null;
                         // rehash　后节点新的位置一定为原来基础上加上　oldCap
                        newTab[j + oldCap] = hiHead;
                    }
                }
            }
        }
    }
    return newTab;
}