Java源码初学_HashMap

时间:2022-07-04 14:38:26

一.概念

  HashMap的实例有两个参数影响其性能:初始容量和加载因子。容量是哈希表中桶的数量,初始容量只是哈希表在创建时的容量。加载因子 是哈希表在其容量自动增加之前可以达到多满的一种尺度。当哈希表中的条目数超出了加载因子与当前容量的乘积时,则要对该哈希表进行rehash操作(即重建内部数据结构),从而哈希表将具有大约两倍的桶数。
  通常,默认加载因子 (.75) 在时间和空间成本上寻求一种折衷。加载因子过高虽然减少了空间开销,但同时也增加了查询成本(在大多数 HashMap 类的操作中,包括 get 和 put 操作,都反映了这一点)。在设置初始容量时应该考虑到映射中所需的条目数及其加载因子,以便最大限度地减少 rehash 操作次数。如果初始容量大于最大条目数除以加载因子,则不会发生 rehash 操作。
  HashMap的四个构造方法:
  1、HashMap():构造一个具有默认容量(16)和默认加载因子0.75的空HashMap
  2、HashMap(int capacity):构造一个具有指定容量和默认加载因子0.75的HashMap
  3、HashMap(int capacity,float loadFactor):构造一个具有指定容量和指定加载因子的HashMap
  4.HashMap(<key<? Extends E>,Value<? Extends V>>hashmap):构造一个和指定Map映射关系相同的HashMap

二.Map.entry的内部类
  Entry内部类有几个关键的成员变量.key值引用K key,value值引用V value,hash值hash,下一个entry的引用,实际上,在Map中,entry以类似于链表的结构进行存储.这种存储为数据的put和get提供了方便.Map.entry内部类的代码如下:

static class Entry<K,V> implements Map.Entry<K,V> {
final K key;
V value;
Entry<K,V> next;
final int hash; /**
*建立一个新的键值对
*/
Entry(int h, K k, V v, Entry<K,V> n) {
value = v;
next = n;
key = k;
hash = h;
} public final K getKey() {
return key;
} public final V getValue() {
return value;
}
//返回一个旧的值
public final V setValue(V newValue) {
V oldValue = value;
value = newValue;
return oldValue;
} public final boolean equals(Object o) {
if (!(o instanceof Map.Entry))
return false;
Map.Entry e = (Map.Entry)o;
Object k1 = getKey();
Object k2 = e.getKey();
if (k1 == k2 || (k1 != null && k1.equals(k2))) {
Object v1 = getValue();
Object v2 = e.getValue();
if (v1 == v2 || (v1 != null && v1.equals(v2)))
return true;
}
return false;
} public final int hashCode() {
return (key==null ? 0 : key.hashCode()) ^
(value==null ? 0 : value.hashCode());
} public final String toString() {
return getKey() + "=" + getValue();
} /**
该方法在复写一个键值对中的键以及存在的值的时候,调用
*/
void recordAccess(HashMap<K,V> m) {
} /**
* 该方法在移除table数组中的相应的键值对的时候调用
*/
void recordRemoval(HashMap<K,V> m) {
}
}

