java-通过 HashMap、HashSet 的源码分析其 Hash 存储机制

通过 HashMap、HashSet 的源码分析其 Hash 存储机制





集合和引用

就像引用类型的数组一样，当我们把 Java 对象放入数组之时，并非真正的把 Java 对象放入数组中。仅仅是把对象的引用放入数组中，每一个数组元素都是一个引用变量。

实际上，HashSet 和 HashMap 之间有非常多相似之处，对于 HashSet 而言。系统採用 Hash 算法决定集合元素的存储位置，这样能够保证能高速存、取集合元素；对于 HashMap 而言。系统 key-value 当成一个总体进行处理，系统总是依据 Hash 算法来计算 key-value 的存储位置。这样能够保证能高速存、取 Map 的 key-value 对。





在介绍集合存储之前须要指出一点：尽管集合号称存储的是 Java 对象，但实际上并不会真正将 Java 对象放入 Set 集合中，仅仅是在 Set 集合中保留这些对象的引用而言。也就是说：Java 集合实际上是多个引用变量所组成的集合。这些引用变量指向实际的 Java 对象。









--------------------------------------------------------------------------------





HashMap 的存储实现





当程序试图将多个 key-value 放入 HashMap 中时，以例如以下代码片段为例：





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

 map.put("语文" , 80.0); 

 map.put("数学" , 89.0); 

 map.put("英语" , 78.2); 

 





 





HashMap 採用一种所谓的“Hash 算法”来决定每一个元素的存储位置。

当程序运行 map.put("语文" , 80.0); 时。系统将调用"语文"的 hashCode() 方法得到其 hashCode 值——每一个 Java 对象都有 hashCode() 方法，都可通过该方法获得它的 hashCode 值。得到这个对象的 hashCode 值之后，系统会依据该 hashCode 值来决定该元素的存储位置。

我们能够看 HashMap 类的 put(K key , V value) 方法的源码：





 public V put(K key, V value) 

 { 

         // 假设 key 为 null，调用 putForNullKey 方法进行处理

         if (key == null) 

                return putForNullKey(value); 

         // 依据 key 的 keyCode 计算 Hash 值

         int hash = hash(key.hashCode()); 

         // 搜索指定 hash 值在相应 table 中的索引

        int i = indexFor(hash, table.length);

         // 假设 i 索引处的 Entry 不为 null，通过循环不断遍历 e 元素的下一个元素

         for (Entry<K,V> e = table[i]; e != null; e = e.next) 

         { 

                Object k; 

                // 找到指定 key 与须要放入的 key 相等（hash 值同样

                // 通过 equals 比較放回 true）

                if (e.hash == hash && ((k = e.key) == key 

                        || key.equals(k))) 

                { 

                        V oldValue = e.value; 

                        e.value = value; 

                        e.recordAccess(this); 

                        return oldValue; 

                } 

         } 

         // 假设 i 索引处的 Entry 为 null，表明此处还没有 Entry 

         modCount++; 

         // 将 key、value 加入到 i 索引处

         addEntry(hash, key, value, i); 

         return null; 

 } 

 





 





JDK 源代码

在 JDK 安装文件夹下能够找到一个 src.zip 压缩文件，该文件中包括了 Java 基础类库的全部源文件。仅仅要读者有学习兴趣，随时能够打开这份压缩文件来阅读 Java 类库的源码，这对提高读者的编程能力是很有帮助的。须要指出的是：src.zip 中包括的源码并没有包括像上文中的中文凝视。这些凝视是笔者自己加入进去的。

上面程序中用到了一个重要的内部接口：Map.Entry。每一个 Map.Entry 事实上就是一个 key-value 对。从上面程序中能够看出：当系统决定存储 HashMap 中的 key-value 对时。全然没有考虑 Entry 中的 value，只不过依据 key 来计算并决定每一个 Entry 的存储位置。这也说明了前面的结论：我们全然能够把 Map 集合中的 value 当成 key 的附属。当系统决定了 key 的存储位置之后，value 随之保存在那里就可以。

