HashMap源码分析(基于JDK1.6)

Posted 煮海焚天

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了HashMap源码分析(基于JDK1.6)相关的知识,希望对你有一定的参考价值。

 

    在Java集合类中最常用的除了ArrayList外,就是HashMap了。本文尽自己所能,尽量详细的解释HashMap的源码。一山还有一山高,有不足之处请之处,定感谢指定并及时修正。

    在看HashMap源码之前先复习一下数据结构。

    Java最基本的数据结构有数组和链表。数组的特点是空间连续(大小固定)、寻址迅速,但是插入和删除时需要移动元素,所以查询快,增加删除慢。链表恰好相反,可动态增加或减少空间以适应新增和删除元素,但查找时只能顺着一个个节点查找,所以增加删除快,查找慢。有没有一种结构综合了数组和链表的优点呢?当然有,那就是哈希表(虽说是综合优点,但实际上查找肯定没有数组快,插入删除没有链表快,一种折中的方式吧)。一般采用拉链法实现哈希表。哈希表?拉链法?可能一下想不起来,不过放张图就了然了。

    (图片google来的,好多都用了文章用了这张图了,不知道出处了就没申明作者了)

    学计算机的肯定学过这玩意儿,也不需要解释,都懂的。

    铺垫了这么多,又是数组又是链表,还有哈希表,拉链法,该入正题了,我们什么时候用到了这些内容,具体它是怎么实现的?

    其实我们一直在用(别告诉我你没用过HashMap什么的),可能你一直没去深究,没看到它如何实现的,所以一直没感受到。这里主要分析HashMap的源码,就不再多扯其他的了。

    HashMap继承自AbstractMap,实现了Map接口(这些内容可以参考《Java集合类》)。来看类的定义。

1 public class HashMap<K,V> extends AbstractMap<K,V> implements Map<K,V>, Cloneable, Serializable

    Map接口定义了所有Map子类必须实现的方法。Map接口中还定义了一个内部接口Entry(为什么要弄成内部接口?改天还要学习学习)。Entry将在后面有详细的介绍。

    AbstractMap也实现了Map接口,并且提供了两个实现Entry的内部类:SimpleEntry和SimpleImmutableEntry。

    定义了接口,接口中又有内部接口,然后有搞了个抽象类实现接口,抽象类里面又搞了两个内部类实现接口的内部接口,有没有点绕,为什么搞成这样呢?先不管了,先看HashMap吧。

    HashMap中定义的属性(应该都能看明白,不过还是解释一下):

 1 /**
 2      * 默认的初始容量,必须是2的幂。
 3      */
 4     static final int DEFAULT_INITIAL_CAPACITY = 16;
 5     /**
 6      * 最大容量(必须是2的幂且小于2的30次方,传入容量过大将被这个值替换)
 7      */
 8     static final int MAXIMUM_CAPACITY = 1 << 30;
 9     /**
10      * 默认装载因子,这个后面会做解释
11      */
12     static final float DEFAULT_LOAD_FACTOR = 0.75f;
13     /**
14      * 存储数据的Entry数组,长度是2的幂。看到数组的内容了,接着看数组中存的内容就明白为什么博文开头先复习数据结构了
15      */
16     transient Entry[] table;
17     /**
18      * map中保存的键值对的数量
19      */
20     transient int size;
21     /**
22      * 需要调整大小的极限值(容量*装载因子)
23      */
24     int threshold;
25     /**
26      *装载因子
27      */
28     final float loadFactor;
29     /**
30      * map结构被改变的次数
31      */
32     transient volatile int modCount;

    接着是HashMap的构造方法。

/**
     *使用默认的容量及装载因子构造一个空的HashMap
     */
    public HashMap() {
        this.loadFactor = DEFAULT_LOAD_FACTOR;
        threshold = (int)(DEFAULT_INITIAL_CAPACITY * DEFAULT_LOAD_FACTOR);//计算下次需要调整大小的极限值
        table = new Entry[DEFAULT_INITIAL_CAPACITY];//根据默认容量(16)初始化table
        init();
    }
