這一章，我們對HashMap進行學習。
HashMap介紹
HashMap是一個散清單，它存儲的内容是鍵值對（key-value）映射。
HashMap繼承于
AbstractMap
,實作了
Map
,
Cloneable
,
java.io.Serializable
接口
HashMap的實作不是同步的，這意味着它是線程不安全的。它的key、value都可以為null,此外，
HashMap
中的映射不是有序的。
HashMap的執行個體有兩個參數影響其性能：“初始容量”和“加載因子”。容量是哈希表中桶的數量，初始容量知識哈希表在建立時的容量。加載因子是哈希表在其容量自動增加之前可以達到多滿的一種度量。當哈希表中的條目數超出了加載因子與目前容量的乘積時，則要對該哈希表進行rehash操作（即重建内部資料結構），進而哈希表将具有大約兩倍的桶數。
通常，預設加載因子是0.75，這是在時間和空間成本上尋求一種折中，加載因子過高雖然減少了空間開銷，但同時也增加了查詢成本（在大多數
HashMap
類的操作中，包括get和put操作，都反映了這一點）。在設定初始容量是應該考慮到映射所需要的條目數及其加載因子，以便最大限度地減少rehash操作次數。如果初始容量大于最大條目數除以加載因子，則不會發生rehash操作。
HashMap的構造函數
HashMap共有4個構造函數,如下：
// 預設構造函數。
HashMap()
// 指定“容量大小”的構造函數
HashMap(int capacity)
例如：當傳入capacity為8，預設加載因子為0.75時，當超過 最大值*加載因子時會擴容。即在第7個元素時會擴容
// 指定“容量大小”和“加載因子”的構造函數
HashMap(int capacity, float loadFactor)
// 包含“子Map”的構造函數
HashMap(Map<? extends K, ? extends V> map) HashMap的API
void clear()
Object clone()
boolean containsKey(Object key)
boolean containsValue(Object value)
Set<Entry<K, V>> entrySet()
V get(Object key)
boolean isEmpty()
Set<K> keySet()
V put(K key, V value)
void putAll(Map<? extends K, ? extends V> map)
V remove(Object key)
int size()
Collection<V> values() HashMap資料結構
HashMap的繼承關系
java.lang.Object
↳ java.util.AbstractMap<K, V>
↳ java.util.HashMap<K, V>
public class HashMap<K,V>
extends AbstractMap<K,V>
implements Map<K,V>, Cloneable, Serializable { } HashMap與Map關系如下圖：
從圖中可以看出：
1. HashMap繼承于AbstractMap類，實作了Map接口。Map是“key-value 鍵值對”接口。AbstractMap實作了“鍵值對”的通用函數接口。
2. HashMap是通過“拉鍊法”實作的哈希表。它包含幾個重要的成員變量：table,size,threshold,loadFactor,modCount。
table 是一個Entry[] 數組類型，而Entry實際上就是一個單向連結清單。哈希表的“key-value 鍵值對”都是存儲在Entry數組中的。
size是HashMap的大小，它是HashMap儲存的鍵值對的數量。預設大小為16
threshold是HashMap的門檻值，用于判斷是否需要調整HashMap的容量。threshold的值=“容量*加載因子”，當HashMap中存儲資料的數量達到threshold時，就需要将HashMap的容量加倍。
loadFactor就是加載因子。預設大小為0.75
modCount是用來實作fail-fast機制的。
HashMap源碼分析（基于JDK1.8_131）
說明：
在詳細介紹HashMap的代碼之前，我們需要了解：HashMap就是一個散清單，它是通過“拉鍊法”解決哈希沖突的。
還需要再補充說明的一點是影響HashMap性能的有兩個參數：初始容量（initialCapacity）和加載因子（loadFactor）。 容量是哈希表中桶的數量，初始容量隻是哈希表在建立時的容量。加載因子是哈希表在其容量自動增加之前可以達到多滿的一種尺度。當哈希表中的條目數超出了加載因子與目前容量的乘積時，則要對該哈希表進行rehash 操作。進而哈希表将具有大約兩倍的桶數。
HashMap的“拉鍊法”相關内容
HashMap資料存儲數組
transient Node<K,V>[] table;（ps:被transient修飾之後則不能被序列化） HashMap中的key-value都是存儲在Entry數組中的
資料節點Entry的資料結構
static class Node<K,V> implements Map.Entry<K,V> {
final int hash;
final K key;
V value;
//指向下一個節點
Node<K,V> next;
//構造函數
//輸入參數包括“哈希值（h）”,"鍵（K）","值（V）","下一節點（n）"
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;
}
/**
* 判斷兩個Node是否相等
* 若兩個Node的“key”和“value”都相等，則傳回true
* 否則傳回false
*/
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;
}
} 從中，我們可以看出Entry實際上就是一個單向連結清單。這也是為什麼我們說HashMap是通過拉鍊法來解決哈希沖突的。
Entry實作了Map.Entry接口，即實作getKey()，getValue(),setValue(V value),equals(Object o),hashCode(),這些函數。這些都是基本的讀取/修改key、value值得函數。
HashMap的構造函數
HashMap共包含4個構造函數
/**
* Constructs an empty <tt>HashMap</tt> with the specified initial
* capacity and load factor.
*
* @param initialCapacity the initial capacity
* @param loadFactor the load factor
* @throws IllegalArgumentException if the initial capacity is negative
* or the load factor is nonpositive
* 指定“容量大小”和“加載因子”的構造函數
*/
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;
//設定"HashMap門檻值"，當HashMap中存儲資料的數量達到threshold時，就需要将HashMap的容量加倍。
this.threshold = tableSizeFor(initialCapacity);
}
/**
* Constructs an empty <tt>HashMap</tt> with the specified initial
* capacity and the default load factor (0.75).
*
* @param initialCapacity the initial capacity.
* @throws IllegalArgumentException if the initial capacity is negative.
* 指定"容量大小"的構造函數
*/
public HashMap(int initialCapacity) {
this(initialCapacity, DEFAULT_LOAD_FACTOR);
}
/**
* Constructs an empty <tt>HashMap</tt> with the default initial capacity
* (16) and the default load factor (0.75).
* 建立一個空的HashMap，它的初始容量是16，加載因子是0.75
*/
public HashMap() {
this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
}
/**
* Constructs a new <tt>HashMap</tt> with the same mappings as the
* specified <tt>Map</tt>. The <tt>HashMap</tt> is created with
* default load factor (0.75) and an initial capacity sufficient to
* hold the mappings in the specified <tt>Map</tt>.
*
* @param m the map whose mappings are to be placed in this map
* @throws NullPointerException if the specified map is null
* 包含“子Map”的構造函數
*/
public HashMap(Map<? extends K, ? extends V> m) {
this.loadFactor = DEFAULT_LOAD_FACTOR;
//将m中的全部元素逐個添加到HashMap中
putMapEntries(m, false);
} HashMap的主要對外接口
clear()
clear()的作用是清空HashMap。它是通過将所有的元素設為null來實作的。
public void clear() {
Node<K,V>[] tab;
modCount++;
if ((tab = table) != null && size > 0) {
size = 0;
for (int i = 0; i < tab.length; ++i)
tab[i] = null;
}
} containsKey()
containsKey()的作用是判斷HashMap是否包含key.
public boolean containsKey(Object key) {
return getNode(hash(key), key) != null;
} containsKey()首先通過getNode(hash(key), key) 來擷取key 對應的Entry,然後判斷該Entry是否為null。
getNode() 的源碼如下：
final Node<K,V> getNode(int hash, Object key) {
Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
if ((tab = table) != null && (n = tab.length) > 0 &&
(first = tab[(n - 1) & hash]) != null) {
//總是檢查第一個元素，當滿足條件則直接傳回第一個元素
if (first.hash == hash && // always check first node
((k = first.key) == key || (key != null && key.equals(k))))
return first;
//如果第一個元素不滿足，則循環檢查其他元素
if ((e = first.next) != null) {
if (first instanceof TreeNode)
return ((TreeNode<K,V>)first).getTreeNode(hash, key);
do {
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))
return e;
} while ((e = e.next) != null);
}
}
return null;
} getNode()的作用就是傳回”鍵為key”的鍵值對。
containsValue()
containsValue()的作用是判斷HashMap是否包含“值為value”的元素。
public boolean containsValue(Object value) {
Node<K,V>[] tab; V v;
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不為null”,則查找HashMap中是否有值為value
//的節點。
if ((v = e.value) == value ||
(value != null && value.equals(v)))
return true;
}
}
}
return false;
} entrySet()、values()、keySet()
它們3個的原理類似，這裡以entrySet()為例來說明。
entrySet()的作用是傳回“HashMap中的所有Entry的集合”，它是一個集合。實作代碼如下：
//傳回“HashMap的Entry集合”，它實際上是傳回一個EntrySet對象
public Set<Map.Entry<K,V>> entrySet() {
Set<Map.Entry<K,V>> es;
return (es = entrySet) == null ? (entrySet = new EntrySet()) : es;
}
//EntrySet 對應的集合
//EntrySet繼承于AbstractSet，說明該集合中沒有重複的EntrySet。
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();
}
}
} HashMap是通過拉鍊法實作的散清單，表現在HashMap包含許多的Entry,而每一個Entry本質上又是一個單向連結清單。那麼HashMap周遊key-value鍵值對的時候，是如何逐個去周遊的呢？
下面我們就看看HashMap是如何通過entrySet()周遊的。
//Entry的疊代器
final class EntryIterator extends HashIterator
implements Iterator<Map.Entry<K,V>> {
public final Map.Entry<K,V> next() { return nextNode(); }
}
//
abstract class HashIterator {
Node<K,V> next; // next entry to return，下一個元素
Node<K,V> current; // current entry 目前元素
int expectedModCount; // for fast-fail 用于實作 fast-fail 機制
int index; // current slot 目前索引
HashIterator() {
expectedModCount = modCount;
Node<K,V>[] t = table;
current = next = null;
index = 0;
//将next指向table中第一個不為null的元素
//這裡利用了index的初始值為0，從0開始依次向後周遊，知道找到不為null的元素就退出循環
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();
//一個Entry就是一個單向連結清單
//若該Entry的下一個節點不為空，就将next指向下一個節點；
//否則，将next指向下一個連結清單（也是下一個Entry）的不為null的節點。
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;
}
} 當我們通過
entrySet()
擷取到
Iterator
的next()方法去周遊
HashMap
時，實際上調用的是nextNode()。而nextEntry()的實作方式，先周遊Node(根據Node在table中的序号，從小到大的周遊)；然後對每個Node(即單向連結清單)，逐個周遊。
get()
get()的作用是擷取key對應的value,它的實作代碼如下：
public V get(Object key) {
Node<K,V> e;
//hash(key) 擷取key的hash值
return (e = getNode(hash(key), key)) == null ? null : e.value;
}
/**
* Implements Map.get and related methods
*
* @param hash hash for key
* @param key the key
* @return the node, or null if none
*/
final Node<K,V> getNode(int hash, Object key) {
Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
//在"該hash值對應的連結清單"上查找"鍵值等于key"的元素
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;
} put()
put()的作用是
對外提供接口，讓HashMap對象可以通過put()将"key-value" 添加到HashMap中
。
public V put(K key, V value) {
return putVal(hash(key), key, value, false, true);
}
/**
* Implements Map.put and related methods
*
* @param hash hash for key
* @param key the key
* @param value the value to put
* @param onlyIfAbsent if true, don't change existing value
* @param evict if false, the table is in creation mode.
* @return previous value, or null if none
*/
final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
boolean evict) {
Node<K,V>[] tab; Node<K,V> p; int n, i;
//
if ((tab = table) == null || (n = tab.length) == 0)
n = (tab = resize()).length;
if ((p = tab[i = (n - 1) & hash]) == null)
tab[i] = newNode(hash, key, value, null);
else {
Node<K,V> e; K k;
//若“該key”對應的鍵值對已經存在，則用新的value取代舊的value,
//然後退出。
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
e = p;
else if (p instanceof TreeNode)
e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
else {
for (int binCount = 0; ; ++binCount) {
if ((e = p.next) == null) {
p.next = newNode(hash, key, value, null);
if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
treeifyBin(tab, hash);
break;
}
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))
break;
p = e;
}
}
if (e != null) { // existing mapping for key
V oldValue = e.value;
if (!onlyIfAbsent || oldValue == null)
e.value = value;
afterNodeAccess(e);
return oldValue;
}
}
//若“該key對應的鍵值對不存在，則将“key-value”添加到table中”
++modCount;
if (++size > threshold)
resize();
afterNodeInsertion(evict);
return null;
} 若要添加到HashMap中的鍵值對對應的key已經存在HashMap中，則找到該鍵值對；然後新的value取代舊的value,并退出。
如要添加到HashMap中的鍵值對對應的key不在HashMap中，則将其添加到該哈希值對應的連結清單中。
putAll()
putAll()的作用是将”m”的全部元素都添加到HashMap中，它的代碼如下：
public void putAll(Map<? extends K, ? extends V> m) {
putMapEntries(m, true);
}
final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
int s = m.size();
if (s > 0) {
if (table == null) { // pre-size
float ft = ((float)s / loadFactor) + 1.0F;
int t = ((ft < (float)MAXIMUM_CAPACITY) ?
(int)ft : MAXIMUM_CAPACITY);
if (t > threshold)
threshold = tableSizeFor(t);
}
else if (s > threshold)
resize();
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);
}
}
} remove()
remove()的作用是删除”鍵為key”元素
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 {
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實作的Cloneable接口
HashMap實作了Cloneable接口，即實作了clone()方法
clone() 方法的作用很簡單，就是克隆一個HashMap對象并傳回。
public Object clone() {
HashMap<K,V> result;
try {
result = (HashMap<K,V>)super.clone();
} catch (CloneNotSupportedException e) {
throw new InternalError(e);
}
result.reinitialize();
result.putMapEntries(this, false);
return result;
} HashMap實作的Serializable接口
HashMap實作了Serializable,分别實作了串行讀取、寫入功能。
串行寫入函數是writeObject()，它的作用是将HashMap的”總的容量，實際容量，所有的Node”都寫入到輸出流中。
而串行讀取函數是readObject()，它的作用是将HashMap的”總的容量，實際容量，所有的Node”依次讀出
// java.io.Serializable的寫入函數
// 将HashMap的“總的容量，實際容量，所有的Node”都寫入到輸出流中
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);
}
// java.io.Serializable的讀取函數：根據寫入方式讀出
// 将HashMap的“總的容量，實際容量，所有的Node”依次讀出
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);
}
}
} HashMap周遊方式
周遊HashMap的鍵值對
第一步：根據entrySet()擷取HashMap的“鍵值對”的Set集合。
第二步：通過Iterator疊代器周遊“第一步”得到的集合。
// 假設map是HashMap對象
// map中的key是String類型，value是Integer類型
Integer integ = null;
Iterator iter = map.entrySet().iterator();
while(iter.hasNext()) {
Map.Entry entry = (Map.Entry)iter.next();
// 擷取key
key = (String)entry.getKey();
// 擷取value
integ = (Integer)entry.getValue();
} 周遊HashMap的鍵
第一步：根據keySet()擷取HashMap的“鍵”的Set集合。
第二步：通過Iterator疊代器周遊“第一步”得到的集合。
// 假設map是HashMap對象
// map中的key是String類型，value是Integer類型
String key = null;
Integer integ = null;
Iterator iter = map.keySet().iterator();
while (iter.hasNext()) {
// 擷取key
key = (String)iter.next();
// 根據key，擷取value
integ = (Integer)map.get(key);
} 周遊HashMap的值
第一步：根據value()擷取HashMap的“值”的集合。
第二步：通過Iterator疊代器周遊“第一步”得到的集合。
// 假設map是HashMap對象
// map中的key是String類型，value是Integer類型
Integer value = null;
Collection c = map.values();
Iterator iter= c.iterator();
while (iter.hasNext()) {
value = (Integer)iter.next();
} ![Java小案例——随機數猜測随機數猜測[圖]](data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs=)