HashMap源码

HashMap源码

1、简介

HashMap是基于哈希表的Map接口的实现，是以key-value存储形式存在，即主要用来存放键值对，HashMap的实现不是同步的，这意味着它不是线程安全的，它的key、value都可以为null
HashMap中的映射下不是有序的。

java1.8之前的HashMap由数组-链表组成的，数组是HashMap主体，链表则是主要为了解决哈希冲突(两个对象调用 hashcode方法计算的哈希码值一致导致计算的数组索引相同)而存在的。
java1.8以后在解决哈希冲突上有了变化，当链表长度大于阈值(或者红黑树的边界值，默认为8)并且当前的数组的长度大于64时。此时此索引位置的所有数据改为使用红黑树存储。

- 补充
	将链表转换为红黑树前会判断，即使阈值大于8，但是数组长度小于64，此时并不会将链表变为红黑树，而选择进行数组扩容
这样做的目的是因为数组比较小，尽量避开红黑树结构，这种情况下变为红黑树，反而会降低效率，因为红黑树需要进行左旋，右旋，变色这些操作来保持平衡。同时数组长度小于64时，搜索时间相对要快些。所以综上所述，为了提高性能和减少搜索速度，底层在阈值大于8并且数组长度大于64，链表才转换成红黑树。
具体方法treeifyBin()方法。


特点：
1. 存取无序的
2. 键和值位置可以是null，但是键的位置只能有一个是null
3. 键位置是唯一的，底层的数据结构控制键
4. java 1.8前数据结构是数组+链表   java 1.8后数据结构是数组+链表+红黑树
5. 阈值 > 8 并且数组长度大于64，才能将链表转换为红黑树，变为红黑树是为了高效查询

2、 HashMap底层数据结构

HashMap存储方法

当创建HashMap集合对象的时候，在jdk1.8前构造方法中创建一个一个长度是16的Entry[] table用来存储键值对数据的。jdk1.8后是在第一次调用put方法是创建的数组Node[] table。

HashMap<String, Integer> map = new HashMap<>();

map.put("t1",1);
map.put("t2",2);
map.put("t3",3);
map.put("t4",4);

System.out.println(map);

上述代码中创建了一个HashMap(),根据key("T1,T2,T3,T4")调用String类中重写的hashcode()方法计算出值，结合数组长度采用某种算法计算出向Node数组中存储数据的空间索引值。如果计算出索引空间中没有数据，则直接将key对象的value存储到数组中。

- 哈希表底层采用何种算法计算hash值?还有哪些算法可以计算出hash值?
底层采用的key的hashcode方法的值结合数组长度进行无符号右移(>>)，按位异或(^)，按位与(&)计算出索引。

还可以采用：平方取中法、取余数、伪随机数法
而最后采用位运算是因为位运算效率高。

再向map中put数据
map.put("t5",5);
假如计算出的hashCode方法结合数组长度计算出的索引值和"T1"的索引值一致。那么当前索引的数组空间不是null，此时底层会比较"T1","T5"的hash值是否一致。
如果不一致，则在此空间上划出一个节点来存储"T5"。

如果一致。此时发生了哈希冲突。那么底层会调用String类中的equals方法比较两个内容知否相等。
	- 相等：则将后添加的数据的value覆盖之前的value
	- 不相等：那么继续向下和其他的数据key进行比较，如果都不相等，则划				出一个节点存储数据

3、HashMap的继承关系

public class HashMap<k,v> extends AbstractMap<k,v>
implement Map<k,v>,Cloneable,Serializable{
}

可以看出HashMap继承了AbstractMap类，实现了Map、Cloneable、Serializable

Cloneable是标记接口，表示可克隆
Serializable是用于序列化，表示对象可以被序列化和反序列化
AbstractMap提供Map实现接口。以最大限度地减少实现此接口所需的工作。

4、HashMap集合类的成员变量

1、序列化版本号
private static final long serialVersionUID = 362498820763181265L;

2、集合的初始化容量(必须是二的n此幂)
- 默认的初始化容量是16
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; 