/**
     * 根据给定的初始容量的装载因子创建一个空的HashMap
     * 初始容量小于0或装载因子小于等于0将报异常 
     */
    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);
        int capacity = 1;
        //设置capacity为大于initialCapacity且是2的幂的最小值
        while (capacity < initialCapacity)
            capacity <<= 1;
        this.loadFactor = loadFactor;
        threshold = (int)(capacity * loadFactor);
        table = new Entry[capacity];
        init();
    }
/**
     *根据指定容量创建一个空的HashMap
     */
    public HashMap(int initialCapacity) {
        this(initialCapacity, DEFAULT_LOAD_FACTOR);//调用上面的构造方法,容量为指定的容量,装载因子是默认值
    }
/**
     *通过传入的map创建一个HashMap,容量为默认容量(16)和(map.zise()/DEFAULT_LOAD_FACTORY)+1的较大者,装载因子为默认值
     */
    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);
    }

    上面的构造方法中调用到了init()方法,最后一个方法还调用了putAllForCreate(Map<? extends K, ? extends V> m)。init方法是一个空方法,里面没有任何内容。putAllForCreate看方法名就是创建的时候将传入的map全部放入新创建的对象中。该方法中还涉及到其他方法,将在后面介绍。

    先看初始化table时均使用了Entry,这是HashMap的一个内部类,实现了Map接口的内部接口Entry。

    下面给出Map.Entry接口及HashMap.Entry类的内容。

    Map.Entry接口定义的方法

1 K getKey();//获取Key
2 V getValue();//获取Value
3 V setValue();//设置Value,至于具体返回什么要看具体实现
4 boolean equals(Object o);//定义equals方法用于判断两个Entry是否相同
5 int hashCode();//定义获取hashCode的方法

    HashMap.Entry类的具体实现

 1 static class Entry<K,V> implements Map.Entry<K,V> {
 2         final K key;
 3         V value;
 4         Entry<K,V> next;//对下一个节点的引用(看到链表的内容,结合定义的Entry数组,是不是想到了哈希表的拉链法实现?!)
 5         final int hash;//哈希值
 6 
 7         Entry(int h, K k, V v, Entry<K,V> n) {
 8             value = v;
 9             next = n;
10             key = k;
11             hash = h;
12         }
13 
14         public final K getKey() {
15             return key;
16         }
17 
18         public final V getValue() {
19             return value;
20         }
21 
22         public final V setValue(V newValue) {
23         V oldValue = value;
24             value = newValue;
25             return oldValue;//返回的是之前的Value
26         }
27 
28         public final boolean equals(Object o) {
29             if (!(o instanceof Map.Entry))//先判断类型是否一致
30                 return false;
31             Map.Entry e = (Map.Entry)o;
32             Object k1 = getKey();
33             Object k2 = e.getKey();
34 // Key相等且Value相等则两个Entry相等
35             if (k1 == k2 || (k1 != null && k1.equals(k2))) {
36                 Object v1 = getValue();
37                 Object v2 = e.getValue();
38                 if (v1 == v2 || (v1 != null && v1.equals(v2)))
39                     return true;
40             }
41             return false;
42         }
43         // hashCode是Key的hashCode和Value的hashCode的异或的结果
44         public final int hashCode() {
45             return (key==null   ? 0 : key.hashCode()) ^
46                    (value==null ? 0 : value.hashCode());
47         }
48         // 重写toString方法,是输出更清晰
49         public final String toString() {
50             return getKey() + "=" + getValue();
51         }
52 
53         /**
54          *当调用put(k,v)方法存入键值对时,如果k已经存在,则该方法被调用(为什么没有内容?)
55          */
56         void recordAccess(HashMap<K,V> m) {
57         }
58 
59         /**
60          * 当Entry被从HashMap中移除时被调用(为什么没有内容?)
61          */
62         void recordRemoval(HashMap<K,V> m) {
63         }
64     }

    看完属性和构造方法,接着看HashMap中的其他方法,一个个分析,从最常用的put和get说起吧。

    put()

 1 public V put(K key, V value) {
 2         if (key == null)
 3             return putForNullKey(value);
 4         int hash = hash(key.hashCode());
 5         int i = indexFor(hash, table.length);
 6         for (Entry<K,V> e = table[i]; e != null; e = e.next) {
 7             Object k;
 8             if (e.hash == hash && ((k = e.key) == key || key.equals(k))) {
 9                 V oldValue = e.value;
10                 e.value = value;
11                 e.recordAccess(this);
12                 return oldValue;
13             }
14         }
15 
16         modCount++;
17         addEntry(hash, key, value, i);
18         return null;
19     }

    当存入的key是null的时候将调用putForNUllKey方法,暂时将这段逻辑放一边,看key不为null的情况。先调用了hash(int h)方法获取了一个hash值。