上面方法提供了一个依据 hashCode() 返回值来计算 Hash 码的方法：hash()。这种方法是一个纯粹的数学计算。其方法例如以下：





static int hash(int h) 

{ 

    h ^= (h >>> 20) ^ (h >>> 12); 

    return h ^ (h >>> 7) ^ (h >>> 4); 

} 

 





 





对于随意给定的对象，仅仅要它的 hashCode() 返回值同样，那么程序调用 hash(int h) 方法所计算得到的 Hash 码值总是同样的。接下来程序会调用 indexFor(int h, int length) 方法来计算该对象应该保存在 table 数组的哪个索引处。

indexFor(int h, int length) 方法的代码例如以下：





static int indexFor(int h, int length) 

{ 

    return h & (length-1); 

}

 





 





这种方法很巧妙。它总是通过 h &(table.length -1) 来得到该对象的保存位置——而 HashMap 底层数组的长度总是 2 的 n 次方。这一点可參看后面关于 HashMap 构造器的介绍。





当 length 总是 2 的倍数时，h & (length-1) 将是一个很巧妙的设计：假设 h=5,length=16, 那么 h & length - 1 将得到 5；假设 h=6,length=16, 那么 h & length - 1 将得到 6 ……假设 h=15,length=16, 那么 h & length - 1 将得到 15。可是当 h=16 时 , length=16 时，那么 h & length - 1 将得到 0 了。当 h=17 时 , length=16 时，那么 h &
length - 1 将得到 1 了……这样保证计算得到的索引值总是位于 table 数组的索引之内。 





依据上面 put 方法的源码能够看出。当程序试图将一个 key-value 对放入 HashMap 中时，程序首先依据该 key 的 hashCode() 返回值决定该 Entry 的存储位置：假设两个 Entry 的 key 的 hashCode() 返回值同样。那它们的存储位置同样。假设这两个 Entry 的 key 通过 equals 比較返回 true，新加入 Entry 的 value 将覆盖集合中原有 Entry 的 value，但 key 不会覆盖。假设这两个 Entry 的 key 通过 equals
比較返回 false。新加入的 Entry 将与集合中原有 Entry 形成 Entry 链，并且新加入的 Entry 位于 Entry 链的头部——详细说明继续看 addEntry() 方法的说明。

当向 HashMap 中加入 key-value 对。由其 key 的 hashCode() 返回值决定该 key-value 对（就是 Entry 对象）的存储位置。当两个 Entry 对象的 key 的 hashCode() 返回值同样时。将由 key 通过 eqauls() 比較值决定是採用覆盖行为（返回 true）。还是产生 Entry 链（返回 false）。





上面程序中还调用了 addEntry(hash, key, value, i); 代码，当中 addEntry 是 HashMap 提供的一个包訪问权限的方法，该方法仅用于加入一个 key-value 对。以下是该方法的代码：





void addEntry(int hash, K key, V value, int bucketIndex) 

{ 

    // 获取指定 bucketIndex 索引处的 Entry 

    Entry<K,V> e = table[bucketIndex];         // ①

    // 将新创建的 Entry 放入 bucketIndex 索引处，并让新的 Entry 指向原来的 Entry 

    table[bucketIndex] = new Entry<K,V>(hash, key, value, e); 

    // 假设 Map 中的 key-value 对的数量超过了极限

    if (size++ >= threshold) 

        // 把 table 对象的长度扩充到 2 倍。

resize(2 * table.length);      // ②

} 

 





 





上面方法的代码非常easy，但当中包括了一个非常优雅的设计：系统总是将新加入的 Entry 对象放入 table 数组的 bucketIndex 索引处——假设 bucketIndex 索引处已经有了一个 Entry 对象，那新加入的 Entry 对象指向原有的 Entry 对象（产生一个 Entry 链）。假设 bucketIndex 索引处没有 Entry 对象，也就是上面程序①号代码的 e 变量是 null，也就是新放入的 Entry 对象指向 null。也就是没有产生 Entry 链。









--------------------------------------------------------------------------------





Hash 算法的性能选项





