HashMap 源码解读(JDK 1.8)

  1. 1. 概述
  2. 2. 相关名词
    1. 2.1. capacity
    2. 2.2. loadFactor
    3. 2.3. threshold
  3. 3. 源码解析

概述

HashMap 是我们常用的集合之一,其数据是键值对的格式存储的,底层使用的链表数组实现的,当某个链表的长度达到一定长度时,会优先对数组链表进行扩容,当链表数组达到一定的长度后,便会将链表转换为红黑树。我们常使用的方法有的 put、get、containsKey、containsValue 等,接下来我们会通过源码解析来了解他是如何实现的。但凡有理解偏差,也希望各位不要吝啬,尽情指出,共同成长~

相关名词

capacity

链表数组长度,默认值 16,且值必须为 2 的幂次方,可以在创建 HashMap 时进行设置,如果创建 HashMap 时设置的不是 2 的幂次方,便会将数组长度设置为大于该值的 2 的幂次方。

loadFactor

负载系数,通过该值来计算出扩容阈值(threshold)。

threshold

扩容阈值,当 map 的大小(键值对的映射数量)大于等于该值的时候,便会对链表数组进行扩容,具体计算公式为 capacity * loadFactor = threshold

源码解析

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
public class HashMap<K,V> extends AbstractMap<K,V> 
implements Map<K,V>, Cloneable, Serializable {
/**
* 链表数组默认初始化长度
*/
static final int DEFAULT_INITIAL_CAPACITY = 16;

/**
* 链表数组的最大长度,达到该长度后,链表数组将不再进行扩容
*/
static final int MAXIMUM_CAPACITY = 1 << 30;

/**
* 负载系数默认值
*/
static final float DEFAULT_LOAD_FACTOR = 0.75f;

/**
* 链表转换为红黑树的阈值,如果某个链表的长度超过该阈值,
* 链表便会转换为红黑树
*/
static final int TREEIFY_THRESHOLD = 8;

/**
* 红黑树转换为链表的阈值,如果某个红黑树的节点个数超过该值,
* 便会将红黑树转换为链表,例如移除数据导致某个红黑树的节点
* 小于该值,便会将其转换为链表
*/
static final int UNTREEIFY_THRESHOLD = 6;

/**
* 链表转换为红黑树的条件之一,数组长度大于等于该阈值
*/
static final int MIN_TREEIFY_CAPACITY = 64;


/**
* HashMap 存储数据使用的链表类
*/
static class Node<K,V> implements Map.Entry<K,V> {
/**
* key 的 hash 值
*/
final int hash;
/**
* map 的 key
*/
final K key;
/**
* map 的 value
*/
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;
}
}

/**
* 获取 key 的哈希值,具体逻辑如下
* 如果 key 为空,返回 0
* 如果 key 不为空, key 的 hascode 记为 a,a 无符号位移 16 位记为 b,
* 然后返回 a 跟 b 位异运算的值。
* Java 各种位运算解析参考 https://blog.zhangyong.io/java-bit-operations/
*/
static final int hash(Object key) {
int h;
return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}

/**
* 如果 x 实现了 Comparable 接口,则返回 x 的真实类型
* 否则返回 null
*/
static Class<?> comparableClassFor(Object x) {
if (x instanceof Comparable) {
Class<?> c; Type[] ts, as; Type t; ParameterizedType p;
if ((c = x.getClass()) == String.class) // bypass checks
return c;
if ((ts = c.getGenericInterfaces()) != null) {
for (int i = 0; i < ts.length; ++i) {
if (((t = ts[i]) instanceof ParameterizedType) &&
((p = (ParameterizedType)t).getRawType() ==
Comparable.class) &&
(as = p.getActualTypeArguments()) != null &&
as.length == 1 && as[0] == c) // type arg is c
return c;
}
}
}
return null;
}

/**
* 如果 x 跟 x 都实现了 Comparable 且类型相同,则调用 compareTo 比较大小并返回结果,
* 否则返回 0
*/
@SuppressWarnings({"rawtypes","unchecked"}) // for cast to Comparable
static int compareComparables(Class<?> kc, Object k, Object x) {
return (x == null || x.getClass() != kc ? 0 :
((Comparable)k).compareTo(x));
}

/**
* 根据数组长度计算扩容阈值
*/
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;
}

/**
* 存放数据的链表数组,本篇文章中所说的数组基本都是链表数组
*/
transient Node<K,V>[] table;

/**
* 键值对映射个数,map 容量
*/
transient int size;

/**
* 内部结构被改变的次数,例如 修改了键值对的映射个数或者以其他方式修改了内部结构,
* 例如重新hash,该字段主要用于在进行遍历时快速失败。(渣渣翻译,可否准确........)
*/
transient int modCount;

/**
* 扩容阈值,当 map 的大小超过该值,便会对数组进行扩容
*/
int threshold;

/**
* 负载系数,链表数组长度 * 负载系数 = 扩容阈值
*/
final float loadFactor;

/**
* 构造方法,指定链表数组长度和负载系数,构造方法中没有直接初始化链表数组,
* 而是通过 capacity 计算出了扩容阈值,然后在第一次 put 数据的时候,进行
* 初始化链表数组长度,而长度直接等于扩容阈值。该构造函数只做了两件事:
* 1. 设置负载系数。
* 2. 根据是初始化的长度设置扩容阈值,扩容阈值始终是 大于等于 capacity 的
* 2 的幂次方
*
*/
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);
// 设置负载系数
this.loadFactor = loadFactor;
// 计算扩容阈值
this.threshold = tableSizeFor(initialCapacity);
}

/**
* 构造方法,指定链表数组长度
*/
public HashMap(int initialCapacity) {
this(initialCapacity, DEFAULT_LOAD_FACTOR);
}

/**
* 默认构造方法,所有成员变量均为默认值
*/
public HashMap() {
this.loadFactor = DEFAULT_LOAD_FACTOR;
}

/**
* 构造方法,传入一个另一个 Map,将数据导入到新生成的 Map 中
*/
public HashMap(Map<? extends K, ? extends V> m) {
this.loadFactor = DEFAULT_LOAD_FACTOR;
// 调用 putall 的实现方法
putMapEntries(m, false);
}

/**
* putall 的实现方法
*/
final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
// 参数 map 的长度赋值给临时变量 s
int s = m.size();
// 判断是否是一个空 map
if (s > 0) {
// 如果是一个空 map,则计算出这个新 map 的扩容阈值,然后在第一次 put 数据
// 的时候初始化链表数组,长度便是这个扩容阈值,这里初始化 map 的逻辑是跟调
// 用指定 capacity 的构造方法的逻辑是一致的。
if (table == null) {
// 计算出新 map 的扩容阈值(也就是链表数组的长度)
float ft = ((float)s / loadFactor) + 1.0F;
// 限定最大不能超过长度阈值
int t = ((ft < (float)MAXIMUM_CAPACITY) ?
(int)ft : MAXIMUM_CAPACITY);
// 如果新的扩容阈值大于当前扩容阈值,才会将当前扩容阈值设置为新的扩容阈值,
// 防止链表数组长度缩短
if (t > threshold)
// 得出正确的扩容阈值(链表数组长度),必须为 2 的幂次方
threshold = tableSizeFor(t);
} else if (s > threshold) {
// 如果不为空,且参数 map 的大小超过了扩容阈值,那么也进行扩容。
resize();
}
// 循环调用 putVal 方法插入数据
for (Map.Entry<? extends K, ? extends V> e : m.entrySet()) {
K key = e.getKey();
V value = e.getValue();
putVal(hash(key), key, value, false, evict);
}
}
}

/**
* 获取键值对映射个数
*/
public int size() {
return size;
}

/**
* 判断 map 是否为空
*/
public boolean isEmpty() {
return size == 0;
}

/**
* 通过 key 获取值
*/
public V get(Object key) {
Node<K,V> e;
// 将 key 进行 hash,然后通过 key 的 hash 值跟 key 获取链表节点,
// 然后返回链表节点中存储 value
return (e = getNode(hash(key), key)) == null ? null : e.value;
}

/**
* 通过 key 的 hash 值跟 key 获取链表节点
* @param hash key 的 hah 值
* @param key key
* @return key 对应的链表节点
*/
final Node<K,V> getNode(int hash, Object key) {
// 当前链表数组
Node<K,V>[] tab;
// key 所在数组位置中对应的链表头部
Node<K,V> first,
// 循环遍历链表时用到的临时变量
Node<K,v> e;
// 当前链表数组的长度
int n;
// 临时变量 key
K k;
// 将当前链表数组及其长度赋值给临时变量,并检验数组不为空,以及所在数组位置的链表不为空
if ((tab = table) != null && (n = tab.length) > 0 &&
(first = tab[(n - 1) & hash]) != null) {
// 校验是是否是链表的头部,如果是进行查询的 key,则直接返回,否则进行链表遍历
if (first.hash == hash &&
((k = first.key) == key || (key != null && key.equals(k)))) {
return first;
}
// 赋值链表的下一个节点给临时变量,并校验链表的下一个不为空,
// 如果为空则表示不存在该 key 不存在,直接返回 null
if ((e = first.next) != null) {
// 如果是红黑树,则遍历红黑树
if (first instanceof TreeNode) {
return ((TreeNode<K,V>)first).getTreeNode(hash, key);
}
// 循环遍历整个链表
do {
// 如果 hash 相等且 key 相等,则返回该节点
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))
return e;
} while ((e = e.next) != null);
}
}
return null;
}