- 问题1：为什么必须是2的n次幂?如果不是，会怎样
当向HashMap中添加一个元素的时候，需要根据key的hash值，去确定其在数组中的具体位置.HashMap为了存取高效，要尽量较少碰撞，就是要尽量把数据分配均匀，每个链表长度大致相同，这个实现就在把数据存到哪个链表中的算法。
这个算法就是取模。hash%length,计算机中直接求余效率不如位运算，所以在源码中做了优化，使用hash&(length - 1)，而实际上hash%length等于hash&(length - 1)的前提是length是2的n次幂。

- 问题2：为什么这样可以减少冲突?
要想冲突尽量少，就使用取模的方式，取模可以是元素分布的更加均匀。
但是在计算机中，取模运算太慢了，所以用模运算提升效率。
因此我们原本的运算时hash%length 可以转变为运算hash&(length - 1)
但是前提是必须是2的n次幂。



- 问题3：在初始化构造函数时，可以指定容量，如果指定的容量不是2的n次幂，会怎么处理?
在构造函数时详细讲解。


3、集合最大容量 2^30
static final int MAXIMUM_CAPACITY = 1 << 30;

4、默认的负载因子，默认值是0.75
static final float DEFAULT_LOAD_FACTOR = 0.75f;

5、当链表的值超过8则会转为红黑树
static final int TREEIFY_THRESHOLD = 8;

- 为什么节点超过8才转为红黑树
在注释中有这样一段话：
因为树节点的大小大约是普通节点的两倍，所以我们只在箱子包含足够的节点时才使用树节点。当它们变得太小时，就是转换为链表。在理想的情况下，在随机哈希码下，箱子中节点的频率服从泊松分布。

6、节点小于6时，转换为链表
static final int UNTREEIFY_THRESHOLD = 6;

7、当Map里面的数量超过这个值时，表中的桶才能树形化，否则是扩容
static final int MIN_TREEIFY_CAPACITY = 64;

8、table用来初始化
transient Node<k,v>[] table;

9、用来存放缓存  存放具体的元素集合
transient Set<Map.Entry<k,v>> entrySet;

10、HashMap中存放元素个数 不等于数组的长度
transient int size;

11、用来记录HashMap的修改次数 每次扩容和更改map结构的计数器
transient int modCount;

12、用来调整大小下一个容量的值    计算方式为(容量 X 负载因子)
- 临界值  当实际大小(容量 X 负载因子)超过临界值时，会进行扩容
int threshold;

13、哈希表的加载因子
final float loadFactor;
- 加载因子说明
loadFactor 是用来衡量HashMap满的程度，表示HashMap的疏密程度，影响hash操作到同一个数组位置的概率。计算HashMap的实时加载因子的方法为：size/capacity，而不是占用桶的数量去除以capacity。capacity是桶的数量，也就是table的长度length。
loadFactor 太大导致查找元素效率低，太小导致数组的利用率低，存放的数据会很分散。loadFactor的默认值为0.75f是官方给出的一个比较好的临界值。
当HashMap里面容纳的元素已经达到HashMap数组长度的75%时，表示HashMap太挤了，需要扩容，而扩容这个过程涉及rehash、复制数据等操作。非常消耗性能。所以开发中尽量减少扩容的次数。

5、HashMap集合类的成员方法

5.1、构造方法

1、 无参构造、默认初始容量(16)和默认负载因子(0.75)
public HashMap() {
    this.loadFactor = DEFAULT_LOAD_FACTOR;
}

2、 构造一个具有指定的初始化容量和默认负载因子(0.75)
public HashMap(int initialCapacity) {
    this(initialCapacity, DEFAULT_LOAD_FACTOR);
}

3、 构造方法
public HashMap(int initialCapacity, float loadFactor) {
    //判断初始化容量是否小于0
    if (initialCapacity < 0)
        throw new IllegalArgumentException("Illegal initial capacity: " + initialCapacity);
    //判断初始化容量是否大于集合的最大容量
    if (initialCapacity > MAXIMUM_CAPACITY)
        initialCapacity = MAXIMUM_CAPACITY;
    
    //判断加载因子是否小于等于0或者是否等于loadFactor
    if (loadFactor <= 0 || Float.isNaN(loadFactor))
        throw new IllegalArgumentException("Illegal load factor: " + loadFactor);
    this.loadFactor = loadFactor;
    
    //Returns a power of two size for the given target capacity.
    //获取比传入参数大的最小的2的N次幂。
    //在讲解成员变量时，我们说过数组容量必须是2的n次幂。就是通过这个方	法来约束的。
    //需要注意的是：threshold是边界值，不是直接等于数组长度，还需要乘以加载因子。这是因为在jdk1.8之后的构造方法中，并没有对table这个成员变量进行初始化，table的初始化被推迟到put方法中了。
    this.threshold = tableSizeFor(initialCapacity);
}