依据上面代码能够看出，在同一个 bucket 存储 Entry 链的情况下。新放入的 Entry 总是位于 bucket 中。而最早放入该 bucket 中的 Entry 则位于这个 Entry 链的最末端。





上面程序中还有这样两个变量：





size：该变量保存了该 HashMap 中所包括的 key-value 对的数量。

threshold：该变量包括了 HashMap 能容纳的 key-value 对的极限。它的值等于 HashMap 的容量乘以负载因子（load factor）。 

从上面程序中②号代码能够看出，当 size++ >= threshold 时，HashMap 会自己主动调用 resize 方法扩充 HashMap 的容量。每扩充一次。HashMap 的容量就增大一倍。





上面程序中使用的 table 事实上就是一个普通数组。每一个数组都有一个固定的长度，这个数组的长度就是 HashMap 的容量。HashMap 包括例如以下几个构造器：





HashMap()：构建一个初始容量为 16。负载因子为 0.75 的 HashMap。 

HashMap(int initialCapacity)：构建一个初始容量为 initialCapacity，负载因子为 0.75 的 HashMap。 

HashMap(int initialCapacity, float loadFactor)：以指定初始容量、指定的负载因子创建一个 HashMap。

当创建一个 HashMap 时，系统会自己主动创建一个 table 数组来保存 HashMap 中的 Entry。以下是 HashMap 中一个构造器的代码：





 // 以指定初始化容量、负载因子创建 HashMap 

 public HashMap(int initialCapacity, float loadFactor) 

 { 

         // 初始容量不能为负数

         if (initialCapacity < 0) 

                throw new IllegalArgumentException( 

               "Illegal initial capacity: " + 

                        initialCapacity); 

         // 假设初始容量大于最大容量。让出示容量

         if (initialCapacity > MAXIMUM_CAPACITY) 

                initialCapacity = MAXIMUM_CAPACITY; 

         // 负载因子必须大于 0 的数值

         if (loadFactor <= 0 || Float.isNaN(loadFactor)) 

                throw new IllegalArgumentException( 

                loadFactor); 

         // 计算出大于 initialCapacity 的最小的 2 的 n 次方值。

         int capacity = 1; 

         while (capacity < initialCapacity) 

                capacity <<= 1; 

         this.loadFactor = loadFactor; 

         // 设置容量极限等于容量 * 负载因子

         threshold = (int)(capacity * loadFactor); 

         // 初始化 table 数组

         table = new Entry[capacity];                  // ①

         init(); 

 } 

 





 





上面代码中粗体字代码包括了一个简洁的代码实现：找出大于 initialCapacity 的、最小的 2 的 n 次方值，并将其作为 HashMap 的实际容量（由 capacity 变量保存）。比如给定 initialCapacity 为 10，那么该 HashMap 的实际容量就是 16。





initialCapacity 与 HashTable 的容量

创建 HashMap 时指定的 initialCapacity 并不等于 HashMap 的实际容量，通常来说。HashMap 的实际容量总比 initialCapacity 大一些，除非我们指定的 initialCapacity 參数值恰好是 2 的 n 次方。当然。掌握了 HashMap 容量分配的知识之后。应该在创建 HashMap 时将 initialCapacity 參数值指定为 2 的 n 次方，这样能够降低系统的计算开销。





程序①号代码处能够看到：table 的实质就是一个数组，一个长度为 capacity 的数组。





对于 HashMap 及其子类而言。它们採用 Hash 算法来决定集合中元素的存储位置。

当系统開始初始化 HashMap 时，系统会创建一个长度为 capacity 的 Entry 数组，这个数组里能够存储元素的位置被称为“桶（bucket）”，每一个 bucket 都有其指定索引，系统能够依据其索引高速訪问该 bucket 里存储的元素。





不管何时，HashMap 的每一个“桶”仅仅存储一个元素（也就是一个 Entry），因为 Entry 对象能够包括一个引用变量（就是 Entry 构造器的的最后一个參数）用于指向下一个 Entry。因此可能出现的情况是：HashMap 的 bucket 中仅仅有一个 Entry，但这个 Entry 指向还有一个 Entry ——这就形成了一个 Entry 链。如图 1 所看到的：









