深入理解 HashMap

//默认初始容量-必须为2的幂次方
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4;

//最大容量，如果传入的值大于下面的值，则使用下面定义的值
static final int MAXIMUM_CAPACITY = 1 << 30;

//在构造函数中未指定时使用的负载系数（上面提到的负载因子在这里出现了）
//默认加载因子为0.75（当表容量达到3/4时才会再散列）
static final float DEFAULT_LOAD_FACTOR = 0.75f;

//当链表的长度 >= 8的时候，将链表转换成红黑树
static final int TREEIFY_THRESHOLD = 8;

//在resize()扩容的时候，HashMap的数据存储位置会重新进行计算
//在重新就散存储的位置后，当原有的红黑树数量 <= 6 的时候，则将红黑树转换为链表
static final int UNTREEIFY_THRESHOLD = 6;

//为了避免扩容/调整树化阀值之间的冲突，这个值不能 < 4 * TREEIFY_THRESHOLD
static final int MIN_TREEIFY_CAPACITY = 64;

public HashMap(int initialCapacity, float loadFactor) { 

//当指定的 initialCapacity （初始容量） < 0 的时候会抛出 IllegalArgumentException 异常
if (initialCapacity < 0)
throw new IllegalArgumentException("Illegal initial capacity: " +
initialCapacity);
//当指定的 initialCapacity （初始容量）= MAXIMUM_CAPACITY（最大容量） 的时候 
if (initialCapacity > MAXIMUM_CAPACITY)
//初始容量就等于 MAXIMUM_CAPACITY （最大容量）
initialCapacity = MAXIMUM_CAPACITY;
//当 loadFactory（负载因子）< 0 ，或者不是数字的时候会抛出 IllegalArgumentException 异常
if (loadFactor <= 0 || Float.isNaN(loadFactor))
throw new IllegalArgumentException("Illegal load factor: " +
loadFactor);
this.loadFactor = loadFactor;
//tableSizeFor()的主要功能是返回一个比给定整数大且最接近2的幂次方整数
//比如我们给定的数是12，那么tableSizeFor()会返回2的4次方，也就是16，因为16是最接近12并且大于12的数
this.threshold = tableSizeFor(
initialCapacity);
}

//对于给定的目标容量，返回两倍大小的幂
static final int tableSizeFor(int cap) { 

//为了防止cap已经是2的幂次方时，执行完后面的几条无符号右移操作之后
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;
}

//假如在tableSizeFor(int cap)中传入一个12，那么经过下面这句运算之后 n = 11
int n = cap - 1; 
//这个应该不难理解，ok，继续往下看

/** * 1、这又是什么东东？这才是比较懵的吧？那么这句代码如何理解呢？ * 2、通过上面的代码我们可以知道 n 经过运算之后等于 11 * 3、11的二进制为 00001011，>>>是右移的意思，1代表移动一一位。有人又会问了，>>不也是右移吗？这两个有什么区别 呢？这个稍后解释，这里先知道是这么个回事 * | 或操作：意思是把某两个数中, 只要其中一个的某一位为1，则结果的该位就为1 */
n |= n >>> 1;
n |= n >>> 2;
n |= n >>> 4;
n |= n >>> 8;
n |= n >>> 16;

//假设给定的cap值是10，那么n=9，9的二进制为 -> 00001001
n    		    ------------- 00001001
n >>> 1		    ------------- 00000100
n |= n >>> 1     ------------- 00001101

//这里的 n 是接着上个 n 的值，即：
n				------------ 00001101
n >>> 2    		 ------------ 00000011
n |= n >>> 2     ------------ 00001111

/** * 计算key.hashCode（）并扩展（XOR）哈希的更高位降低。 由于该表使用2的幂次掩码，因此仅在当前掩码上方的位上 * 变化的散列将总是相撞。 （其中一些示例是Float键集在小表中保存连续的整数。）所以我们应用变换以扩展较高位的 * 影响向下。 在速度，效用和比特扩散的质量。 因为许多常见的哈希集已经合理分配（因此不要从传播），并且因为我 * 们使用树来处理大量的箱中的碰撞，我们只是将减少系统损失的最便宜的方法，以及合并否则会影响最高位的影响由于 * 表的限制，从不用于索引计算。 */
static final int hash(Object key) { 

int h;
return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}