4、 包含Map的构造函数
public HashMap(Map<? extends K, ? extends V> m) {
    this.loadFactor = DEFAULT_LOAD_FACTOR;
    putMapEntries(m, false);
}    
//调用的putMapEntries()方法
final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
    //获取Map的长度
    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);
        }
    }
}

5.2、put()方法

put方法比较复杂，实现步骤大致如下:
1、 先通过hash值计算出key映射到哪个桶。
2、 如果桶上没有碰撞冲突，则直接插入。
3、 如果出现碰撞冲突，则需要处理冲突
	- 如果该桶使用红黑树处理冲突，则调用红黑树的方法插入数据
	- 如果是链表，则需要判断链表长度是否达到临界值。
4、 如果桶中存在重复的键，则为该键替换新值value。
5、 如果size大于阈值threshold，则进行扩容

//put()源码
public V put(K key, V value) {
    return putVal(hash(key), key, value, false, true);
}

//hash(key)方法
static final int hash(Object key) {
    int h;
    /**
    *   如果key等于null，hash值返回0
    *   如果key不等于null，
    *		首先计算出key的hashCode赋值给h，然后与h无符号右移16位后的二进制按异或得到最后的hash值
    */
    return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}
//为什么要右移16位?
如果当n很小，假设是16的话，那么n-1即为--->1111，这样的值和hashcode()直接做按位与操作，实际上只使用了哈希值的后4位。如果当哈希值的高位变化很大，地位变化很小，这样很容易造成哈希冲突。所以这里把高低位都利用起来，从而解决这个问题。

//putVal()方法
final V putVal(int hash, K key, V value, boolean onlyIfAbsent,boolean evict) {
    
    Node<K,V>[] tab; //在put方法是创建数组
    Node<K,V> p; 	 //索引指向的节点
    int n, i;		 //n 数组长度  i 索引
    
    //将tab赋值给table，，并且判断table是否是空
    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;
        //判断hash值，key值是否相同，如果相同，节点直接替换
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            e = p;
        //hash不同，判断是否是树节点，如果是，直接调用树节点类中的方法
        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) 
                        //转换为红黑树
                        treeifyBin(tab, hash);
                    break;
                }
                //遍历链表的过程中，查找到hash。key相同的
                if (e.hash == hash &&
                    ((k = e.key) == key || (key != null && key.equals(k))))
                    break;
                p = e;
            }
        }
        
        //是在for循环中查找到hash，key相同的，才执行下面的
        if (e != null) { // existing mapping for key
            V oldValue = e.value;
            if (!onlyIfAbsent || oldValue == null)
                e.value = value;
            afterNodeAccess(e);
            return oldValue;
        }
    }
    //修改次数+1
    ++modCount;
    //判断是否需要扩容
    if (++size > threshold)
        resize();
    afterNodeInsertion(evict);
    return null;
}

5.3、treeifyBin()方法

//替换指定哈希表的索引处桶中的所有链接节点，除非表太小，否则将修改大小
/**
*	tab  数组
*	hash 当前这个桶的hash值
*/
final void treeifyBin(Node<K,V>[] tab, int hash) {
    int n, index; Node<K,V> e;
    //如果空，或者小于最小的转换红黑树的临界值64，即不需要转换为红黑树
    if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
        //扩容
        resize();
    //e是的当前索引指向的节点
    else if ((e = tab[index = (n - 1) & hash]) != null) {
        TreeNode<K,V> hd = null, tl = null;
        do {
            //将链表节点替换为树节点
            TreeNode<K,V> p = replacementTreeNode(e, null);
            if (tl == null)
                hd = p; 
            else {
                //连接节点
                p.prev = tl;
                tl.next = p;
            }
            tl = p;
        } while ((e = e.next) != null);
        //将上面的双向链表转变为红黑树
        if ((tab[index] = hd) != null)
            hd.treeify(tab);
    }
}

5.4、resize()方法