图 1. HashMap 的存储示意









--------------------------------------------------------------------------------





HashMap 的读取实现





当 HashMap 的每一个 bucket 里存储的 Entry 仅仅是单个 Entry ——也就是没有通过指针产生 Entry 链时，此时的 HashMap 具有最好的性能：当程序通过 key 取出相应 value 时，系统仅仅要先计算出该 key 的 hashCode() 返回值，在依据该 hashCode 返回值找出该 key 在 table 数组中的索引。然后取出该索引处的 Entry。最后返回该 key 相应的 value 就可以。看 HashMap 类的 get(K key) 方法代码：





 public V get(Object key) 

 { 

         // 假设 key 是 null。调用 getForNullKey 取出相应的 value 

         if (key == null) 

                return getForNullKey(); 

         // 依据该 key 的 hashCode 值计算它的 hash 码

         int hash = hash(key.hashCode()); 

         // 直接取出 table 数组中指定索引处的值，

         for (Entry<K,V> e = table[indexFor(hash, table.length)]; 

                e != null; 

                // 搜索该 Entry 链的下一个 Entr 

                e = e.next)            // ①

         { 

                Object k; 

                // 假设该 Entry 的 key 与被搜索 key 同样

                if (e.hash == hash && ((k = e.key) == key 

                        || key.equals(k))) 

                        return e.value; 

         } 

         return null; 

 } 

 





 





从上面代码中能够看出，假设 HashMap 的每一个 bucket 里仅仅有一个 Entry 时。HashMap 能够依据索引、高速地取出该 bucket 里的 Entry。在发生“Hash 冲突”的情况下。单个 bucket 里存储的不是一个 Entry，而是一个 Entry 链，系统仅仅能必须按顺序遍历每一个 Entry，直到找到想搜索的 Entry 为止——假设恰好要搜索的 Entry 位于该 Entry 链的最末端（该 Entry 是最早放入该 bucket 中），那系统必须循环到最后才干找到该元素。

归纳起来简单地说。HashMap 在底层将 key-value 当成一个总体进行处理，这个总体就是一个 Entry 对象。HashMap 底层採用一个 Entry[] 数组来保存全部的 key-value 对。当须要存储一个 Entry 对象时。会依据 Hash 算法来决定其存储位置；当须要取出一个 Entry 时，也会依据 Hash 算法找到其存储位置。直接取出该 Entry。

由此可见：HashMap 之所以能高速存、取它所包括的 Entry。全然类似于现实生活中母亲从小教我们的：不同的东西要放在不同的位置，须要时才干高速找到它。

当创建 HashMap 时，有一个默认的负载因子（load factor），其默认值为 0.75，这是时间和空间成本上一种折衷：增大负载因子能够降低 Hash 表（就是那个 Entry 数组）所占用的内存空间，但会添加查询数据的时间开销。而查询是最频繁的的操作（HashMap 的 get() 与 put() 方法都要用到查询）；减小负载因子会提高数据查询的性能。但会添加 Hash 表所占用的内存空间。





掌握了上面知识之后，我们能够在创建 HashMap 时依据实际须要适当地调整 load factor 的值；假设程序比較关心空间开销、内存比較紧张，能够适当地添加负载因子；假设程序比較关心时间开销。内存比較宽裕则能够适当的降低负载因子。

通常情况下，程序猿无需改变负载因子的值。

假设開始就知道 HashMap 会保存多个 key-value 对，能够在创建时就使用较大的初始化容量。假设 HashMap 中 Entry 的数量一直不会超过极限容量（capacity * load factor），HashMap 就无需调用 resize() 方法又一次分配 table 数组。从而保证较好的性能。

当然。開始就将初始容量设置太高可能会浪费空间（系统须要创建一个长度为 capacity 的 Entry 数组），因此创建 HashMap 时初始化容量设置也须要小心对待。









--------------------------------------------------------------------------------





HashSet 的实现