三.HashMap的初始化以及构造方法
  HashMap提供了默认的容量10,和默认装填因子(0.75),当容器中的元素/容器的容量>装填因子的时候,容器的容积将会扩大一倍,实际上,容器的容积一直是二的幂次方(如果指定容积,将会是大于等于该指定容积的最小的二的幂次方的一个数.
  构造函数的init方法是一个钩子,在构造方法和readObject方法里调用,在HashMap中,其方法体内部没有任何内容,交给子类来完成一些操作(例如会在LinkedHashMap中有特殊的操作,完成实现按照插入顺序排序).
  构造函数中传入参数为Map的时候,将会通过遍历entryset,获取每一个键值对的序列,并插入到this中.这里涉及到了插入的操作.(插入的操作的原理是先根据hash值寻找索引,然后在索引处观察该处是否为null,如果为null,直接建立新的索引,并将next设为null.如果不为null,则观察该索引处的entry对应的key值是否与插入的键值对的key值相等,如果相等,则替换key对应的值,如果不相等,从该entry的next出发,到达下一个entry继续判断.直到一个entry的next值为null.然后再插入.代码如下所示:

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); // 找到大于给定的参数的最小2的幂次方对应的数字的容量
//实际上容器的容量通常都是2的幂次方,因为在扩容的时候也是直接
//扩充到原来的2倍
int capacity = 1;
while (capacity < initialCapacity)
capacity <<= 1; this.loadFactor = loadFactor;
threshold = (int)(capacity * loadFactor);
table = new Entry[capacity];
init();//一个钩子,将交给子类来实现
}
//这里可以看出装填因子不发生改变
public HashMap(Map<? extends K, ? extends V> m) {
this(Math.max((int) (m.size() / DEFAULT_LOAD_FACTOR) + 1,
DEFAULT_INITIAL_CAPACITY), DEFAULT_LOAD_FACTOR);
putAllForCreate(m);
}
//调用extryset的iterator方法获得每一个Map.entry对象.然后,通过此对象获取key和value
private void putAllForCreate(Map<? extends K, ? extends V> m) {
for (Iterator<? extends Map.Entry<? extends K, ? extends V>> i = m.entrySet().iterator(); i.hasNext(); ) {
Map.Entry<? extends K, ? extends V> e = i.next();
putForCreate(e.getKey(), e.getValue());
}
}
private void putForCreate(K key, V value) {
int hash = (key == null) ? 0 : hash(key.hashCode());
//知道hash值应该如何去寻找索引
int i = indexFor(hash, table.length);
/*
在索引处观察.如果索引处为null,直接插入键和值.
如果索引处不为null,则观察放在该索引的位置上的元素
是否与key相同,不相同则继续用next获取下一个entry,看它
是否有key,如果有,则更换值.如果没有,继续遍历,直到下一个为next,
此时则创建key,value键值对.并将tables[i]指向它
*/
for (Entry<K,V> e = table[i]; e != null; e = e.next) {
Object k;
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k)))) {
e.value = value;
return;
}
} createEntry(hash, key, value, i);
}
static int indexFor(int h, int length) {
return h & (length-1);
}
//创建新的键值对.该键值对的next指向原来的table数组对应的索引的键值对的引用
//方法结束后,该键值对将会成为tables[i]数组对应的引用
void createEntry(int hash, K key, V value, int bucketIndex) {
Entry<K,V> e = table[bucketIndex];
table[bucketIndex] = new Entry<K,V>(hash, key, value, e);
size++;
}

  从方法的实现可以看出来,在插入元素的时候,是支持插入null-null键值对的.HashMap内部的数据结构以及插入元素的原理可以用下图来表示:

Java源码初学_HashMap

四.HashMap的getter/setter/contains方法
  Getter/setter/contains方法,是基于其内部的数据结构实现获取和插入等操作,其中put操作的步骤如下:
  1.如果key==null,则单独处理,如果key不为null,
  2.先计算key的hash值,并且根据key值获取其索引.
  3.如果在索引处没有元素,则将建立一个新的entry.该entry的next为null
  4.如果索引处有元素.先是对索引处的entry及接下来的next进行遍历,看这些entry的key是否与插入的key相同,如果相同,直接将值覆盖.并返回旧值.
  5.如果一直到最后都没有entry的key与传入的key相同,则新建立一个entry.它的next是在方法调用之前的索引处的entry引用,随后,将新创建的entry对象赋给索引处的entry引用.
  Put/get/contains方法实现的代码如下:

     public V get(Object key) {
if (key == null)
return getForNullKey();
int hash = hash(key.hashCode());//获取hash值
//对于每一个e及其next指向的Entry元素的key值进行判断.
//如果相同则返回e.value.如果一直到下一个entry的指向为null
//的元素,都没有匹配的Entry,则返回null
for (Entry<K,V> e = table[indexFor(hash, table.length)];
e != null;
e = e.next) {
Object k;
if (e.hash == hash && ((k = e.key) == key || key.equals(k)))
return e.value;
}
return null;
} //针对传入的参数键为null的情况进行特殊处理.提高效率
private V getForNullKey() {
for (Entry<K,V> e = table[0]; e != null; e = e.next) {
if (e.key == null)
return e.value;
}
return null;
} /**
* 通过判断key的entry是否为null,来判断是否存在key
*/
public boolean containsKey(Object key) {
return getEntry(key) != null;
}
//根据指定的key获取它的entry
final Entry<K,V> getEntry(Object key) {
int hash = (key == null) ? 0 : hash(key.hashCode());
for (Entry<K,V> e = table[indexFor(hash, table.length)];
e != null;
e = e.next) {
Object k;
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))
return e;
}
return null;
} /**
插入key,value键值对
*/
public V put(K key, V value) {
if (key == null)
return putForNullKey(value);
int hash = hash(key.hashCode());
int i = indexFor(hash, table.length);
for (Entry<K,V> e = table[i]; e != null; e = e.next) {
Object k;
if (e.hash == hash && ((k = e.key) == key || key.equals(k))) {
V oldValue = e.value;
e.value = value;
e.recordAccess(this);
return oldValue;
}
} modCount++;
addEntry(hash, key, value, i);
return null;
} /**
* 对于传入的key为null的引用的时候,单独处理
*/
private V putForNullKey(V value) {
for (Entry<K,V> e = table[0]; e != null; e = e.next) {
if (e.key == null) {
V oldValue = e.value;
e.value = value;
e.recordAccess(this);
return oldValue;
}
}
modCount++;
addEntry(0, null, value, 0);
return null;
}