扩容机制:
进行扩容，会伴随着一次重新hash分配，并且会遍历hash表中所有的元素，是非常耗时的。在编写程序中，要尽量避免resize()
HashMap在进行扩容时，使用的rehash()方式非常巧妙，因为每次扩容都是翻倍，与原来计算的(n-1)&hash的结果相比，只是多一个bit位，所以节点要么就是原来的位置，要么就被分配到"原索引+旧数组长度"这个位置。

原数组长度：16 n = 16 n-1 -->15
0000 0000 0000 0000 0000 0000 0000 1111   15

第一个hash值
hash1 = 1111 1111 1111 1111 0000 1111 0000 0101
(n-1)&hash = 5

第二个hash值
hash2 = 1111 1111 1111 1111 0000 1111 0001 0101
(n-1)&hash = 5


数组长度扩容：32 n = 32 n-1 --> 31
0000 0000 0000 0000 0000 0000 0001 1111   31
第一个hash值
hash1 = 1111 1111 1111 1111 0000 1111 0000 0101
(n-1)&hash = 5

第二个hash值
hash2 = 1111 1111 1111 1111 0000 1111 0001 0101
(n-1)&hash = 21 = 16 + 5

//源码
final Node<K,V>[] resize() {
    //原的数组赋值
    Node<K,V>[] oldTab = table;
    //原数组的长度
    int oldCap = (oldTab == null) ? 0 : oldTab.length;
    //原数组的临界值
    int oldThr = threshold;
   	//新数组的长度和临界值
    int newCap, newThr = 0;
    if (oldCap > 0) {
        if (oldCap >= MAXIMUM_CAPACITY) {
            threshold = Integer.MAX_VALUE;
            return oldTab;
        }
        //新数组长度左移一位后判断是否超过最大的数组容量，并且判断原数组长度是否大于默认长度
        else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                 oldCap >= DEFAULT_INITIAL_CAPACITY)
            newThr = oldThr << 1; //边界值左移一位
    }
    else if (oldThr > 0) 
        newCap = oldThr;
    else {               
        newCap = DEFAULT_INITIAL_CAPACITY;
        newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
    }
    if (newThr == 0) {
        float ft = (float)newCap * loadFactor;
        newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
                  (int)ft : Integer.MAX_VALUE);
    }
    threshold = newThr;
    
    @SuppressWarnings({"rawtypes","unchecked"})
    //创建新的数组，长度是NewCap
    Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
    table = newTab;
    if (oldTab != null) {
        //开始循环，将老数组的数据放进新数组
        for (int j = 0; j < oldCap; ++j) {
            Node<K,V> e;
            //得到当前索引指向的节点
            if ((e = oldTab[j]) != null) {
                oldTab[j] = null;
                if (e.next == null)
                    //只有一个节点，就直接放进新数组中
                    newTab[e.hash & (newCap - 1)] = e;
                //红黑树
                else if (e instanceof TreeNode)
                    ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
                //链表
                else { 
                    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 {
                            if (hiTail == null)
                                hiHead = e;
                            else
                                hiTail.next = e;
                            hiTail = e;
                        }
                    } while ((e = next) != null);
                    if (loTail != null) {
                        loTail.next = null;
                        newTab[j] = loHead;
                    }
                    if (hiTail != null) {
                        hiTail.next = null;
                        newTab[j + oldCap] = hiHead;
                    }
                }
            }
        }
    }
    return newTab;
}

5.5、remove()方法

删除方法就是首先找到元素的位置，如果是链表就直接删除，如果是红黑树还需要判断是否是小于6转换为链表

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;
    //table长度大于0，并且索引指向的数组元素不为null
    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);
            }
        }
        
        //找到节点，node 如果是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;
}

5.6、get()方法

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 && 
            ((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;
}

5.7、遍历HashMap

1、 遍历key和values

HashMap<String, Integer> map = new HashMap<>();

map.put("t1",1);
map.put("t2",2);
map.put("t3",3);
map.put("t4",4);
map.put("t5",5);

System.out.println(map.keySet());
System.out.println(map.values());

2、 使用iterator迭代器迭代

for (HashMap.Entry<String, Integer> entry : map.entrySet()) {
    System.out.println("Key = " + entry.getKey() + ", Value = " + entry.getValue());
}