/**
* 判断 key 是否存在
*/
public boolean containsKey(Object key) {
return getNode(hash(key), key) != null;
}

/**
* 插入数据
*
* @param key 被插入数据的 key
* @param value 被插入数据的值
* @return 如果key存在返回key对应的旧值,否则返回 null
*/
public V put(K key, V value) {
return putVal(hash(key), key, value, false, true);
}

/**
* 插入数据实现
*
* @param hash key 的 hash 值
* @param key
* @param value alue
* @param onlyIfAbsent 如果为 true,不替换已存在的值
* @param evict 如果为 false,代表 链表数组 处于创建模式
* @return 如果 key 存在,返回旧值,否则返回空
*/
final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
boolean evict) {
// 当前的链表数组备份
Node<K,V>[] tab;
// 临时变量,链表数组下标对应的链表的第一个元素
Node<K,V> p;
// 当前链表数组的长度
int n,
// 数据在链表数组中所处的位置,即下标
int i;
// 如果是第一次执行,初始化链表数组的长度
if ((tab = table) == null || (n = tab.length) == 0)
n = (tab = resize()).length;
// 根据 key 的 hash 值和数组长度计算数据所处数组中的位置,如果该下标下的链表为空,
// 直接赋值
if ((p = tab[i = (n - 1) & hash]) == null)
tab[i] = newNode(hash, key, value, null);
else {
// 如果 key 已存在对应的链表节点
Node<K,V> e;
K k;
// 如果插入的数据的 key 的 hash 值与存放位置的链表的头元素的 hash 值相同,
// 且 key 相等,则赋值给 变量 e
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k)))) {
e = p;
} else if (p instanceof TreeNode) {
// 如果是红黑树,则调用红黑树的节点的赋值方法进行赋值,如果 key 已存在,
// 返回已存在的树节点
e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
} else {
// 否则遍历链表
for (int binCount = 0; ; ++binCount) {
// 首先赋值临时变量 e 为链表节点的下一个元素,然后判断如果遍历到链表底部
// (链表的下一个元素为空),则进行赋值,然后跳出循环
if ((e = p.next) == null) {
p.next = newNode(hash, key, value, null);
// 如果链表长度到达 7 个,将链表转换为红黑树,
if (binCount >= TREEIFY_THRESHOLD - 1) {
treeifyBin(tab, hash);
}
break;
}
// 如果 key 已经存在,将已存在的 key 对应 的节点赋值给临时变量 e,
// 然后跳出循环
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k)))){
break;
}
// 更新变量 p 为 p 的下个节点
p = e;
}
}
// 如果临时 e 不为空,表示 key 已经存在
if (e != null) {
// 备份 key 对应的旧值
V oldValue = e.value;
// 如果 onlyIfAbsent 为 false 或者旧值为空,则替换为新值
if (!onlyIfAbsent || oldValue == null) {
e.value = value;
}
// HashMap 的该方法为空方法,没有实现,LinkedHashMap 中进行了实现
afterNodeAccess(e);
// 返回旧值
return oldValue;
}
}
// 记录修改次数的变量加1
++modCount;
// 容量加1,如果超过扩容阈值,进行扩容
if (++size > threshold) {
resize();
}
// HashMap 的该方法为空方法,没有实现,LinkedHashMap 中进行了实现
afterNodeInsertion(evict);
return null;
}

/**
* 重新设置链表数组的长度
*
* @return 新长度的链表数组
*/
final Node<K,V>[] resize() {
// 将链表数组,数组长度,扩容阈值赋值给临时变量进行备份
Node<K,V>[] oldTab = table;
int oldCap = (oldTab == null) ? 0 : oldTab.length;
// 将扩容阈值赋值给临时变量
int oldThr = threshold;
// 声明新的长度跟扩容阈值对应的临时变量
int newCap, newThr = 0;
// 判断 map 中是否已经存在数据,如果存在数据,则数组长度大于0
if (oldCap > 0) {
// 如果长度达到设定的最大长度阈值阈值,则将扩容阈值设置为 Integer 的最大值。
// 代表将不再会对数组进行扩容,返回原数组。
if (oldCap >= MAXIMUM_CAPACITY) {
threshold = Integer.MAX_VALUE;
return oldTab;
}
// 设置新的长度,然后判断新的长度如果小于最大容量阈值并且当前长度小于默认长度,
// 便设置新的扩容阈值,其新值都是旧值的两倍
else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
oldCap >= DEFAULT_INITIAL_CAPACITY) {
newThr = oldThr << 1;
}
}
// 如果长度为0且扩容阈值大于0,直接将容量设置为扩容阈值
else if (oldThr > 0)
newCap = oldThr;
// 如果都为0,则设置为默认值
else {
newCap = DEFAULT_INITIAL_CAPACITY;
newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
}
// 如果扩容阈值还没有进行初始化,初始化扩容阈值
if (newThr == 0) {
float ft = (float)newCap * loadFactor;
// 判断如果新的数组长度大于扩容上限阈值,则直接设置为 Integer 最大值,
// 代表不再进行扩容,否则设置为已经计算出来的扩容阈值
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;
// 如果老的链表数组数据不为空,则进行迁数据移
if (oldTab != null) {
// 循环遍历就的链表数组
for (int j = 0; j < oldCap; ++j) {
// 临时变量
Node<K,V> e;
// 赋值给临时变量并判断该数组下标下的链表不为空
if ((e = oldTab[j]) != null) {
// 删除该位置对于链表的引用,使其可以进行垃圾回收?
// 自己的理解,不确定是否正确。。。。。
oldTab[j] = null;
// 如果该位置下的链表长度为一,则直接重新结算改节点在新数组中的
// 位置,并添加到新的数组中。Q:直接设置到该位置的头部节点?
// 如何确定该位置没有数据呢?
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 {
// 链表优化重hash的代码块
// 声明临时变量
Node<K,V> loHead = null, loTail = null;
Node<K,V> hiHead = null, hiTail = null;
Node<K,V> next;
do {
// 节点的下一个变量赋值给临时变量
next = e.next;
// 原索引
if ((e.hash & oldCap) == 0) {
// 第一次进来,设置头节点,否则设置尾节点
if (loTail == null) {
loHead = e;
} else {
loTail.next = e;
}
// 无论如何,都更新尾节点
loTail = e;
} else {
// 原索引+oldCap
if (hiTail == null)
hiHead = e;
else
hiTail.next = e;
hiTail = e;
}
} while ((e = next) != null);

// 存放在原索引位置
if (loTail != null) {
loTail.next = null;
newTab[j] = loHead;
}
// 存放在原索引+oldCap的位置里
if (hiTail != null) {
hiTail.next = null;
newTab[j + oldCap] = hiHead;
}
}
}
}
}
return newTab;
}

/**
* 尝试将链表数组转换为红黑树
* @param tab 链表数组
* @param hash 插入 key 的 hash 值
*/
final void treeifyBin(Node<K,V>[] tab, int hash) {
// 声明临时变量
int n, index; Node<K,V> e;
// 如果链表数组为空或者链表数组的长度小于阈值时,优先进行扩容
if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY) {
resize();
}
// 计算 key 在链表数组中的具体下标,并校验该位置下的链表不为空
else if ((e = tab[index = (n - 1) & hash]) != null) {
// 声明临时变量
TreeNode<K,V> hd = null, tl = null;
// 遍历整个链表,并设置红黑树的 pre next 相关节点
do {
// 将链表节点替换为红黑树节点
TreeNode<K,V> p = replacementTreeNode(e, null);
// 设置 pre next 相关节点
if (tl == null) {
hd = p;
} else {
p.prev = tl;
tl.next = p;
}
tl = p;
} while ((e = e.next) != null);
// 把链表所处在数组的位置重新复制给新的红黑树 root 节点,
// 并判断 root 节点不为空,然后将链表转换为红黑树。
if ((tab[index] = hd) != null)
hd.treeify(tab);
}
}

/**
* 将另一个 map 中的数据插入到当前 map 中
*
* @param m 另一个存储数据的 map
* @throws NullPointerException 如果参数 map 为空
*/
public void putAll(Map<? extends K, ? extends V> m) {
// 调用实现方法
putMapEntries(m, true);
}

/**
* 移除指定 key 的键值对映射
*
* @param key 即将被移除的 key
* @return 如果 key 存在则返回 key 对应的 value,否则返回 null
*/
public V remove(Object key) {
// 被移除的节点
Node<K,V> e;
// 移除节点并返回节点的 value
return (e = removeNode(hash(key), key, null, false, true)) == null ?
null : e.value;
}

/**
* Map.remove 的实现方法
*
* @param hash key 的 hash 值
* @param key 即将被移除的 key
* @param value 如果 matchValue 为 true,则当 key 与 value 同时一致时才移除
* @param matchValue 如果为 true 则校验 key 对应的 value 与传入的是否一致
* @param movable 如果为 false 则不一定其他节点
* @return 如果 key 存在则返回被移除的节点,否则返回 null
*/
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;
// 如果当前链表数组不为空且 key 所在的数组下标对应的链表不为空
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 {
// 遍历链表,找到 key 相同的节点并跳出循环
do {
if (e.hash == hash &&
((k = e.key) == key ||
(key != null && key.equals(k)))) {
node = e;
break;
}
p = e;
} while ((e = e.next) != null);
}
}
// 如果被移除的节点不为并且在匹配 value 的情况下,value 相等,则删除节点
// (这个判断写的属实绕!!!)
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;
// 否则将 node 的上一个节点的下一个节点指向 node 的下一个节点
else
p.next = node.next;
// 修改次数加一
++modCount;
// map 的键值对数量减一
--size;
// 移出数据后的回调,HashMap 是个空方法,LinkedHashMap 中有实现
afterNodeRemoval(node);
// 返回被移除的节点
return node;
}
}
return null;
}