1 static int hash(int h) {
2         // This function ensures that hashCodes that differ only by
3         // constant multiples at each bit position have a bounded
4         // number of collisions (approximately 8 at default load factor).
5         h ^= (h >>> 20) ^ (h >>> 12);
6         return h ^ (h >>> 7) ^ (h >>> 4);
7     }

    这个方法的主要作用是防止质量较差的哈希函数带来过多的冲突(碰撞)问题。Java中int值占4个字节,即32位。根据这32位值进行移位、异或运算得到一个值。

1 static int indexFor(int h, int length) {
2         return h & (length-1);
3     }

    indexFor返回hash值和table数组长度减1的与运算结果。为什么使用的是length-1?应为这样可以保证结果的最大值是length-1,不会产生数组越界问题。

    获取索引位置之后做了什么?探测table[i]所在的链表,所发现key值与传入的key值相同的对象,则替换并返回oldValue。若找不到,则通过addEntry(hash,key,value,i)添加新的对象。来看addEntry(hash,key,value,i)方法。

1 void addEntry(int hash, K key, V value, int bucketIndex) {
2     Entry<K,V> e = table[bucketIndex];
3         table[bucketIndex] = new Entry<K,V>(hash, key, value, e);
4         if (size++ >= threshold)
5             resize(2 * table.length);
6     }

    这就是在一个链表头部插入一个节点的过程。获取table[i]的对象e,将table[i]的对象修改为新增对象,让新增对象的next指向e。之后判断size是否到达了需要扩充table数组容量的界限并让size自增1,如果达到了则调用resize(int capacity)方法将数组容量拓展为原来的两倍。

 1 void resize(int newCapacity) {
 2         Entry[] oldTable = table;
 3         int oldCapacity = oldTable.length;
 4         // 这个if块表明,如果容量已经到达允许的最大值,即MAXIMUN_CAPACITY,则不再拓展容量,而将装载拓展的界限值设为计算机允许的最大值。
 5         // 不会再触发resize方法,而是不断的向map中添加内容,即table数组中的链表可以不断变长,但数组长度不再改变
 6         if (oldCapacity == MAXIMUM_CAPACITY) {
 7             threshold = Integer.MAX_VALUE;
 8             return;
 9         }
10         // 创建新数组,容量为指定的容量
11         Entry[] newTable = new Entry[newCapacity];
12         transfer(newTable);
13         table = newTable;
14         // 设置下一次需要调整数组大小的界限
15         threshold = (int)(newCapacity * loadFactor);
16     }

    结合上面给出的注释,调整数组容量的内容仅剩下将原table中的内容复制到newTable中并将newTable返回给原table。即上面代码中的“transfer(newTable);table = newTable;”。来看transfer(Entry[] newTable)方法。

 1 void transfer(Entry[] newTable) {
 2         // 保留原数组的引用到src中,
 3         Entry[] src = table;
 4         // 新容量使新数组的长度
 5         int newCapacity = newTable.length;
 6 // 遍历原数组
 7         for (int j = 0; j < src.length; j++) {
 8             // 获取元素e
 9             Entry<K,V> e = src[j];
10             if (e != null) {
11                 // 将原数组中的元素置为null
12                 src[j] = null;
13                 // 遍历原数组中j位置指向的链表
14                 do {
15                     Entry<K,V> next = e.next;
16                     // 根据新的容量计算e在新数组中的位置
17                     int i = indexFor(e.hash, newCapacity);
18                     // 将e插入到newTable[i]指向的链表的头部
19                     e.next = newTable[i];
20                     newTable[i] = e;
21                     e = next;
22                 } while (e != null);
23             }
24         }
25     }

    从上面的代码可以看出,HashMap之所以不能保持元素的顺序有以下几点原因:第一,插入元素的时候对元素进行哈希处理,不同元素分配到table的不同位置;第二,容量拓展的时候又进行了hash处理;第三,复制原表内容的时候链表被倒置。

    一个put方法带出了这么多内容,接着看看putAll吧。

 1 public void putAll(Map<? extends K, ? extends V> m) {
 2         int numKeysToBeAdded = m.size();
 3         if (numKeysToBeAdded == 0)
 4             return;
 5         // 为什么判断条件是numKeysToBeAdded,不是(numKeysToBeAdded+table.length)>threshold???
 6         if (numKeysToBeAdded > threshold) {
 7             int targetCapacity = (int)(numKeysToBeAdded / loadFactor + 1);
 8             if (targetCapacity > MAXIMUM_CAPACITY)
 9                 targetCapacity = MAXIMUM_CAPACITY;
10             int newCapacity = table.length;
11             while (newCapacity < targetCapacity)
12                 newCapacity <<= 1;
13             if (newCapacity > table.length)
14                 resize(newCapacity);
15         }
16 
17         for (Iterator<? extends Map.Entry<? extends K, ? extends V>> i = m.entrySet().iterator(); i.hasNext(); ) {
18             Map.Entry<? extends K, ? extends V> e = i.next();
19             put(e.getKey(), e.getValue());
20         }
21     }

    先回答上面的问题:为什么判断条件是numKeysToBeAdded,不是(numKeysToBeAdded+table.length)>threshold???

    这是一种保守的做法,明显地,我们应该在(numKeysToBeAdded+table.length)>threshold的时候去拓展容量,但是考虑到将被添加的元素可能会有Key与原本存在的Key相同的情况,所以采用保守的做法,避免拓展到过大的容量。

    接着是遍历m中的内容,然后调用put方法将元素添加到table数组中。

    遍历的时候涉及到了entrySet方法,这个方法定义在Map接口中,HashMap中也有实现,后面会解释HashMap的这个方法,其它Map的实现暂不解释。

    下面介绍在put方法中被调用到的putForNullKey方法。

 1 private V putForNullKey(V value) {
 2         for (Entry<K,V> e = table[0]; e != null; e = e.next) {
 3             if (e.key == null) {
 4                 V oldValue = e.value;
 5                 e.value = value;
 6                 e.recordAccess(this);
 7                 return oldValue;
 8             }
 9         }
10         modCount++;
11         addEntry(0, null, value, 0);
12         return null;
13     }

    这是一个私有方法,在put方法中被调用。它首先遍历table数组,如果找到key为null的元素,则替换元素值并返回oldValue;否则通过addEntry方法添加元素,之后返回null。

    还记得上面构造方法中调用到的putAllForCreate吗?一口气将put操作的方法看完吧。