五.HashMap调整大小的方法
  调整大小先建立一个新的指定容量大小的数组,然后,将旧数组里的元素拷贝到新的数组中去。拷贝的思路是对于每一个旧数组的元素进行rehash,即重新计算索引,并插入到新的索引处的位置,对象本身保持不变,仅仅变化了数组的大小以及对象的索引。代码如下:

void resize(int newCapacity) {
Entry[] oldTable = table;
int oldCapacity = oldTable.length;
if (oldCapacity == MAXIMUM_CAPACITY) {
threshold = Integer.MAX_VALUE;
return;
}
Entry[] newTable = new Entry[newCapacity];
transfer(newTable);
table = newTable;
threshold = (int)(newCapacity * loadFactor);
} void transfer(Entry[] newTable) {
Entry[] src = table;
int newCapacity = newTable.length;
for (int j = 0; j < src.length; j++) {
Entry<K,V> e = src[j];
if (e != null) {
src[j] = null;
do {
//将元素依次插入
Entry<K,V> next = e.next;
int i = indexFor(e.hash, newCapacity);
e.next = newTable[i];
newTable[i] = e;
e = next;
} while (e != null);
}
}
}

六.putAll和remove方法
  putAll方法实现插入一个map中的所有元素的操作,基本思路是先扩容,再调用add方法添加元素.remove方法的实现要判断key所对应的entry是否就是数组指向的元素.代码如下:

 public void putAll(Map<? extends K, ? extends V> m) {
int numKeysToBeAdded = m.size();
if (numKeysToBeAdded == 0)
return; /*
扩充这个map.很明显在resize方法结束后,原来的容器的size+新加入的元素数量
可能会大于threshold.不过由于在接下来的添加操作中也会进行resize方法的调用.
因此只调用了一次resize方法
*/
//扩容
if (numKeysToBeAdded > threshold) {
int targetCapacity = (int)(numKeysToBeAdded / loadFactor + 1);
if (targetCapacity > MAXIMUM_CAPACITY)
targetCapacity = MAXIMUM_CAPACITY;
int newCapacity = table.length;
while (newCapacity < targetCapacity)
newCapacity <<= 1;
if (newCapacity > table.length)
resize(newCapacity);
}
//添加元素(添加元素的时候,也会发生resize操作)
for (Iterator<? extends Map.Entry<? extends K, ? extends V>> i = m.entrySet().iterator(); i.hasNext(); ) {
Map.Entry<? extends K, ? extends V> e = i.next();
put(e.getKey(), e.getValue());
}
}
//根据键移除键值对.返回旧值
public V remove(Object key) {
Entry<K,V> e = removeEntryForKey(key);
return (e == null ? null : e.value);
} final Entry<K,V> removeEntryForKey(Object key) {
int hash = (key == null) ? 0 : hash(key.hashCode());
int i = indexFor(hash, table.length);
Entry<K,V> prev = table[i];
Entry<K,V> e = prev; while (e != null) {
Entry<K,V> next = e.next;
Object k;
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k)))) {
modCount++;//改变容器大小的操作,需要增加modCount的值
size--;
//e是第一个元素
if (prev == e)
table[i] = next;
else
prev.next = next;
e.recordRemoval(this);
return e;
}
prev = e;
e = next;
} return e;
} /**
* 根据entry移除键值对的操作
*/
final Entry<K,V> removeMapping(Object o) {
if (!(o instanceof Map.Entry))
return null; Map.Entry<K,V> entry = (Map.Entry<K,V>) o;
Object key = entry.getKey();
int hash = (key == null) ? 0 : hash(key.hashCode());
int i = indexFor(hash, table.length);
Entry<K,V> prev = table[i];
Entry<K,V> e = prev; while (e != null) {
Entry<K,V> next = e.next;
if (e.hash == hash && e.equals(entry)) {
modCount++;
size--;
if (prev == e)
table[i] = next;
else
prev.next = next;
e.recordRemoval(this);
return e;
}
prev = e;
e = next;
} return e;
}