/**
* 清空 map
*/
public void clear() {
Node<K,V>[] tab;
// 修改 map 的次数加一
modCount++;
// 判断数组不为空
if ((tab = table) != null && size > 0) {
// 将 size 设置为 0
size = 0;
// 遍历数组,将每个下标下对链表的引用设置为 null
for (int i = 0; i < tab.length; ++i)
tab[i] = null;
}
}

/**
* 判断 map 中是否存在 value
*
* @param 是否存在的 value
* @return 如果返回 true 则标识存在一个或多个 key 的 value
* 与参数相等。
*/
public boolean containsValue(Object value) {
Node<K,V>[] tab; V v;
// 校验 map 不为空
if ((tab = table) != null && size > 0) {
// 遍历链表数组
for (int i = 0; i < tab.length; ++i) {
// 遍历每个下标对应的链表
for (Node<K,V> e = tab[i]; e != null; e = e.next) {
// 如果 value 相等,返回 true
if ((v = e.value) == value ||
(value != null && value.equals(v)))
return true;
}
}
}
return false;
}

/**
* 返回 map 中所有 key 的 set 集合
*/
public Set<K> keySet() {
Set<K> ks = keySet;
if (ks == null) {
ks = new KeySet();
keySet = ks;
}
return ks;
}

/**
* map 的 key Set 集合
*/
final class KeySet extends AbstractSet<K> {
public final int size() { return size; }
public final void clear() { HashMap.this.clear(); }
public final Iterator<K> iterator() { return new KeyIterator(); }
public final boolean contains(Object o) { return containsKey(o); }
public final boolean remove(Object key) {
return removeNode(hash(key), key, null, false, true) != null;
}
public final Spliterator<K> spliterator() {
return new KeySpliterator<>(HashMap.this, 0, -1, 0, 0);
}
public final void forEach(Consumer<? super K> action) {
Node<K,V>[] tab;
if (action == null)
throw new NullPointerException();
if (size > 0 && (tab = table) != null) {
int mc = modCount;
for (int i = 0; i < tab.length; ++i) {
for (Node<K,V> e = tab[i]; e != null; e = e.next)
action.accept(e.key);
}
if (modCount != mc)
throw new ConcurrentModificationException();
}
}
}

/**
* 返回 map 包含的所有 value 的集合
*/
public Collection<V> values() {
Collection<V> vs = values;
if (vs == null) {
vs = new Values();
values = vs;
}
return vs;
}


/**
* value 集合
*/
final class Values extends AbstractCollection<V> {
public final int size() { return size; }
public final void clear() { HashMap.this.clear(); }
public final Iterator<V> iterator() { return new ValueIterator(); }
public final boolean contains(Object o) { return containsValue(o); }
public final Spliterator<V> spliterator() {
return new ValueSpliterator<>(HashMap.this, 0, -1, 0, 0);
}
public final void forEach(Consumer<? super V> action) {
Node<K,V>[] tab;
if (action == null)
throw new NullPointerException();
if (size > 0 && (tab = table) != null) {
int mc = modCount;
for (int i = 0; i < tab.length; ++i) {
for (Node<K,V> e = tab[i]; e != null; e = e.next)
action.accept(e.value);
}
if (modCount != mc)
throw new ConcurrentModificationException();
}
}
}

/**
* 返回一个 set 集合,存储的是 map 中链表的每个节点
*/
public Set<Map.Entry<K,V>> entrySet() {
Set<Map.Entry<K,V>> es;
return (es = entrySet) == null ? (entrySet = new EntrySet()) : es;
}

/**
* 节点集合
*/
final class EntrySet extends AbstractSet<Map.Entry<K,V>> {
public final int size() { return size; }
public final void clear() { HashMap.this.clear(); }
public final Iterator<Map.Entry<K,V>> iterator() {
return new EntryIterator();
}
public final boolean contains(Object o) {
if (!(o instanceof Map.Entry))
return false;
Map.Entry<?,?> e = (Map.Entry<?,?>) o;
Object key = e.getKey();
Node<K,V> candidate = getNode(hash(key), key);
return candidate != null && candidate.equals(e);
}
public final boolean remove(Object o) {
if (o instanceof Map.Entry) {
Map.Entry<?,?> e = (Map.Entry<?,?>) o;
Object key = e.getKey();
Object value = e.getValue();
return removeNode(hash(key), key, value, true, true) != null;
}
return false;
}
public final Spliterator<Map.Entry<K,V>> spliterator() {
return new EntrySpliterator<>(HashMap.this, 0, -1, 0, 0);
}
public final void forEach(Consumer<? super Map.Entry<K,V>> action) {
Node<K,V>[] tab;
if (action == null)
throw new NullPointerException();
if (size > 0 && (tab = table) != null) {
int mc = modCount;
for (int i = 0; i < tab.length; ++i) {
for (Node<K,V> e = tab[i]; e != null; e = e.next)
action.accept(e);
}
if (modCount != mc)
throw new ConcurrentModificationException();
}
}
}


/**
* 通过 key 查询 value,如果查询不到则返回给定的默认 value
*/
@Override
public V getOrDefault(Object key, V defaultValue) {
Node<K,V> e;
return (e = getNode(hash(key), key)) == null ? defaultValue : e.value;
}

/**
* 如果 key 不存在则保存 value
*/
@Override
public V putIfAbsent(K key, V value) {
return putVal(hash(key), key, value, true, true);
}

/**
* 指定 key value 移出
*/
@Override
public boolean remove(Object key, Object value) {
return removeNode(hash(key), key, value, true, true) != null;
}

/**
* 指定 key 跟 oldValue,将 oldValue 替换成 newValue
*/
@Override
public boolean replace(K key, V oldValue, V newValue) {
Node<K,V> e; V v;
if ((e = getNode(hash(key), key)) != null &&
((v = e.value) == oldValue || (v != null && v.equals(oldValue)))) {
e.value = newValue;
afterNodeAccess(e);
return true;
}
return false;
}

/**
* 指定 key,将其对应的 value 替换成传入的 value
*/
@Override
public V replace(K key, V value) {
Node<K,V> e;
if ((e = getNode(hash(key), key)) != null) {
V oldValue = e.value;
e.value = value;
afterNodeAccess(e);
return oldValue;
}
return null;
}

/**
* 如果 key 不存在或者对应的 value 为空,通过 mappingFunction 函数对 key 进行一定的处理生成 value,
* 并存储,否则返回旧 value。(可用于构建本地缓存)
*/
@Override
public V computeIfAbsent(K key,
Function<? super K, ? extends V> mappingFunction) {
// 参数校验
if (mappingFunction == null)
throw new NullPointerException();
// 获取 key 的 hash 值
int hash = hash(key);
Node<K,V>[] tab; Node<K,V> first; int n, i;
int binCount = 0;
TreeNode<K,V> t = null;
Node<K,V> old = null;
// 判断 table 是否需要扩容
if (size > threshold || (tab = table) == null ||
(n = tab.length) == 0)
n = (tab = resize()).length;
// 判断 key 所在位置数组对应的链表不为空
if ((first = tab[i = (n - 1) & hash]) != null) {
// 查找节点
if (first instanceof TreeNode)
old = (t = (TreeNode<K,V>)first).getTreeNode(hash, key);
else {
Node<K,V> e = first; K k;
do {
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k)))) {
old = e;
break;
}
++binCount;
} while ((e = e.next) != null);
}
V oldValue;
// 如果旧节点不为空且旧值不为空,则返回
if (old != null && (oldValue = old.value) != null) {
afterNodeAccess(old);
return oldValue;
}
}
// 通过 key 生成新的 value
V v = mappingFunction.apply(key);
// value 为空则返回
if (v == null) {
return null;
}
// 如果 key 存在且 value 为空
else if (old != null) {
// 设置新的 value 并返回
old.value = v;
afterNodeAccess(old);
return v;
}
// 如果是红黑树,从根节点插入新的 value
else if (t != null)
t.putTreeVal(this, tab, hash, key, v);
// 如果是链表,且 key 不存在,添加一个节点
else {
tab[i] = newNode(hash, key, v, first);
// 如果长度达到阈值则尝试换将为红黑树
if (binCount >= TREEIFY_THRESHOLD - 1)
treeifyBin(tab, hash);
}
// map 修改次数 + 1
++modCount;
// key value 映射个数 + 1
++size;
// 插入回调
afterNodeInsertion(true);
// 返回新值
return v;
}

/**
* 如果 key 存在且 value 不为空,则通过 remappingFunction 函数对 key 和 value 进行处理,
* 生成新值,存储并返回
*/
public V computeIfPresent(K key,
BiFunction<? super K, ? super V, ? extends V> remappingFunction) {
// 参数校验
if (remappingFunction == null)
throw new NullPointerException();
Node<K,V> e; V oldValue;
// 获取 key 的 hash 值
int hash = hash(key);
// 根据 key 获取链表节点,并判断节点和 value 不为空
if ((e = getNode(hash, key)) != null &&
(oldValue = e.value) != null) {
// 通过 key 和 oldValue 生成新值
V v = remappingFunction.apply(key, oldValue);
// 如果新值不为空,设置为新值并返回
if (v != null) {
e.value = v;
afterNodeAccess(e);
return v;
}
// 否则移除节点
else
removeNode(hash, key, null, false, true);
}
return null;
}