1 private void putAllForCreate(Map<? extends K, ? extends V> m) {
2         for (Iterator<? extends Map.Entry<? extends K, ? extends V>> i = m.entrySet().iterator(); i.hasNext(); ) {
3             Map.Entry<? extends K, ? extends V> e = i.next();
4             putForCreate(e.getKey(), e.getValue());
5         }
6     }

    先将遍历的过程放在一边,因为它同样涉及到了entrySet()方法。剩下的代码很简单,只是调用putForCreate方法逐个元素加入。

 1 private void putForCreate(K key, V value) {
 2         int hash = (key == null) ? 0 : hash(key.hashCode());
 3         int i = indexFor(hash, table.length);
 4         for (Entry<K,V> e = table[i]; e != null; e = e.next) {
 5             Object k;
 6             if (e.hash == hash &&
 7                 ((k = e.key) == key || (key != null && key.equals(k)))) {
 8                 e.value = value;
 9                 return;
10             }
11         }
12         createEntry(hash, key, value, i);
13     }

    该方法先计算需要添加的元素的hash值和在table数组中的索引i。接着遍历table[i]的链表,若有元素的key值与传入key值相等,则替换value,结束方法。若不存在key值相同的元素,则调用createEntry创建并添加元素。

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

    这个方法的内容就不解释了,上面都解释过。

    至此所有put相关操作都解释完毕了。put之外,另一个常用的操作就是get,下面就来看get方法。

 1 public V get(Object key) {
 2         if (key == null)
 3             return getForNullKey();
 4         int hash = hash(key.hashCode());
 5         for (Entry<K,V> e = table[indexFor(hash, table.length)];
 6              e != null;
 7              e = e.next) {
 8             Object k;
 9             if (e.hash == hash && ((k = e.key) == key || key.equals(k)))
10                 return e.value;
11         }
12         return null;
13     }

    该方法分为key为null和不为null两块。先看不为null的情况。先获取key的hash值,之后通过hash值及table.length获取key对应的table数组的索引,遍历索引的链表,所找到key相同的元素,则返回元素的value,否者返回null。不为null的情况调用了getForNullKey()方法。