七.clear,containsValue方法
  知道数据结构,算法就显得很简单了,基本的代码如下:

/**
*移除所有的元素
*/
public void clear() {
modCount++;
Entry[] tab = table;
for (int i = 0; i < tab.length; i++)
tab[i] = null;
size = 0;
} /**
*是否包含某个具体的值
*/
public boolean containsValue(Object value) {
if (value == null)
return containsNullValue(); Entry[] tab = table;
for (int i = 0; i < tab.length ; i++)
for (Entry e = tab[i] ; e != null ; e = e.next)
if (value.equals(e.value))
return true;
return false;
} /**
* 对于null值单独判断
*/
private boolean containsNullValue() {
Entry[] tab = table;
for (int i = 0; i < tab.length ; i++)
for (Entry e = tab[i] ; e != null ; e = e.next)
if (e.value == null)
return true;
return false;
}

八.Iterator的实现
  首先在HashMap中提供了一个默认的HashIterator供子类的Iterator实现,这个实现为keyset和entryset方法奠定了基石:

//一个抽象的HashIterator.将next方法的实现交给子类完成
private abstract class HashIterator<E> implements Iterator<E> {
Entry<K,V> next; // 下一个要返回的entry
int expectedModCount; // for fast fail
int index; //指针的位置
Entry<K,V> current; // 当前的entry HashIterator() {
expectedModCount = modCount;
if (size > 0) { // 前进到第一个指针.(entry在数组中的分布不是规律的,有的数组的索引为null.有的有元素)
Entry[] t = table;
while (index < t.length && (next = t[index++]) == null)
;
}
} public final boolean hasNext() {
return next != null;
} final Entry<K,V> nextEntry() {
if (modCount != expectedModCount)
throw new ConcurrentModificationException();
Entry<K,V> e = next;
if (e == null)
throw new NoSuchElementException(); if ((next = e.next) == null) {
Entry[] t = table;
//前进到下一个有元素的数组索引位置
while (index < t.length && (next = t[index++]) == null)
;
}
current = e;
return e;
} public void remove() {
if (current == null)
throw new IllegalStateException();
if (modCount != expectedModCount)
throw new ConcurrentModificationException();
Object k = current.key;
current = null;
HashMap.this.removeEntryForKey(k);
expectedModCount = modCount;
} }
//供子类实现
private final class ValueIterator extends HashIterator<V> {
public V next() {
return nextEntry().value;
}
} private final class KeyIterator extends HashIterator<K> {
public K next() {
return nextEntry().getKey();
}
} private final class EntryIterator extends HashIterator<Map.Entry<K,V>> {
public Map.Entry<K,V> next() {
return nextEntry();
}
}

  keyset和entryset都是建立在HashIterator的基础上的:

 public Set<K> keySet() {
Set<K> ks = keySet;
return (ks != null ? ks : (keySet = new KeySet()));
} private final class KeySet extends AbstractSet<K> {
public Iterator<K> iterator() {
return newKeyIterator();
}
public int size() {
return size;
}
public boolean contains(Object o) {
return containsKey(o);
}
public boolean remove(Object o) {
return HashMap.this.removeEntryForKey(o) != null;
}
public void clear() {
HashMap.this.clear();
}
}
public Set<Map.Entry<K,V>> entrySet() {
return entrySet0();
} private Set<Map.Entry<K,V>> entrySet0() {
Set<Map.Entry<K,V>> es = entrySet;
return es != null ? es : (entrySet = new EntrySet());
} private final class EntrySet extends AbstractSet<Map.Entry<K,V>> {
public Iterator<Map.Entry<K,V>> iterator() {
return newEntryIterator();
}
public boolean contains(Object o) {
if (!(o instanceof Map.Entry))
return false;
Map.Entry<K,V> e = (Map.Entry<K,V>) o;
Entry<K,V> candidate = getEntry(e.getKey());
return candidate != null && candidate.equals(e);
}
public boolean remove(Object o) {
return removeMapping(o) != null;
}
public int size() {
return size;
}
public void clear() {
HashMap.this.clear();
}
}