/**
* 通过 key 查找旧值,然后通过 remappingFunction函数对 key 和旧值进行处理,生成新值,并存储返回
*/
@Override
public V compute(K key,
BiFunction<? super K, ? super V, ? extends V> remappingFunction) {
// 参数校验
if (remappingFunction == null)
throw new NullPointerException();
// 获取 key 的 hash 值
int hash = hash(key);
Node<K,V>[] tab; Node<K,V> first; int n, i;
int binCount = 0;
TreeNode<K,V> t = null;
Node<K,V> old = null;
// 判断是否需要扩容
if (size > threshold || (tab = table) == null ||
(n = tab.length) == 0)
n = (tab = resize()).length;
// key 所在数组位置的链表不为空
if ((first = tab[i = (n - 1) & hash]) != null) {
// 获取与 key 相等的链表节点
if (first instanceof TreeNode)
old = (t = (TreeNode<K,V>)first).getTreeNode(hash, key);
else {
Node<K,V> e = first; K k;
do {
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k)))) {
old = e;
break;
}
++binCount;
} while ((e = e.next) != null);
}
}
// 获取旧值
V oldValue = (old == null) ? null : old.value;
// 根据旧值跟 key 生成新的 value
V v = remappingFunction.apply(key, oldValue);
// 如果 key 存在
if (old != null) {
// 如果新值不为空,则替换成新值
if (v != null) {
old.value = v;
afterNodeAccess(old);
}
// 否则移除节点
else
removeNode(hash, key, null, false, true);
}
// 如果 key 不存在且 value 不为空
else if (v != null) {
// 如果是红黑树则从根节点插入
if (t != null)
t.putTreeVal(this, tab, hash, key, v);
else {
// 新增链表节点
tab[i] = newNode(hash, key, v, first);
// 如果链表长度达到阈值,尝试转换成红黑树
if (binCount >= TREEIFY_THRESHOLD - 1)
treeifyBin(tab, hash);
}
// map 修改次数 + 1
++modCount;
// key value 映射个数 + 1
++size;
// 新增数据回调
afterNodeInsertion(true);
}
// 返回新值
return v;
}

/**
* 通过 key 查找 value,如果 key 存在且旧值不为空,则通过 remappingFunction 函数对
* 旧值和参数 value 进行处理,生成新值并存储,如果 key 存在但旧值为空,则新值就等于参数
* value,如果新值也为空,则移除 key 对应的节点,如果 key 不存在则插入参数 value
*/
@Override
public V merge(K key, V value,
BiFunction<? super V, ? super V, ? extends V> remappingFunction) {
// 参数验证
if (value == null)
throw new NullPointerException();
if (remappingFunction == null)
throw new NullPointerException();
// 获取 key 的 hash 值
int hash = hash(key);
Node<K,V>[] tab; Node<K,V> first; int n, i;
int binCount = 0;
TreeNode<K,V> t = null;
Node<K,V> old = null;
// 判断是否需要扩容
if (size > threshold || (tab = table) == null ||
(n = tab.length) == 0)
n = (tab = resize()).length;
// 判断 key 在数组中所处的位置对应的链表不为空
if ((first = tab[i = (n - 1) & hash]) != null) {
// 查找节点
if (first instanceof TreeNode)
old = (t = (TreeNode<K,V>)first).getTreeNode(hash, key);
else {
Node<K,V> e = first; K k;
do {
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k)))) {
old = e;
break;
}
++binCount;
} while ((e = e.next) != null);
}
}
// 如果 key 存在
if (old != null) {
V v;
// 旧值不为空,通过 remappingFunction 函数对旧值和参数 value 进行出里,
// 生成新值
if (old.value != null)
v = remappingFunction.apply(old.value, value);
// 否则新值等于参数 value
else
v = value;
// 新值不为空,设置新值
if (v != null) {
old.value = v;
afterNodeAccess(old);
}
// 新值为空,移除与 key 对应的节点
else
removeNode(hash, key, null, false, true);
return v;
}
// 如果 key 不存在
if (value != null) {
// 如果是红黑树,从根节点插入数据
if (t != null)
t.putTreeVal(this, tab, hash, key, value);
// 新增链表节点
else {
tab[i] = newNode(hash, key, value, first);
if (binCount >= TREEIFY_THRESHOLD - 1)
treeifyBin(tab, hash);
}
// map 修改次数 + 1
++modCount;
// key value 映射个数 + 1
++size;
// 新增数据回调
afterNodeInsertion(true);
}
// 返回 value
return value;
}

// 遍历 map,通过 action 函数对每个 key,value 进行指定的业务逻辑处理
@Override
public void forEach(BiConsumer<? super K, ? super V> action) {
Node<K,V>[] tab;
// 参数校验
if (action == null)
throw new NullPointerException();
// 判断 map 不为空
if (size > 0 && (tab = table) != null) {
int mc = modCount;
// 遍历链表数组
for (int i = 0; i < tab.length; ++i) {
// 遍历链表
for (Node<K,V> e = tab[i]; e != null; e = e.next)
// 对 key value 进行处理
action.accept(e.key, e.value);
}
// 如果 map 被修改,抛出异常
if (modCount != mc)
throw new ConcurrentModificationException();
}
}

/**
* 遍历 map,通过 function 函数对每个 key value 进行处理生成新的 value 并设置
*/
@Override
public void replaceAll(BiFunction<? super K, ? super V, ? extends V> function) {
Node<K,V>[] tab;
// 参数校验
if (function == null)
throw new NullPointerException();
// 判断 map 不为空
if (size > 0 && (tab = table) != null) {
int mc = modCount;
// 遍历链表数组
for (int i = 0; i < tab.length; ++i) {
// 遍历链表
for (Node<K,V> e = tab[i]; e != null; e = e.next) {
// 通过 function 函数对 key value 进行处理,生成新值并设置
e.value = function.apply(e.key, e.value);
}
}
// 如果 map 被修改,则抛出异常
if (modCount != mc)
throw new ConcurrentModificationException();
}
}

/* ------------------------------------------------------------ */
// Cloning and serialization

/**
* 重写 Object 的 clone 方法,浅拷贝一个新的 map
*
* @return 浅拷贝一个一个新 map
*/
@SuppressWarnings("unchecked")
@Override
public Object clone() {
HashMap<K,V> result;
try {
result = (HashMap<K,V>)super.clone();
} catch (CloneNotSupportedException e) {
// this shouldn't happen, since we are Cloneable
throw new InternalError(e);
}
result.reinitialize();
result.putMapEntries(this, false);
return result;
}

/**
* 获取负载系数
*/
final float loadFactor() { return loadFactor; }

/**
* 获取链表数组的长度
*/
final int capacity() {
return (table != null) ? table.length :
(threshold > 0) ? threshold :
DEFAULT_INITIAL_CAPACITY;
}

/**
* 序列化 map 方法,将 HashMap 实例的状态保存到 stream 中。
*/
private void writeObject(java.io.ObjectOutputStream s)
throws IOException {
int buckets = capacity();
// Write out the threshold, loadfactor, and any hidden stuff
s.defaultWriteObject();
s.writeInt(buckets);
s.writeInt(size);
internalWriteEntries(s);
}

/**
* 返序列化方法
*/
private void readObject(java.io.ObjectInputStream s)
throws IOException, ClassNotFoundException {
// Read in the threshold (ignored), loadfactor, and any hidden stuff
s.defaultReadObject();
reinitialize();
if (loadFactor <= 0 || Float.isNaN(loadFactor))
throw new InvalidObjectException("Illegal load factor: " +
loadFactor);
s.readInt(); // Read and ignore number of buckets
int mappings = s.readInt(); // Read number of mappings (size)
if (mappings < 0)
throw new InvalidObjectException("Illegal mappings count: " +
mappings);
else if (mappings > 0) { // (if zero, use defaults)
// Size the table using given load factor only if within
// range of 0.25...4.0
float lf = Math.min(Math.max(0.25f, loadFactor), 4.0f);
float fc = (float)mappings / lf + 1.0f;
int cap = ((fc < DEFAULT_INITIAL_CAPACITY) ?
DEFAULT_INITIAL_CAPACITY :
(fc >= MAXIMUM_CAPACITY) ?
MAXIMUM_CAPACITY :
tableSizeFor((int)fc));
float ft = (float)cap * lf;
threshold = ((cap < MAXIMUM_CAPACITY && ft < MAXIMUM_CAPACITY) ?
(int)ft : Integer.MAX_VALUE);
@SuppressWarnings({"rawtypes","unchecked"})
Node<K,V>[] tab = (Node<K,V>[])new Node[cap];
table = tab;

// Read the keys and values, and put the mappings in the HashMap
for (int i = 0; i < mappings; i++) {
@SuppressWarnings("unchecked")
K key = (K) s.readObject();
@SuppressWarnings("unchecked")
V value = (V) s.readObject();
putVal(hash(key), key, value, false, false);
}
}
}

