【Java集合】HashMap的tableSizeFor()源码详解

目录

一、HashMap的四个构造方法

二、tableSizeFor方法

2.1 算法原理

2.2 算法演示

2.3 总结

---

tableSizeFor()是在HashMap的构造方法中被调用过的方法，首先我们先来简单讲一下构造方法。

一、HashMap的四个构造方法

HashMap 中有四个构造方法，它们分别如下：

/**
 * 默认构造函数。 默认初始容量是16和负载因子是0.75
 */
public HashMap() {
    this.loadFactor = DEFAULT_LOAD_FACTOR; // all   other fields defaulted
}

/**
 * 包含另一个“Map”的构造函数，包含另一个Map的映射，如果被映射的Map是一个null会抛出空指针异常。负载因子是默认的
 * 直接传入存储了要添加进HashMap的key-value对的map，来构造HashMap
 */
public HashMap(Map<? extends K, ? extends V> m) {
	//将默认的负载因子赋值给成员变量loadFactor
    this.loadFactor = DEFAULT_LOAD_FACTOR;
	//调用PutMapEntries()来完成HashMap的初始化赋值过程
    putMapEntries(m, false);//下面会分析到这个方法
}

/**
 * 指定“容量大小”的构造函数，直接使用默认负载因子0.75
 */
public HashMap(int initialCapacity) {
    this(initialCapacity, DEFAULT_LOAD_FACTOR);
}


/**
* 构造一个空的HashMap并指定初始容量和负载因子。
* 要注意HashMap源码里面并没有专门的一个属性来存储数组的容量，而是通过threshold来简介限制数组容量的
* 通过将自定义初始化数组容量传入tableSizeFor()方法，计算得出initialCapacity容量大小应该对应的阈值threshold大小
* 这样当数组内元素数大于threshold，就会触发扩容操作，间接限定了数组容量大小
**/
public HashMap(int initialCapacity, float loadFactor) {
    //如果初始容量小于0，抛出非法参数异常
    if (initialCapacity < 0)
        throw new IllegalArgumentException("Illegal initial capacity: " + initialCapacity);
    //如果初始容量大于最大的容量也就是2^30,那么就按照最大的初始容量赋值。
    if (initialCapacity > MAXIMUM_CAPACITY)
        initialCapacity = MAXIMUM_CAPACITY;
    //如果负载因子小于0或者是NaN（float NaN = 0.0f / 0.0f;）也会抛出非法参数异常
    if (loadFactor <= 0 || Float.isNaN(loadFactor))
        throw new IllegalArgumentException("Illegal load factor: " + loadFactor);
    
    // 设置重载因子
    this.loadFactor = loadFactor;
    // 调用tableSizeFor方法计算出不小于initialCapacity的最小的2的幂的结果，并赋给成员变量threshold
    // 注意，这里赋给threshold并不是扩容阈值，只是临时赋值。
    //此时HashMap还没有创建数组，当插入数据的时候会判断该HashMap是否已经初始化，那个时候就会执行resize()方法进行一次扩容,就会重新计算一正确的扩容阈值赋值给threshold
    this.threshold = tableSizeFor(initialCapacity);
}

1. 此处仅用于接收初始容量大小（capacity）、加载因子(Load factor)，但仍无真正初始化哈希表（即初始化存储数组table），仅仅是声明了HashMap对象。
2. 此处先给出结论：真正初始化哈希表（初始化存储数组table）是在第1次添加键值对时，即第1次调用put（）时。下面会详细说明

二、tableSizeFor方法

/**
 * 计算出大于等于参数的第一个2的幂次方
 * 例如：1返回1，3返回4，8返回8，9返回16，125返回128，
 * 如果参数大于默认最大值，则容量取默认最大值。
 */
