《Java源码解析》集合框架Map之HashMap

柔情只为你懂 2022-07-13 03:50 275阅读 0赞

前面的几篇博客分析了List的两种实现ArrayList和LinkedList实现的源码，接下来就是分析Map的几个实现，下面首先分析Map的实现之一 **HashMap**

# HashMap #

还是老规矩，先看HashMap的继承体系：

## 1. HashMap的继承体系 ##

![HashMap的继承体系][HashMap]

HashMap主要是继承自AbstractMap，实现了Cloneable和Serializable接口使得HashMap具有克隆和序列化的功能、实现了Map接口因此具有Map的性质。

## 2.HashMap的重要属性： ##

HashMap和HashTable一样，底层是基于“链表+数组”的结构实现的。

先来看看HashMap里面的重要属性：

//HashMap默认的容量大小16。(HashMap的容量大小只能是2的次幂数)
    static final int DEFAULT_INITIAL_CAPACITY = 1 << 4;
    //HashMap的最大容量
    static final int MAXIMUM_CAPACITY = 1 << 30;
    //默认的HashMap扩容的加载因子，当HashMap的容量使用超过了capacity*loadFactor时就是进行扩容。
    static final float DEFAULT_LOAD_FACTOR = 0.75f;
    //这是个共享的空的Table
    static final Entry<?,?>[] EMPTY_TABLE = {};
    //这个table数组是用来存储HashMap的每个实体的
    transient Entry<K,V>[] table = (Entry<K,V>[]) EMPTY_TABLE;
    //表示HashMap已经存放的实体的容量
    transient int size;
    //
    int threshold;
    //加载因子
    final float loadFactor;
    //Map修改的次数
    transient int modCount;
    //
    static final int ALTERNATIVE_HASHING_THRESHOLD_DEFAULT = Integer.MAX_VALUE;

其中有个重要的类，也就是Entry

static class Entry<K,V> implements Map.Entry<K,V> {
        final K key;//key
        V value;//value
        Entry<K,V> next;//指向下一个结点的指针
        int hash;//hash值
    
        //构造器，传入Entry的四个属性
        Entry(int h, K k, V v, Entry<K,V> n) {
            value = v;
            next = n;//该Entry的后继
            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 Objects.hashCode(getKey()) ^ Objects.hashCode(getValue());
        }
    
        public final String toString() {
            return getKey() + "=" + getValue();
        }
    
        /** * 当调用put(k,v)存入HashMap中时，如果key已经存在了，就会自动调用该函数 */
        void recordAccess(HashMap<K,V> m) {
        }
    
        /** * 当从table中删除实体时会自动调用该方法。 */
        void recordRemoval(HashMap<K,V> m) {
        }
    }

看了这个实体Entry的四个属性，大概就能知道Entry组成的是一个**单向链表**，因为里面只有Entry的后继Entry，而没有Entry的前驱Entry。用图表示应该是这么一个数据结构：  
![这里写图片描述][801753-20151208204904136-1453407209.png]

## 3. HashMap的构造器 ##

当我们使用 `new HashMap()` 构造对象的时候，默认调用的是：

public HashMap(){
        this(DEFAULT_INITIAL_CAPACITY, DEFAULT_LOAD_FACTOR);
    }

即使用默认的DEFAULT\_INITIAL\_CAPACITY初始容量和DEFAULT\_LOAD\_FACTOR加载因子来调用  
HashMap(int initialCapacity, float loadFactor)，其实当我们使用HashMap(int initialCapacity)来创建一个HashMap对象的时候也不过是指定了初始容量，然后也是调用HashMap(int initialCapacity, float loadFactor)来new一个HashMap对象。下面看看HashMap(int initialCapacity, float loadFactor)函数的实现：

public HashMap(int initialCapacity, float loadFactor) {
        //校验initialCapacity必须是非负数
        if (initialCapacity < 0)
            throw new IllegalArgumentException("Illegal initial capacity: " +
                                               initialCapacity);
        //设置capacity的上限
        if (initialCapacity > MAXIMUM_CAPACITY)
            initialCapacity = MAXIMUM_CAPACITY;
        //校验loadFactor加载因子参数的合法性
        if (loadFactor <= 0 || Float.isNaN(loadFactor))
            throw new IllegalArgumentException("Illegal load factor: " + loadFactor);
        //加载因子
        this.loadFactor = loadFactor;
        //threshold表示当HashMap的size大于threshold时会执行resize操作。 
        threshold = initialCapacity;
        init();//这是一个空函数，在LinkedHashMap中会实现这个函数
    }

在这个构造函数中我们需要注意的是两点：1.是threshold变量，表示的是当HashMap的size大于threshold时会执行resize操作。 即会进行扩容。2.该构造函数并没有初始化initialCapacity个容量的table表,n那么该table表是在什么时候被初始化的呢？我估计应该是在第一次put(K,V)时新建的table表，也就是使用了所谓的延迟加载。

> 看到这里我们必须要清楚的概念就是：HashMap的键值对是存储在table数组里面的，table的length属性即是HashMap的capacity属性。HashMap的size属性即时HashMap中已存的数据的容量。

## 4.五个关注点在HashMap中的答案 ##

HashMap