/**
* key、value、Entry 迭代器的父类
*/
abstract class HashIterator {
Node<K,V> next; // next entry to return
Node<K,V> current; // current entry
int expectedModCount; // for fast-fail
int index; // current slot

HashIterator() {
expectedModCount = modCount;
Node<K,V>[] t = table;
current = next = null;
index = 0;
if (t != null && size > 0) { // advance to first entry
do {} while (index < t.length && (next = t[index++]) == null);
}
}

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

final Node<K,V> nextNode() {
Node<K,V>[] t;
Node<K,V> e = next;
if (modCount != expectedModCount)
throw new ConcurrentModificationException();
if (e == null)
throw new NoSuchElementException();
if ((next = (current = e).next) == null && (t = table) != null) {
do {} while (index < t.length && (next = t[index++]) == null);
}
return e;
}

public final void remove() {
Node<K,V> p = current;
if (p == null)
throw new IllegalStateException();
if (modCount != expectedModCount)
throw new ConcurrentModificationException();
current = null;
K key = p.key;
removeNode(hash(key), key, null, false, false);
expectedModCount = modCount;
}
}

/**
* key 迭代器
*/
final class KeyIterator extends HashIterator
implements Iterator<K> {
public final K next() { return nextNode().key; }
}

/**
* value 迭代器
*/
final class ValueIterator extends HashIterator
implements Iterator<V> {
public final V next() { return nextNode().value; }
}

/**
* Entry 迭代器
*/
final class EntryIterator extends HashIterator
implements Iterator<Map.Entry<K,V>> {
public final Map.Entry<K,V> next() { return nextNode(); }
}

/**
* 并行迭代器 Q:为什么没有实现 Spliterator 接口呢?
*/
static class HashMapSpliterator<K,V> {
final HashMap<K,V> map;
Node<K,V> current; // current node
int index; // current index, modified on advance/split
int fence; // one past last index
int est; // size estimate
int expectedModCount; // for comodification checks

HashMapSpliterator(HashMap<K,V> m, int origin,
int fence, int est,
int expectedModCount) {
this.map = m;
this.index = origin;
this.fence = fence;
this.est = est;
this.expectedModCount = expectedModCount;
}

final int getFence() { // initialize fence and size on first use
int hi;
if ((hi = fence) < 0) {
HashMap<K,V> m = map;
est = m.size;
expectedModCount = m.modCount;
Node<K,V>[] tab = m.table;
hi = fence = (tab == null) ? 0 : tab.length;
}
return hi;
}

public final long estimateSize() {
getFence(); // force init
return (long) est;
}
}

/**
* key 的并行迭代器
*/
static final class KeySpliterator<K,V>
extends HashMapSpliterator<K,V>
implements Spliterator<K> {
KeySpliterator(HashMap<K,V> m, int origin, int fence, int est,
int expectedModCount) {
super(m, origin, fence, est, expectedModCount);
}

public KeySpliterator<K,V> trySplit() {
int hi = getFence(), lo = index, mid = (lo + hi) >>> 1;
return (lo >= mid || current != null) ? null :
new KeySpliterator<>(map, lo, index = mid, est >>>= 1,
expectedModCount);
}

public void forEachRemaining(Consumer<? super K> action) {
int i, hi, mc;
if (action == null)
throw new NullPointerException();
HashMap<K,V> m = map;
Node<K,V>[] tab = m.table;
if ((hi = fence) < 0) {
mc = expectedModCount = m.modCount;
hi = fence = (tab == null) ? 0 : tab.length;
}
else
mc = expectedModCount;
if (tab != null && tab.length >= hi &&
(i = index) >= 0 && (i < (index = hi) || current != null)) {
Node<K,V> p = current;
current = null;
do {
if (p == null)
p = tab[i++];
else {
action.accept(p.key);
p = p.next;
}
} while (p != null || i < hi);
if (m.modCount != mc)
throw new ConcurrentModificationException();
}
}

public boolean tryAdvance(Consumer<? super K> action) {
int hi;
if (action == null)
throw new NullPointerException();
Node<K,V>[] tab = map.table;
if (tab != null && tab.length >= (hi = getFence()) && index >= 0) {
while (current != null || index < hi) {
if (current == null)
current = tab[index++];
else {
K k = current.key;
current = current.next;
action.accept(k);
if (map.modCount != expectedModCount)
throw new ConcurrentModificationException();
return true;
}
}
}
return false;
}

public int characteristics() {
return (fence < 0 || est == map.size ? Spliterator.SIZED : 0) |
Spliterator.DISTINCT;
}
}

/**
* value 的并行迭代器
*/
static final class ValueSpliterator<K,V>
extends HashMapSpliterator<K,V>
implements Spliterator<V> {
ValueSpliterator(HashMap<K,V> m, int origin, int fence, int est,
int expectedModCount) {
super(m, origin, fence, est, expectedModCount);
}

public ValueSpliterator<K,V> trySplit() {
int hi = getFence(), lo = index, mid = (lo + hi) >>> 1;
return (lo >= mid || current != null) ? null :
new ValueSpliterator<>(map, lo, index = mid, est >>>= 1,
expectedModCount);
}

public void forEachRemaining(Consumer<? super V> action) {
int i, hi, mc;
if (action == null)
throw new NullPointerException();
HashMap<K,V> m = map;
Node<K,V>[] tab = m.table;
if ((hi = fence) < 0) {
mc = expectedModCount = m.modCount;
hi = fence = (tab == null) ? 0 : tab.length;
}
else
mc = expectedModCount;
if (tab != null && tab.length >= hi &&
(i = index) >= 0 && (i < (index = hi) || current != null)) {
Node<K,V> p = current;
current = null;
do {
if (p == null)
p = tab[i++];
else {
action.accept(p.value);
p = p.next;
}
} while (p != null || i < hi);
if (m.modCount != mc)
throw new ConcurrentModificationException();
}
}

public boolean tryAdvance(Consumer<? super V> action) {
int hi;
if (action == null)
throw new NullPointerException();
Node<K,V>[] tab = map.table;
if (tab != null && tab.length >= (hi = getFence()) && index >= 0) {
while (current != null || index < hi) {
if (current == null)
current = tab[index++];
else {
V v = current.value;
current = current.next;
action.accept(v);
if (map.modCount != expectedModCount)
throw new ConcurrentModificationException();
return true;
}
}
}
return false;
}

public int characteristics() {
return (fence < 0 || est == map.size ? Spliterator.SIZED : 0);
}
}

/**
* 每个节点的并行迭代器
*/
static final class EntrySpliterator<K,V>
extends HashMapSpliterator<K,V>
implements Spliterator<Map.Entry<K,V>> {
EntrySpliterator(HashMap<K,V> m, int origin, int fence, int est,
int expectedModCount) {
super(m, origin, fence, est, expectedModCount);
}

public EntrySpliterator<K,V> trySplit() {
int hi = getFence(), lo = index, mid = (lo + hi) >>> 1;
return (lo >= mid || current != null) ? null :
new EntrySpliterator<>(map, lo, index = mid, est >>>= 1,
expectedModCount);
}

public void forEachRemaining(Consumer<? super Map.Entry<K,V>> action) {
int i, hi, mc;
if (action == null)
throw new NullPointerException();
HashMap<K,V> m = map;
Node<K,V>[] tab = m.table;
if ((hi = fence) < 0) {
mc = expectedModCount = m.modCount;
hi = fence = (tab == null) ? 0 : tab.length;
}
else
mc = expectedModCount;
if (tab != null && tab.length >= hi &&
(i = index) >= 0 && (i < (index = hi) || current != null)) {
Node<K,V> p = current;
current = null;
do {
if (p == null)
p = tab[i++];
else {
action.accept(p);
p = p.next;
}
} while (p != null || i < hi);
if (m.modCount != mc)
throw new ConcurrentModificationException();
}
}

public boolean tryAdvance(Consumer<? super Map.Entry<K,V>> action) {
int hi;
if (action == null)
throw new NullPointerException();
Node<K,V>[] tab = map.table;
if (tab != null && tab.length >= (hi = getFence()) && index >= 0) {
while (current != null || index < hi) {
if (current == null)
current = tab[index++];
else {
Node<K,V> e = current;
current = current.next;
action.accept(e);
if (map.modCount != expectedModCount)
throw new ConcurrentModificationException();
return true;
}
}
}
return false;
}

public int characteristics() {
return (fence < 0 || est == map.size ? Spliterator.SIZED : 0) |
Spliterator.DISTINCT;
}
}

/* ------------------------------------------------------------ */
// 支持 LinkedHashMap 的相关操作


/*
* The following package-protected methods are designed to be
* overridden by LinkedHashMap, but not by any other subclass.
* Nearly all other internal methods are also package-protected
* but are declared final, so can be used by LinkedHashMap, view
* classes, and HashSet.
*/

// 创建一个链表节点(非红黑树节点)
Node<K,V> newNode(int hash, K key, V value, Node<K,V> next) {
return new Node<>(hash, key, value, next);
}

// 替换节点
Node<K,V> replacementNode(Node<K,V> p, Node<K,V> next) {
return new Node<>(p.hash, p.key, p.value, next);
}

// 创建一个红黑树节点
TreeNode<K,V> newTreeNode(int hash, K key, V value, Node<K,V> next) {
return new TreeNode<>(hash, key, value, next);
}

// 将链表节点替换为红黑树节点
TreeNode<K,V> replacementTreeNode(Node<K,V> p, Node<K,V> next) {
return new TreeNode<>(p.hash, p.key, p.value, next);
}

/**
* 将 map 初始化到默认状态,在 clone 和 readObject 方法中调用
*/
void reinitialize() {
table = null;
entrySet = null;
keySet = null;
values = null;
modCount = 0;
threshold = 0;
size = 0;
}