1 private V getForNullKey() {
2         for (Entry<K,V> e = table[0]; e != null; e = e.next) {
3             if (e.key == null)
4                 return e.value;
5         }
6         return null;
7     }

    这是一个私有方法,只在get中被调用。该方法判断table[0]中的链表是否包含key为null的元素,包含则返回value,不包含则返回null。为什么是遍历table[0]的链表?因为key为null的时候获得的hash值都是0。

    添加(put)和获取(get)都结束了,接着看如何判断一个元素是否存在。

    HashMap没有提供判断元素是否存在的方法,只提供了判断Key是否存在及Value是否存在的方法,分别是containsKey(Object key)、containsValue(Object value)。

    containsKey(Object key)方法很简单,只是判断getEntry(key)的结果是否为null,是则返回false,否返回true。

 1 public boolean containsKey(Object key) {
 2         return getEntry(key) != null;
 3     }
 4 final Entry<K,V> getEntry(Object key) {
 5         int hash = (key == null) ? 0 : hash(key.hashCode());
 6         for (Entry<K,V> e = table[indexFor(hash, table.length)];
 7              e != null;
 8              e = e.next) {
 9             Object k;
10             if (e.hash == hash &&
11                 ((k = e.key) == key || (key != null && key.equals(k))))
12                 return e;
13         }
14         return null;
15     }

    getEntry(Object key)也没什么内容,只是根据key对应的hash值计算在table数组中的索引位置,然后遍历该链表判断是否存在相同的key值。

 1 public boolean containsValue(Object value) {
 2     if (value == null)
 3             return containsNullValue();
 4 
 5     Entry[] tab = table;
 6         for (int i = 0; i < tab.length ; i++)
 7             for (Entry e = tab[i] ; e != null ; e = e.next)
 8                 if (value.equals(e.value))
 9                     return true;
10     return false;
11     }
12 private boolean containsNullValue() {
13     Entry[] tab = table;
14         for (int i = 0; i < tab.length ; i++)
15             for (Entry e = tab[i] ; e != null ; e = e.next)
16                 if (e.value == null)
17                     return true;
18     return false;
19     }

    判断一个value是否存在比判断key是否存在还要简单,就是遍历所有元素判断是否有相等的值。这里分为两种情况处理,value为null何不为null的情况,但内容差不多,只是判断相等的方式不同。

    这个判断是否存在必须遍历所有元素,是一个双重循环的过程,因此是比较耗时的操作。

    接着看HashMap中“删除”相关的操作,有remove(Object key)和clear()两个方法。

    remove(Object key)