对于 HashSet 而言，它是基于 HashMap 实现的，HashSet 底层採用 HashMap 来保存全部元素，因此 HashSet 的实现比較简单，查看 HashSet 的源码，能够看到例如以下代码：





 public class HashSet<E> 

         extends AbstractSet<E> 

         implements Set<E>, Cloneable, java.io.Serializable 

 { 

         // 使用 HashMap 的 key 保存 HashSet 中全部元素

         private transient HashMap<E,Object> map; 

         // 定义一个虚拟的 Object 对象作为 HashMap 的 value 

         private static final Object PRESENT = new Object(); 

         ... 

         // 初始化 HashSet，底层会初始化一个 HashMap 

         public HashSet() 

         { 

                map = new HashMap<E,Object>(); 

         } 

         // 以指定的 initialCapacity、loadFactor 创建 HashSet 

         // 事实上就是以对应的參数创建 HashMap 

         public HashSet(int initialCapacity, float loadFactor) 

         { 

                map = new HashMap<E,Object>(initialCapacity, loadFactor); 

         } 

         public HashSet(int initialCapacity) 

         { 

                map = new HashMap<E,Object>(initialCapacity); 

         } 

         HashSet(int initialCapacity, float loadFactor, boolean dummy) 

         { 

                map = new LinkedHashMap<E,Object>(initialCapacity 

                        , loadFactor); 

         } 

         // 调用 map 的 keySet 来返回全部的 key 

         public Iterator<E> iterator() 

         { 

                return map.keySet().iterator(); 

         } 

         // 调用 HashMap 的 size() 方法返回 Entry 的数量。就得到该 Set 里元素的个数

         public int size() 

         { 

                return map.size(); 

         } 

         // 调用 HashMap 的 isEmpty() 推断该 HashSet 是否为空，

         // 当 HashMap 为空时。相应的 HashSet 也为空

         public boolean isEmpty() 

         { 

                return map.isEmpty(); 

         } 

         // 调用 HashMap 的 containsKey 推断是否包括指定 key 

         //HashSet 的全部元素就是通过 HashMap 的 key 来保存的

         public boolean contains(Object o) 

         { 

                return map.containsKey(o); 

         } 

         // 将指定元素放入 HashSet 中，也就是将该元素作为 key 放入 HashMap 

         public boolean add(E e) 

         { 

                return map.put(e, PRESENT) == null; 

         } 

         // 调用 HashMap 的 remove 方法删除指定 Entry。也就删除了 HashSet 中相应的元素

         public boolean remove(Object o) 

         { 

                return map.remove(o)==PRESENT; 

         } 

         // 调用 Map 的 clear 方法清空全部 Entry。也就清空了 HashSet 中全部元素

         public void clear() 

         { 

                map.clear(); 

         } 

         ... 

 } 

 





 





由上面源程序能够看出，HashSet 的实现事实上很easy，它仅仅是封装了一个 HashMap 对象来存储全部的集合元素，全部放入 HashSet 中的集合元素实际上由 HashMap 的 key 来保存，而 HashMap 的 value 则存储了一个 PRESENT。它是一个静态的 Object 对象。

HashSet 的绝大部分方法都是通过调用 HashMap 的方法来实现的。因此 HashSet 和 HashMap 两个集合在实现本质上是同样的。

HashMap 的 put 与 HashSet 的 add

因为 HashSet 的 add() 方法加入集合元素时实际上转变为调用 HashMap 的 put() 方法来加入 key-value 对，当新放入 HashMap 的 Entry 中 key 与集合中原有 Entry 的 key 同样（hashCode() 返回值相等。通过 equals 比較也返回 true），新加入的 Entry 的 value 将覆盖原来 Entry 的 value，但 key 不会有不论什么改变。因此假设向 HashSet 中加入一个已经存在的元素，新加入的集合元素（底层由 HashMap
的 key 保存）不会覆盖已有的集合元素。





掌握上面理论知识之后，接下来看一个演示样例程序，測试一下自己是否真正掌握了 HashMap 和 HashSet 集合的功能。





 class Name

{

    private String first; 

    private String last; 

    