<table> 
 <thead> 
  <tr> 
   <th>关注点</th> 
   <th align="center">结论</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>集合底层实现的数据结构</td> 
   <td align="center">数组+单链表</td> 
  </tr> 
  <tr> 
   <td>集合中元素是否允许为空</td> 
   <td align="center">Key和Value都允许为空</td> 
  </tr> 
  <tr> 
   <td>是否允许重复的数据</td> 
   <td align="center">Key会被覆盖，但是Value 允许重复</td> 
  </tr> 
  <tr> 
   <td>是否有序</td> 
   <td align="center">无序，特别说明这个无序指的是遍历HashMap的时候，得到的元素的顺序基本不可能是put的顺序</td> 
  </tr> 
  <tr> 
   <td>是否线程安全。</td> 
   <td align="center">非线程安全</td> 
  </tr> 
 </tbody> 
</table>

## 5.关键函数的解析： ##

### 1. put(K key, V value)函数传入键值对到table ###

先来看源码：

public V put(K key, V value) {
        if (table == EMPTY_TABLE) {
            inflateTable(threshold);
        }
        if (key == null)
            return putForNullKey(value);
    
        //先通过key计算出hash值
        int hash = hash(key);
        //根据hash值计算出
        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;
    }

//扩容table
    private void inflateTable(int toSize) {
        // Find a power of 2 >= toSize
        int capacity = roundUpToPowerOf2(toSize);
    
        threshold = (int) Math.min(capacity * loadFactor, MAXIMUM_CAPACITY + 1);
        table = new Entry[capacity];
        initHashSeedAsNeeded(capacity);
    }

在put(K,V)函数中首先就是判断table是否为EMPTY\_TABLE，如果table是EMPTY\_TABLE，表示该HashMap还是空的HashMap,即第一次插入键值对，这个时候就调用  
`inflateTable(threshold);`  
来创建默认的table对象，该函数的源码在上面已经给出了。该函数传递一个参数，表示需要创建的table数组的大小。在函数体内部：首先调用`roundUpToPowerOf2(toSize);`函数，根据toSize获取大于等于toSize的最大的2的n次幂的数。(比如，如果toSize是13，就会返回16即2的4次幂)。**在这里顺便提出一点，table数组的容量必须是2的整数次幂的大小。后面会详细解释为什么**  
后面的就是调用`table = new Entry[capacity];` 来初始化capacity容量的数组了。

自此当table表为空时的代码分析完毕，回到put(K,V)函数，我们可知下面继续判断当Key为null时，会直接返回`putForNullKey(value);`函数的执行结果；这个函数的功能也就是当Key为null时候的操作：

private V putForNullKey(V value) {
        //遍历table[0]位置上的Entry单链表
        for (Entry<K,V> e = table[0]; e != null; e = e.next) {
            //将所有key为null的结点的value值更新
            if (e.key == null) {
                V oldValue = e.value;
                e.value = value;
                e.recordAccess(this);
                return oldValue;
            }
        }
        modCount++;
        //在table[0]位置创建了新的key为null的结点
        addEntry(0, null, value, 0);
        return null;
    }

从上面的源码注释我们可以发现一个question：就是HashMap中，key为null的键值对对象存放在table\[0\]这个位置的单链表上。  
在最后调用了`addEntry(0, null, value, 0);` 函数来创建新的结点。

/** *hash: hash码 *key： *value： *bucketIndex */
    void addEntry(int hash, K key, V value, int bucketIndex) {
        if ((size >= threshold) && (null != table[bucketIndex])) {
            resize(2 * table.length);
            hash = (null != key) ? hash(key) : 0;
            bucketIndex = indexFor(hash, table.length);
        }
        createEntry(hash, key, value, bucketIndex);
    }

里面实际上也是调用了`createEntry(hash, key, value, bucketIndex);` 该函数也就是在table\[bucketIndex\]位置的单链表的采用头插法插入新的元素。

void createEntry(int hash, K key, V value, int bucketIndex) {
        Entry<K,V> e = table[bucketIndex];
        table[bucketIndex] = new Entry<>(hash, key, value, e);
        size++;
    }

自此，当key为null时的代码也分析完毕了，即是在table\[0\]的位置保存key为null的Entry结点。

最后分析当table非空，key也非空的情况：  
首先调用hash(Object k)，针对key值重新计算hash()值。内部主要是通过k的hashCode()和其余的运算来计算出新的hash().

首先通过`hash(Object k)` 函数计算出当前key的值；  
再调用`int i = indexFor(hash, table.length);` 计算出当前key存储在table数组中的index值。在table\[i\]的位置遍历单链表，如果key已经存在过了，就直接更新value就行了，如果不存在就调用addEntry(hash, key, value, i);方法来添加键值对对象。

这里有个点要注意，在addEntry(hash, key, value, i)；时，如果table的capacity不够，会调用resize(2 \* table.length);方法来扩容table。

自此put()函数就分析完毕。

## 2. get(Object key)方法的解析 ##

源码如下

public V get(Object key) {
        //如果key为null就直接遍历table[0]处单链表获取key
        if (key == null)
            return getForNullKey();
        Entry<K,V> entry = getEntry(key);
    
        return null == entry ? null : entry.getValue();
    }

如果key为null就直接遍历table\[0\]处单链表获取key，否则就直接调用getEntry(key);根据key来回去value值。里面也是根据key计算出hashCode，再计算出table标的索引，然后在table\[i\]处遍历链表获取key对应的value返回。具体的实现其实就和put()方法完全相反。

## 3. 最后附上HashMap存储结构的原理的示意图： ##

![这里写图片描述][20131116091617994485.JPG]

[HashMap]: /images/20220713/b580090794e64c1f8d69b5452a009337.png
[801753-20151208204904136-1453407209.png]: /images/20220713/3d9858b4fc3a4c2fb2862417737acdec.png
[20131116091617994485.JPG]: http://www.admin10000.com/UploadFiles/Document/201311/16/20131116091617994485.JPG