// 在执行了某些操作后 LinkedHashMap 会使用这些方法做一些回调操作
void afterNodeAccess(Node<K,V> p) { }
void afterNodeInsertion(boolean evict) { }
void afterNodeRemoval(Node<K,V> p) { }

// 只有 writeObject 方法调用,确保链表数组及链表节点的顺序
void internalWriteEntries(java.io.ObjectOutputStream s) throws IOException {
Node<K,V>[] tab;
if (size > 0 && (tab = table) != null) {
for (int i = 0; i < tab.length; ++i) {
for (Node<K,V> e = tab[i]; e != null; e = e.next) {
s.writeObject(e.key);
s.writeObject(e.value);
}
}
}
}
/**
* 红黑树,具有五个基本性质
* 1. 每个节点只有一种颜色,要么红色,要么黑色
* 2. 根节点是黑色
* 3. 叶节点(空节点)是黑色
* 4. 如果节点是红色,那么他的两个子节点都是黑色
* 5. 任意的节点,从该节点到其所有后代叶节点的简单路径,均包含相同数目的黑色节点,
* 每次新增或删除一个节点后,都有可能破坏红红黑树的这几个基本性质,因此每次操作后
* 都需要对其进行自底向上的修复操作,修复操作分为两类:
* 1. 重新着色
* 2. 旋转操作
* 该类还继承了 Entry 类,说明该类还具有链表相关的特性。
*/
static final class TreeNode<K,V> extends LinkedHashMap.Entry<K,V> {
/*
* 父节点
*/
TreeNode<K,V> parent;
/*
* 左子节点
*/
TreeNode<K,V> left;
/*
* 右子节点
*/
TreeNode<K,V> right;
/*
* 下一个节点(链表特点)
*/
TreeNode<K,V> prev;
/*
* 节点颜色,true 红色,false 黑色
*/
boolean red;

/**
* 构造函数,初始化一个树节点
*/
TreeNode(int hash, K key, V val, Node<K,V> next) {
super(hash, key, val, next);
}

/**
* 获取红黑树的根节点
*/
final TreeNode<K,V> root() {
for (TreeNode<K,V> r = this, p;;) {
if ((p = r.parent) == null)
return r;
r = p;
}
}

/**
* 将红黑树的根节点与红黑树所处的链表数组的下标下存储的节点对应,并设置红黑树的根节点为
* 链表的头结点
*/
static <K,V> void moveRootToFront(Node<K,V>[] tab, TreeNode<K,V> root) {
// 链表数组长度
int n;
// 参数校验,root 跟 链表数组均不为空
if (root != null && tab != null && (n = tab.length) > 0) {
// 重新计算红黑树 root 节点所处链表数组的下标位置
int index = (n - 1) & root.hash;
// 下标对应的链表头节点
TreeNode<K,V> first = (TreeNode<K,V>)tab[index];
// 如果红黑树的根节点和下标下的链表头结点不一致
if (root != first) {
// 红黑树根节点的下一个节点
Node<K,V> rn;
// 将下标对应的节点更改为红黑树的根节点
tab[index] = root;
// 红黑树根节点的上一个节点
TreeNode<K,V> rp = root.prev;
// 如果根节点的上一个节点不为空
if ((rn = root.next) != null)
// 根节点的下一个节点的上一个节点指向根节点的上一个节点,
// 相当于把根节点从链表中删除
((TreeNode<K,V>)rn).prev = rp;
// 如果根节点的上一个节点上一个节点不为空
if (rp != null)
// 根节点的上一个节点的下一个节点指向根节点的下一个节点
rp.next = rn;
// 链表的头结点不为空
if (first != null)
// 链表的头结点指向红黑树的根节点
first.prev = root;
// 根节点的下个节点指向原链表的头结点
root.next = first;
// 根节点的上个节点设置为空
root.prev = null;
}
// 校验数据正常
assert checkInvariants(root);
}
}

/**
* 红黑树查询实现方法方法
*/
final TreeNode<K,V> find(int h, Object k, Class<?> kc) {
// 复制当前对象到临时变量
TreeNode<K,V> p = this;
do {
// 初始化临时变量并赋值
int ph, dir; K pk;
TreeNode<K,V> pl = p.left, pr = p.right, q;
// 如果查询的 hash 小于当前节点的 hash 值
// 则将左子树赋值给临时变量,继续循环查找
if ((ph = p.hash) > h)
p = pl;
// 如果查询的 hash 大于当前节点的 hash 值
// 则将右子树赋值给临时变量,继续循环查找
else if (ph < h)
p = pr;
// 如果 key 相等,如果值相等, 则返回
else if ((pk = p.key) == k || (k != null && k.equals(pk)))
return p;
// 如果左子树为空,则将右子树赋值给临时变量
else if (pl == null)
p = pr;
// 如果右子树为空,则将左子树赋值给临时变量
else if (pr == null)
p = pl;
// 判断 k 是否是 Comaprable 类型,如果是继续判断当前节点的
// key 跟 k 是否是同一类型,如果是则调用 compareTo 方法
// 比较两值的大小
else if ((kc != null ||
(kc = comparableClassFor(k)) != null) &&
(dir = compareComparables(kc, k, pk)) != 0)
p = (dir < 0) ? pl : pr;
// 以上情况都不满足的情况下则去右子树节点下查找
else if ((q = pr.find(h, k, kc)) != null)
return q;
// 左子树节点下查找
else
p = pl;
} while (p != null);
return null;
}

/**
* 通过 key 和 key 的 hash 值查询红黑树节点
*/
final TreeNode<K,V> getTreeNode(int h, Object k) {
return ((parent != null) ? root() : this).find(h, k, null);
}

/**
* 在 hashCode 相等且 key 均没有实现 Comparable 进行比较的情况下,
* 调用该方法比较两个 key 的大小
*/
static int tieBreakOrder(Object a, Object b) {
int d;
if (a == null || b == null ||
(d = a.getClass().getName().
compareTo(b.getClass().getName())) == 0)
d = (System.identityHashCode(a) <= System.identityHashCode(b) ?
-1 : 1);
return d;
}

/**
* 将链表转换为红黑树
*/
final void treeify(Node<K,V>[] tab) {
// 初始化 root 节点的临时变量
TreeNode<K,V> root = null;
// 循环当前红黑树,设置红黑树的相关属性
for (TreeNode<K,V> x = this, next; x != null; x = next) {
// 赋值下一个节点给 next 变量
next = (TreeNode<K,V>)x.next;
// 初始化当前节点的左右子节点
x.left = x.right = null;
// 如果 root 为空(第一次遍历),将当前对象设置为红黑树的根节点
if (root == null) {
// 根节点的父节点为空
x.parent = null;
// 根节点为黑色
x.red = false;
// x 赋值给 root 节点变量
root = x;
}
else {
// 将当前节点的 key 和 hash 赋值给临时变量
K k = x.key;
int h = x.hash;
// key 的 Class 对象
Class<?> kc = null;
// 将当前节点插入到红黑树中,对 putTreeVal 方法进行了简化,
// 因为是第一次插入,不会再去查询 key 是否已经在红黑树中存在了,
// 进而提升一定的效率
for (TreeNode<K,V> p = root;;) {
int dir, ph;
K pk = p.key;
if ((ph = p.hash) > h)
dir = -1;
else if (ph < h)
dir = 1;
else if ((kc == null &&
(kc = comparableClassFor(k)) == null) ||
(dir = compareComparables(kc, k, pk)) == 0)
dir = tieBreakOrder(k, pk);

TreeNode<K,V> xp = p;
if ((p = (dir <= 0) ? p.left : p.right) == null) {
x.parent = xp;
if (dir <= 0)
xp.left = x;
else
xp.right = x;
root = balanceInsertion(root, x);
break;
}
}
}
}
// 确保红黑树根节点与红黑树所处的链表数组的下标下存储的节点对应
// (保证每次搜索时是从红黑树的根节点去搜索啊!!!)
moveRootToFront(tab, root);
}

/**
* 将红黑树转换为链表
*/
final Node<K,V> untreeify(HashMap<K,V> map) {
Node<K,V> hd = null, tl = null;
for (Node<K,V> q = this; q != null; q = q.next) {
Node<K,V> p = map.replacementNode(q, null);
if (tl == null)
hd = p;
else
tl.next = p;
tl = p;
}
return hd;
}

/**
* 红黑树版本的插入数据实现方法
*/
final TreeNode<K,V> putTreeVal(HashMap<K,V> map, Node<K,V>[] tab,
int h, K k, V v) {
// 参数 k 的 Class 类引用
Class<?> kc = null;
// 当前节点以下所有节点是否都对参数 k 进行了查询
boolean searched = false;
// 将 root 节点赋值给临时变量
TreeNode<K,V> root = (parent != null) ? root() : this;
// 将 root 节点作为查询的初始化节点
for (TreeNode<K,V> p = root;;) {
// 声明临时变量
int dir, ph; K pk;
// 赋值当前节点的 hash 值给临时变量,并与要插入的
// k 的 hash 值进行比较,并将比较结果赋值给临时变量
if ((ph = p.hash) > h)
dir = -1;
else if (ph < h)
dir = 1;
// 此时 hash 值应该是相等的,再去比较如果当前节点的 key 与插入的 key 相等,
// 则返回当前节点,因为有可能会出现 hash 值相等但 key 不相同的情况,
// 因此没有单纯的直接使用 hash 去比较是否相等,而是直接因为这样可能会出现 bug
else if ((pk = p.key) == k || (k != null && k.equals(pk)))
return p;
// 在通过 hash 值跟 k 比较不出的情况下,则判断插入的 key 是否
// 是 Comparable 类型,以及两个类是否属于同一类型,如果是则
// 调用 compareTo 比较两个 key 的大小,如果无法比较则从当前
// 节点开始,查询所有子节点是否存在 key 相等的情况,如果有就
// 直接返回。
else if ((kc == null &&
(kc = comparableClassFor(k)) == null) ||
(dir = compareComparables(kc, k, pk)) == 0) {
// 如果以前没有进行过搜索,则查询当前节点下所有子节点的 key
// 跟插入的 key 是否一致,如果一致则直接返回原节点
if (!searched) {
TreeNode<K,V> q, ch;
// 无论是否查到,都赋值给 searched 标识为已经查询过
searched = true;
// 从当前节点的左右子节点开始查找是否有子节点跟
// key 相等,如果有则直接返回
if (((ch = p.left) != null &&
(q = ch.find(h, k, kc)) != null) ||
((ch = p.right) != null &&
(q = ch.find(h, k, kc)) != null))
return q;
}
// 在 key 跟当前节点的 key 都不为空的情况下,通过类名去
// 比较大小,否则通过调用 System.identityHashCode 生
// 成的 hash 值去比较。Q:System.identityHashCode 的
// 具体作用?
dir = tieBreakOrder(k, pk);
}

// 将当前节点赋值给临时变量
TreeNode<K,V> xp = p;
// 根据比较结果来判断应该是插入到左右子节点中的哪一个,并判断
// 其是否为空,如果为空则插入一个新的节点,否则更新循环条件,继续比较
if ((p = (dir <= 0) ? p.left : p.right) == null) {
// 将当前节点的下一个节点赋值给临时变量
Node<K,V> xpn = xp.next;
// 构建一个新节点
TreeNode<K,V> x = map.newTreeNode(h, k, v, xpn);
// 如果 key 小于当前节点的 key 则赋值给左子树,赋值赋值
// 给右子树
if (dir <= 0)
xp.left = x;
else
xp.right = x;
// 将当前节点的下一节点更新为新插入的节点
xp.next = x;
// 将新插入的节点的父节点、上一个节点赋值为当前节点
x.parent = x.prev = xp;
// 更新 xpn 的上一个节点(真tm绕)
if (xpn != null)
((TreeNode<K,V>)xpn).prev = x;

// 新增节点后修复红黑树性质,并将根节点与数组下标的引用关联
moveRootToFront(tab, balanceInsertion(root, x));
return null;
}
}
}

/**
* 删除给定的节点
*/
final void removeTreeNode(HashMap<K,V> map, Node<K,V>[] tab,
boolean movable) {
int n;
// 参数校验
if (tab == null || (n = tab.length) == 0)
return;
// 当前节点在数组中的下标
int index = (n - 1) & hash;
// 声明链表的头结点跟红黑树的头节点,红黑树的头结点的左子树
TreeNode<K,V> first = (TreeNode<K,V>)tab[index], root = first, rl;
// 当前节点的下一个节点和上一个节点
TreeNode<K,V> succ = (TreeNode<K,V>)next, pred = prev;
// 如果当前节点头结点,直接将数组下标对应的节点改成当前节点的下一个节点
if (pred == null)
tab[index] = first = succ;
// 否则上一个节点的下一个节点改成当前节点的下一个节点
else
pred.next = succ;
// 如果下一个节点不为空,将下一个节点的上一个节点改成当前节点的上一个节点
if (succ != null)
succ.prev = pred;
// 如果链表的头结点为空,则直接返回
if (first == null)
return;
// 如果 root 节点不是红黑树的根节点,则赋值为红黑树的根节点
if (root.parent != null)
root = root.root();
// 如果根节点为空或者根节点的左右子节点任意一个为空或者左子节点的
// 左子节点为空,则代表红黑树数据量太小,转换为链表
if (root == null || root.right == null ||
(rl = root.left) == null || rl.left == null) {
tab[index] = first.untreeify(map);
return;
}
// p 被删除的节点,pl p的左子节点,pr p的右子节点,
// replacement 在被删除节点的做右子节点都不为空的情况下,是被删除节点的后继节点的后继节点
// 否则便是被删除节点的后继节点
TreeNode<K,V> p = this, pl = left, pr = right, replacement;
// 如果左右子节点都不为空,寻找后继节点(右子树的最小值或者左子树的最大值为后继节点)和后继节点的
// 后继节点,并将后继节点与被删除节点交换位置
if (pl != null && pr != null) {
TreeNode<K,V> s = pr, sl;
// 循环遍历右子树,获得最小值为后继节点
while ((sl = s.left) != null)
s = sl;
// 交换颜色
boolean c = s.red; s.red = p.red; p.red = c;
// 后继节点的右子节点
TreeNode<K,V> sr = s.right;
// 被删除节点的父节点
TreeNode<K,V> pp = p.parent;
// 如果被删除的节点是后继节点的父节点
if (s == pr) {
// 将被删除节点的父节点设置为后继节点
p.parent = s;
// 后继节点的右子节点设置为被删除节点
s.right = p;
}
else {
// 后继节点的父节点
TreeNode<K,V> sp = s.parent;
// 被删除节点的父节点设置为后继节点的父节点,并判断不为空
if ((p.parent = sp) != null) {
// 如果后继节点是父节点的左子节点,则替换为被删除的节点
// 否则将右子节点替换为被删除的节点
if (s == sp.left)
sp.left = p;
else
sp.right = p;
}
// 后继节点的右子节点设置为被删除节点的右子节点
if ((s.right = pr) != null)
// 并将右子节点的父子节点设置为后继节点
pr.parent = s;
}
// 因为后继节点是被删除节点的右子树的最小值,所以后继节点肯定没有左子节点,
// 因此直接将被删除节点的左子节点设置为空
p.left = null;
// 将被删除节点的右子节点替换为后继节点的右子节点
if ((p.right = sr) != null)
sr.parent = p;
// 将后继节点的左子节点设置为被删除节点的左子节点
if ((s.left = pl) != null)
pl.parent = s;
// 将后继节点的父节点设置为被删除节点的父节点,如果父节点为空
// 则将后继节点设置为红黑树的根节点
if ((s.parent = pp) == null)
root = s;
// 如果被删除节点是原父节点的左子节点,则将后继节点设置为父节点的左子节点
// 否则设置为右子节点
else if (p == pp.left)
pp.left = s;
else
pp.right = s;
// 因为后继节点不存在左子节点,所以直接判断右子节点是否为空,如果右子节点不为空
// 右子节点来替换后继节点,否则被删除节点替换后继节点
if (sr != null)
replacement = sr;
else
replacement = p;
}
// 如果只有左子节点不为空,则将后继节点设置为左子节点
else if (pl != null)
replacement = pl;
// 如果只有右子节点不为空,则将后继节点设置为右子节点
else if (pr != null)
replacement = pr;
// 否则后继节点就是被删除节点本身
else
replacement = p;
// 如果后继节点不是被删除节点本身
if (replacement != p) {
// 后继节点的父节点设置为被删除节点的父节点
TreeNode<K,V> pp = replacement.parent = p.parent;
// 如果父节点为空,则将根节点设置为后继节点
if (pp == null)
root = replacement;
// 将父节点与后继节点关联(此时已经将被删除的节点从书中删除)
else if (p == pp.left)
pp.left = replacement;
else
pp.right = replacement;
// 删除被删除节点对父节点、左右子节点的引用
p.left = p.right = p.parent = null;
}

// 根据被删除节点的颜色,判断是否修复红黑树的性质,因为如果被删除的节点是黑色,
// 则可能导致该路径比其他路径少一颗黑色节点从而破坏红黑树性质,因此需要修复红黑树
TreeNode<K,V> r = p.red ? root : balanceDeletion(root, replacement);

// 如果后继节点为被删除结点本身,删除与父节点的相互引用
if (replacement == p) {
TreeNode<K,V> pp = p.parent;
// 删除对父节点的引用
p.parent = null;
// 父节点删除对被删除节点的引用
if (pp != null) {
if (p == pp.left)
pp.left = null;
else if (p == pp.right)
pp.right = null;
}
}
// 如果为 true, 确保红黑树根节点与红黑树所处的链表数组的下标下存储的节点对应
if (movable)
moveRootToFront(tab, r);
}

/**
* 将红黑树下的节点重新拆分
*
* @param map 当前 map
* @param tab 链表数组
* @param index 红黑树在链表数组的下标
* @param bit 旧的链表数组长度
*/
final void split(HashMap<K,V> map, Node<K,V>[] tab, int index, int bit) {
TreeNode<K,V> b = this;
// 原索引位置
TreeNode<K,V> loHead = null, loTail = null;
// 原索引 + bit 的位置
TreeNode<K,V> hiHead = null, hiTail = null;
// 各自的长度
int lc = 0, hc = 0;
for (TreeNode<K,V> e = b, next; e != null; e = next) {
// 更新 next 节点
next = (TreeNode<K,V>)e.next;
// 删除 e 节点的 next 引用
e.next = null;
// 原索引位置
if ((e.hash & bit) == 0) {
// 头部节点
if ((e.prev = loTail) == null)
loHead = e;
// 新增节点
else
loTail.next = e;
// 更新尾节点
loTail = e;
// 长度 + 1
++lc;
}
else {
// 更新头结点
if ((e.prev = hiTail) == null)
hiHead = e;
// 新增节点
else
hiTail.next = e;
// 更新尾节点
hiTail = e;
// 长度 + 1
++hc;
}
}

// 原索引
if (loHead != null) {
// 如果长度红黑树节点个数小于阈值,转换为链表
if (lc <= UNTREEIFY_THRESHOLD)
tab[index] = loHead.untreeify(map);
else {
// 将数组下标对应的引用跟新为红黑树头结点
tab[index] = loHead;
// 链表转换为红黑树
if (hiHead != null)
loHead.treeify(tab);
}
}
// 原索引 + bit ,操作相同
if (hiHead != null) {
if (hc <= UNTREEIFY_THRESHOLD)
tab[index + bit] = hiHead.untreeify(map);
else {
tab[index + bit] = hiHead;
if (loHead != null)
hiHead.treeify(tab);
}
}
}

/**
* 左旋操作
*/
static <K,V> TreeNode<K,V> rotateLeft(TreeNode<K,V> root,
TreeNode<K,V> p) {
TreeNode<K,V> r, pp, rl;
if (p != null && (r = p.right) != null) {
if ((rl = p.right = r.left) != null)
rl.parent = p;
if ((pp = r.parent = p.parent) == null)
(root = r).red = false;
else if (pp.left == p)
pp.left = r;
else
pp.right = r;
r.left = p;
p.parent = r;
}
return root;
}

/**
* 右旋操作
*/
static <K,V> TreeNode<K,V> rotateRight(TreeNode<K,V> root,
TreeNode<K,V> p) {
TreeNode<K,V> l, pp, lr;
if (p != null && (l = p.left) != null) {
if ((lr = p.left = l.right) != null)
lr.parent = p;
if ((pp = l.parent = p.parent) == null)
(root = l).red = false;
else if (pp.right == p)
pp.right = l;
else
pp.left = l;
l.right = p;
p.parent = l;
}
return root;
}

/**
* 插入后修复红黑树性质
*/
static <K,V> TreeNode<K,V> balanceInsertion(TreeNode<K,V> root,
TreeNode<K,V> x) {
// 新插入的节点为空色
x.red = true;
// 初始化相关变量
for (TreeNode<K,V> xp, xpp, xppl, xppr;;) {
// xp 赋值为 x 节点的父节点,并且判断如果 x 的父节点为空
// 则表示 x 为红黑树的根节点,将 x 节点设置为黑色,并返回
if ((xp = x.parent) == null) {
x.red = false;
return x;
}
// 将 xp 的父节点赋值为 xpp(xpp 为插入节点即 x 节点的爷爷节点),
// 如果 xp 为黑色或者 xpp 节点为空,则代表 xp 为根节点,
// 因此不需要进行修复,直接返回
else if (!xp.red || (xpp = xp.parent) == null)
return root;
// 如果父节点为爷爷节点的左子树
if (xp == (xppl = xpp.left)) {
// 如果爷爷节点的右子树不为空且也为红色,此时 x 的节点为
// 红色且父节点跟叔叔节点也为红色,不符合红黑树性质,进行
// 重新着色修复
if ((xppr = xpp.right) != null && xppr.red) {
// x 的叔叔节点跟父节点设置为黑色
xppr.red = false;
xp.red = false;
// x 的爷爷节点设置为红色
xpp.red = true;
// 将 x 更新为爷爷节点
x = xpp;
}
else {
// 如果叔叔节点为空或者为黑色,且 x 节点为父节点的右子节点
// 则先进行左旋操作
if (x == xp.right) {
// 左旋操作
root = rotateLeft(root, x = xp);
// 更新爷爷节点
xpp = (xp = x.parent) == null ? null : xp.parent;
}
// 如果父节点不为空
if (xp != null) {
// 父节点设置为黑色
xp.red = false;
// 如果爷爷节点不为空
if (xpp != null) {
// 爷爷节点设置为红色
xpp.red = true;
// 进行右旋操作
root = rotateRight(root, xpp);
}
}
}
}
// 如果父节点为爷爷的节点的右子节点
else {
// 如果叔叔节点不为空且叔叔节点也为红色,
// 直接进行重新着色来修复
if (xppl != null && xppl.red) {
// 叔叔节点跟父节点设置为黑色
xppl.red = false;
xp.red = false;
// 爷爷节点设置为红色
xpp.red = true;
// x 节点更新为爷爷节点
x = xpp;
}
// 如果叔叔节点为空或者为黑色
else {
// 如果当前节点为父节点的左子节点
// 先进行右旋操作
if (x == xp.left) {
// 左旋操作
root = rotateRight(root, x = xp);
// 更新爷爷节点
xpp = (xp = x.parent) == null ? null : xp.parent;
}
// 如果父节点不为空
if (xp != null) {
// 父节点设置为黑色
xp.red = false;
// 爷爷节点不为空,则进行左旋操作
if (xpp != null) {
// 爷爷节点设置为红色
xpp.red = true;
// 左旋操作
root = rotateLeft(root, xpp);
}
}
}
}
}
}

/**
* 删除节点后修复红黑树的性质,参数 x 黑色(这个方法看的有点懵逼,肯定有问题,希望大家指出)
*/
static <K,V> TreeNode<K,V> balanceDeletion(TreeNode<K,V> root,
TreeNode<K,V> x) {
// 自底向上修复红黑树
for (TreeNode<K,V> xp, xpl, xpr;;) {
// 如果 x 节点为空或者为根节点,则停止修复
if (x == null || x == root)
return root;
// 如果 x 节点为根节点,直接将其设置为黑色
else if ((xp = x.parent) == null) {
x.red = false;
return x;
}
// 如果为红色,设置为黑色
else if (x.red) {
x.red = false;
return root;
}
// 如果 x 节点是父节点的左子节点
else if ((xpl = xp.left) == x) {
// //有红色的兄弟节点xpr,则父亲节点xp必为黑色
if ((xpr = xp.right) != null && xpr.red) {
// 兄弟节点设置为黑色
xpr.red = false;
// 父节点设置为红色
xp.red = true;
// 父节点左旋
root = rotateLeft(root, xp);
// 更新父节点跟兄弟节点
xpr = (xp = x.parent) == null ? null : xp.right;
}
// 如果兄弟节点为空,x 节点更新为父节点
if (xpr == null)
x = xp;
else {
TreeNode<K,V> sl = xpr.left, sr = xpr.right;
// 如果兄弟节点的左右子节点都不为空切都为黑色,兄弟节点
// 设置为红色。
if ((sr == null || !sr.red) &&
(sl == null || !sl.red)) {
xpr.red = true;
x = xp;
}
else {
// 如果右子节点为空或者为黑色
if (sr == null || !sr.red) {
// 如果左子节点不为空,左子节点也设置为黑色
if (sl != null)
sl.red = false;
// 兄弟节点设置为红色
xpr.red = true;
// 兄弟节点右旋
root = rotateRight(root, xpr);
// 更新父节点跟兄弟节点
xpr = (xp = x.parent) == null ?
null : xp.right;
}
// 如果兄弟节点不为空
if (xpr != null) {
// 如果父节点为空则兄弟节点为黑色,否则兄弟节点的颜色
// 设置为父节点的颜色
xpr.red = (xp == null) ? false : xp.red;
// 如果兄弟节点不为空,兄弟节点右节点设置为黑色
if ((sr = xpr.right) != null)
sr.red = false;
}
// 如果父节点不为空,父节点设置为黑色,并左旋
if (xp != null) {
xp.red = false;
root = rotateLeft(root, xp);
}
// x 节点更新为根节点
x = root;
}
}
}
// 如果 x 节点是父节点的右子节点,对称操作
else {
if (xpl != null && xpl.red) {
xpl.red = false;
xp.red = true;
root = rotateRight(root, xp);
xpl = (xp = x.parent) == null ? null : xp.left;
}
if (xpl == null)
x = xp;
else {
TreeNode<K,V> sl = xpl.left, sr = xpl.right;
if ((sl == null || !sl.red) &&
(sr == null || !sr.red)) {
xpl.red = true;
x = xp;
}
else {
if (sl == null || !sl.red) {
if (sr != null)
sr.red = false;
xpl.red = true;
root = rotateLeft(root, xpl);
xpl = (xp = x.parent) == null ?
null : xp.left;
}
if (xpl != null) {
xpl.red = (xp == null) ? false : xp.red;
if ((sl = xpl.left) != null)
sl.red = false;
}
if (xp != null) {
xp.red = false;
root = rotateRight(root, xp);
}
x = root;
}
}
}
}
}

/**
* 校验节点既符合链表特点也符合红黑树特点
*/
static <K,V> boolean checkInvariants(TreeNode<K,V> t) {
TreeNode<K,V> tp = t.parent, tl = t.left, tr = t.right,
tb = t.prev, tn = (TreeNode<K,V>)t.next;
if (tb != null && tb.next != t)
return false;
if (tn != null && tn.prev != t)
return false;
if (tp != null && t != tp.left && t != tp.right)
return false;
if (tl != null && (tl.parent != t || tl.hash > t.hash))
return false;
if (tr != null && (tr.parent != t || tr.hash < t.hash))
return false;
if (t.red && tl != null && tl.red && tr != null && tr.red)
return false;
if (tl != null && !checkInvariants(tl))
return false;
if (tr != null && !checkInvariants(tr))
return false;
return true;
}
}

}