//这段代码等价于 index = e.hash % newCap
//这也就解释了为什么一定要求cap要为2的幂次方的原因
if (e.next == null){ 

//e代表的是Node类，next代表节点
newTab[e.hash & (newCap - 1)] = e;
}

public class StringDemo { 

//最大容量
static final int MAXIMUM_CAPACITY = 1 << 30;
//这是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;
}
//主函数
public static void main(String[] args) { 

int size = tableSizeFor(10); //比如我们这里传入的数字是10，那么打印的size会是多少呢？
System.out.println(size);
}
}

//构造一个初始容量为 initialCapacity，负载因子为 0.75的HashMap
public HashMap(int initialCapacity) { 
    
this(initialCapacity, DEFAULT_LOAD_FACTOR);
}

//使用默认的初始容量构造一个空的HashMap（16）和默认负载系数（0.75）。
public HashMap() { 

this.loadFactor = DEFAULT_LOAD_FACTOR; 
}

//构造一个和指定Map有相同的mappings的HashMap，初始容量能充足的容下指定的Map，负载因子为0.75
public HashMap(Map<? extends K, ? extends V> m) { 

this.loadFactor = DEFAULT_LOAD_FACTOR;
putMapEntries(m, false);
}

//将m的所有元素存入到该HashMap实例中
final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) { 

//获取 m 中元素的个数
int s = m.size();
//当 m 中有元素的时候，需要将Map中的元素放入此HashMap实例中
if (s > 0) { 

//判断table是否已经初始化，如果table已经初始化，则先初始化一些变量（table的初始化指在put的时候）
if (table == null) { 
 // pre-size
//根据待插入的Map的大小（size）计算要创建的 HashMap 容量
float ft = ((float)s / loadFactor) + 1.0F;
int t = ((ft < (float)MAXIMUM_CAPACITY) ? (int)ft : MAXIMUM_CAPACITY);
//将要创建的 HashMap 容量存在 threshold 中
if (t > threshold)
//threshold是一个整型变量
threshold = tableSizeFor(t);
}
//如果table初始化过了，因为别的函数也会调用到它，所以有可能HashMap已经被初始化过了
//判断待插入的 Map 的 大小（size），如果size > threshold ，则先进行 resize() 扩容
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();
//然后调用 putVal 函数进行元素的插入操作
putVal(hash(key), key, value, false, evict);
}
}
}

/** * 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.) */
//英文看不懂？那就练练英语吧（滑稽）
//官方注释第一句说了table？没错，Node实际上是存储key，value的数组，只不过被Node封装了
transient Node<K,V>[] table;
/** * The number of key-value mappings contained in this map. */
transient int size;
/** * The number of times this HashMap has been structurally modified * Structural modifications are those that change the number of mappings in * the HashMap or otherwise modify its internal structure (e.g., * rehash). This field is used to make iterators on Collection-views of * the HashMap fail-fast. (See ConcurrentModificationException). */
transient int modCount;
/** * The next size value at which to resize (capacity * load factor). * * @serial */
// (The javadoc description is true upon serialization.
// Additionally, if the table array has not been allocated, this
// field holds the initial array capacity, or zero signifying
// DEFAULT_INITIAL_CAPACITY.)
//这个就是上面所说的 tableSizeFor(t) 赋予的值
int threshold;
/** * The load factor for the hash table. * * @serial */
final float loadFactor;