static final int tableSizeFor(int cap) {
    int n = cap - 1;      //容量减1，为了防止初始化容量已经是2的幂的情况，最后有+1运算。如果cap已经是2的幂， 又没有执行这个减1操作，则执
                                                // 行完后面的几条无符号右移操作之后，返回的capacity将是这个cap的2倍。
    n |= n >>> 1;         //将n无符号右移一位再与n做或操作
    n |= n >>> 2;         //将n无符号右移两位再与n做或操作
    n |= n >>> 4;         //将n无符号右移四位再与n做或操作
    n |= n >>> 8;         //将n无符号右移八位再与n做或操作
    n |= n >>> 16;        //将n无符号右移十六位再与n做或操作
    //如果入参cap为小于或等于0的数，那么经过cap-1之后n为负数，n经过无符号右移和或操作后仍未负 
    //数,所以如果n<0,则返回1;如果n大于或等于最大容量，则返回最大容量;否则返回n+1
    return (n < 0) ? 1 : (n >= MAXIMUM_CAPACITY) ? MAXIMUM_CAPACITY : n + 1;
}

其中：

a |= b  即为 a = a|b

>>>  是无符号右移运算符  无论正负，右移后，高位填充0

2.1 算法原理

要理解这个方法的核心，关键在于中间五步移位加上或运算。

这个算法的原理：2的整数幂用二进制表示都是最高有效位为1，其余全是0，比如十进制8和32，下图只用了一个字节示意。

对任意十进制数转换为2的整数幂，结果是这个数本身的最高有效位的前一位变成1，最高有效位以及其后的位都变为0。

通过上面理论基础，我们可以得出该算法的核心思想是，先将最高有效位以及其后的位都变为1，最后再+1，就进位到前一位变成1，其后所有的满2变0。所以关键是如何将最高有效位后面都变为1。

2.2 算法演示

下面用图来进行演示。这里将十进制的25转换为32。

作者的做法是先移位，再或运算。

右移一位，再或运算，就有两位变为1；

右移两位，再或运算，就有四位变为1…

最后右移16位再或运算，保证32位的int类型整数最高有效位之后的位都能变为1.

全过程示意图

初始容量-1

之所以在开始移位前先将容量-1，是为了避免给定容量已经是8,16这样2的幂时，不减一直接移位会导致得到的结果比预期大。比如预期16得到应该是16，直接移位的话会得到32。在上图中就是所有x本身已经是0的情况下，不减1得到的结果变大了。

初始值

选取任意int类型数字，下图x表示不确定0或者1.

我们目的是将所有的x变为1，如下图

最后+1，就能进位得到2的整数幂。

我们要做的就是不断通过右移+或运算来达到目的。

右移一位+或运算

可以看出，右移一位再或运算，有两位变成了1。

右移二位+或运算

右移两位再或运算，有四位变成了1。

右移四位+或运算

右移四位再或运算，有八位变成了1。

右移八位+或运算

右移八位再或运算，有十六位变成了1。

右移十六位+或运算

右移十六位再或运算，注意这里不是三十二位全变，而是最高位后面的全变1。

结果+1

可以看出，不管x是多少，我们都能将其转换为1。而且分别经过1,2,4,8,16次转换，不管这个int类型值多大，我们都会将其转换，只是值较小时，可能多做几次无意义操作。

2.3 总结

这个方法之所以高效，是因为移位运算和或运算都属于比较底层的操作，代码的数量不会比最终的指令数多，也就是通过几个简单操作实现了我们的目的。但其实第一次看HashMap这个构造方法的时候，有一些不理解，就是为什么传入的指定初始容量initialCapacity，通过计算得到了大于等于initialCapacity的第一个2的幂次方，这个值就应该是HashMap容量capacity。然而却把这个capacity赋值给了threshold。

this.threshold = tableSizeFor(initialCapacity);

开始就觉得这里写很奇怪，觉得应该是这样写：

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

觉得这样才符合threshold的意思（当HashMap的size到达threshold这个阈值时会扩容）。 

但是后来才意识到在构造方法中，并没有对table这个成员变量进行初始化，table的初始化被推迟到了put方法中，在put方法中会对threshold重新计算。这个源码在后面会详细讲解。

---

参考资料：https://www.cnblogs.com/xiyixiaodao/p/14483876.html