    public Name(String first, String last) 

    { 

        this.first = first; 

        this.last = last; 

    } 

 

    public boolean equals(Object o) 

    { 

        if (this == o) 

        { 

            return true; 

        } 

        

        if (o.getClass() == Name.class) 

        { 

            Name n = (Name)o; 

            return n.first.equals(first) 

                && n.last.equals(last); 

        } 

        return false; 

    } 

}

 

public class HashSetTest

{

    public static void main(String[] args)

    { 

        Set<Name> s = new HashSet<Name>();

        s.add(new Name("abc", "123"));

        System.out.println(

            s.contains(new Name("abc", "123")));

    }

} 

 





 





上面程序中向 HashSet 里加入了一个 new Name("abc", "123") 对象之后，马上通过程序推断该 HashSet 是否包括一个 new Name("abc", "123") 对象。

粗看上去，非常easy以为该程序会输出 true。





实际执行上面程序将看到程序输出 false，这是由于 HashSet 推断两个对象相等的标准除了要求通过 equals() 方法比較返回 true 之外。还要求两个对象的 hashCode() 返回值相等。而上面程序没有重写 Name 类的 hashCode() 方法。两个 Name 对象的 hashCode() 返回值并不同样，因此 HashSet 会把它们当成 2 个对象处理。因此程序返回 false。





由此可见，当我们试图把某个类的对象当成 HashMap 的 key，或试图将这个类的对象放入 HashSet 中保存时。重写该类的 equals(Object obj) 方法和 hashCode() 方法非常重要。并且这两个方法的返回值必须保持一致：当该类的两个的 hashCode() 返回值同样时，它们通过 equals() 方法比較也应该返回 true。

通常来说，全部參与计算 hashCode() 返回值的关键属性，都应该用于作为 equals() 比較的标准。





hashCode() 和 equals()

关于怎样正确地重写某个类的 hashCode() 方法和 equals() 方法。请參考疯狂 Java 体系的《疯狂 Java 讲义》一书中相关内容。





例如以下程序就正确重写了 Name 类的 hashCode() 和 equals() 方法，程序例如以下：





class Name 

{ 

    private String first;

    private String last;

    public Name(String first, String last)

    { 

        this.first = first; 

        this.last = last; 

    } 

    // 依据 first 推断两个 Name 是否相等

    public boolean equals(Object o) 

    { 

        if (this == o) 

        { 

            return true; 

        } 

        if (o.getClass() == Name.class) 

        { 

            Name n = (Name)o; 

            return n.first.equals(first); 

        } 

        return false; 

    } 

         

    // 依据 first 计算 Name 对象的 hashCode() 返回值

    public int hashCode() 

    { 

        return first.hashCode(); 

    }

 

    public String toString() 

    { 

        return "Name[first=" + first + ", last=" + last + "]"; 

    } 

 } 

 

 public class HashSetTest2 

 { 

    public static void main(String[] args) 

    { 

        HashSet<Name> set = new HashSet<Name>(); 

        set.add(new Name("abc" , "123")); 

        set.add(new Name("abc" , "456")); 

        System.out.println(set); 

    } 

}

 





 





上面程序中提供了一个 Name 类。该 Name 类重写了 equals() 和 toString() 两个方法，这两个方法都是依据 Name 类的 first 实例变量来推断的，当两个 Name 对象的 first 实例变量相等时，这两个 Name 对象的 hashCode() 返回值也同样，通过 equals() 比較也会返回 true。





程序主方法先将第一个 Name 对象加入到 HashSet 中，该 Name 对象的 first 实例变量值为"abc"。接着程序再次试图将一个 first 为"abc"的 Name 对象加入到 HashSet 中，非常明显，此时没法将新的 Name 对象加入到该 HashSet 中。由于此处试图加入的 Name 对象的 first 也是" abc"。HashSet 会推断此处新增的 Name 对象与原有的 Name 对象同样，因此无法加入进入，程序在①号代码处输出 set 集合时将看到该集合里仅仅包括一个 Name
对象。就是第一个、last 为"123"的 Name 对象。