//实现 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;
//如果table为空或者长度为0，则进行resize()（扩容）
if ((tab = table) == null || (n = tab.length) == 0)
n = (tab = resize()).length;
//确定插入table的位置，算法是上面提到的 (n - 1) & hash，在 n 为 2 的时候，相当于取模操作
if ((p = tab[i = (n - 1) & hash]) == null)
//找到key值对应的位置并且是第一个，直接插入
tab[i] = newNode(hash, key, value, null);
//在table的 i 的位置发生碰撞，分两种情况
//1、key值是一样的，替换value值
//2、key值不一样的
//而key值不一样的有两种处理方式：1、存储在 i 的位置的链表 2、存储在红黑树中
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;
else if (p instanceof TreeNode)
e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
else { 

//如果不是TreeNode的话，即为链表，然后遍历链表
for (int binCount = 0; ; ++binCount) { 

//链表的尾端也没有找到key值相同的节点，则生成一个新的Node
//并且判断链表的节点个数是不是到达转换成红黑树的上界达到，则转换成红黑树
if ((e = p.next) == null) { 

//创建链表节点并插入尾部
p.next = newNode(hash, key, value, null);
//超过了链表的设置长度（默认为8）则转换为红黑树
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不为空
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;
}

putVal(int hash, K key, V value, boolean onlyIfAbsent,boolean evict)

static final int hash(Object key) { 

int h;
return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}

if (++size > threshold)
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;
//判断Node的长度，如果不为零
if (oldCap > 0) { 

//判断当前Node的长度，如果当前长度超过 MAXIMUM_CAPACITY（最大容量值）
if (oldCap >= MAXIMUM_CAPACITY) { 

//新增阀值为 Integer.MAX_VALUE
threshold = Integer.MAX_VALUE;
return oldTab;
}
//如果小于这个 MAXIMUM_CAPACITY（最大容量值），并且大于等于 DEFAULT_INITIAL_CAPACITY （默认16）
else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY && oldCap >= DEFAULT_INITIAL_CAPACITY)
//进行2倍扩容
newThr = oldThr << 1; // double threshold
}
else if (oldThr > 0) // initial capacity was placed in threshold
//指定新增阀值
newCap = oldThr;
//如果数组为空
else { 
               // zero initial threshold signifies using defaults
//使用默认的加载因子(0.75)
newCap = DEFAULT_INITIAL_CAPACITY;
//新增的阀值也就为 16 * 0.75 = 12
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;
@SuppressWarnings({ 
"rawtypes","unchecked"})
//扩容后的Node数组
Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
table = newTab;
//如果数组不为空，将原数组中的元素放入扩容后的数组中
if (oldTab != null) { 

for (int j = 0; j < oldCap; ++j) { 

Node<K,V> e;
if ((e = oldTab[j]) != null) { 

oldTab[j] = null;
//如果节点为空，则直接计算在新数组中的位置，放入即可
if (e.next == null)
newTab[e.hash & (newCap - 1)] = e;
else if (e instanceof TreeNode)
//拆分树节点
((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
else { 
 // preserve order
//如果节点不为空，且为单链表，则将原数组中单链表元素进行拆分
Node<K,V> loHead = null, loTail = null;//保存在原有索引的链表
Node<K,V> hiHead = null, hiTail = null;//保存在新索引的链表
Node<K,V> next;
do { 

next = e.next;
//哈希值和原数组长度进行&操作，为0则在原数组的索引位置
//非0则在原数组索引位置+原数组长度的新位置
if ((e.hash & oldCap) == 0) { 

if (loTail == null)
loHead = e;
else
loTail.next = e;
loTail = e;
}
else { 

if (hiTail == null)
hiHead = e;
else
hiTail.next = e;
hiTail = e;
}
} while ((e = next) != null);
if (loTail != null) { 

loTail.next = null;
newTab[j] = loHead;
}
if (hiTail != null) { 

hiTail.next = null;
newTab[j + oldCap] = hiHead;
}
}
}
}
}
return newTab;
}

public V get(Object key) { 

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

final Node<K,V> getNode(int hash, Object key) { 

Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
//这个table与putVal中使用的table是一样的，简单的说就是只要使用了put操作就可以进行get操作
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;
}

public V put(K key, V value) { 

return putVal(hash(key), key, value, false, true);
}

public V remove(Object key) { 

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

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 { 

//此处是一个链表，遍历链表返回node
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;
}

HashMap<String,Integer> hashMap = new HashMap<String,Integer>();
Map<String, Integer> map = Collections.synchronizedMap(hashMap);