Java的Map集合

1.* Map

Map用于保存具有映射关系的数据，因此Map集合里保存着两组值，一组值用于保存Map里的key，另外一组值用于保存Map里的value，key和value都可以是任何引用类型的数据。Map的key不允许重复，即同一个Map对象的任何两个key通过equals方法比较总是返回false。

key和value之间存在单向一对一关系，即通过指定的key，总能找到唯一的、确定的value。从Map中取出数据时，只要给出指定的key，就可以取出对应的value。

如果把Map的两组值拆开来看，Map里的数据如图：

从图中可以看出，如果把Map里的所有key放在一起来看，它们就组成了一个Set集合（所有的key没有顺序，key与key之间不能重复），实际上Map确实包含了一个keySet()方法，用于返回Map里所有key组成的Set集合。

不仅如此，Map里key集和Set集合里元素的存储形式也很像，Map子类和Set子类在名字上也惊人地相似，比如Set接口下有HashSet、LinkedHashSet、SortedSet（接口）、TreeSet、EnumSet等子接口和实现类，而Map接口下则有HashMap、LinkedHashMap、SortedMap（接口）、TreeMap、EnumMap等子接口和实现类。正如它们的名字所暗示的，Map的这些实现类和子接口中key集的存储形式和对应Set集合中元素的存储形式完全相同。

提示：Set与Map之间的关系非常密切。虽然Map中放的元素是key-value对，Set集合中放的元素是单个对象，但如果我们把key-value对中的value当成key的附庸：key在哪里，value就跟在哪里。这样就可以像对待Set一样来对待Map了。事实上，Map提供了一个Entry内部类来封装key-value对，而计算Entry存储时则只考虑Entry封装的key。从Java源码来看，Java是先实现了Map，然后通过包装一个所有value都为null的Map就实现了Set集合。

如果把Map里的所有value放在一起来看，它们又非常类似于一个List：元素与元素之间可以重复，每个元素可以根据索引来查找，只是Map中的索引不再使用整数值，而是以另一个对象作为索引。如果需要从List集合中取出元素，则需要提供该元素的数字索引；如果需要从Map中取出元素，则需要提供该元素的key索引。因此，Map有时也被称为字典，或关联数组。Map接口中定义了如下常用的方法：

• void clear()：删除该Map对象中的所有key-value对。
• boolean containsKey(Object key)：查询Map中是否包含指定的key，如果包含则返回true。
• boolean containsValue(Object value)：查询Map中是否包含一个或多个value，如果包含则返回true。
• Set entrySet()：返回Map中包含的key-value对所组成的Set集合，每个集合元素都是Map.Entry（Entry是Map的内部类）对象。
• Object get(Object key)：返回指定key所对应的value；如果此Map中不包含该key，则返回null。
• boolean isEmpty()：查询该Map是否为空（即不包含任何key-value对），如果为空则返回true。
• Set keySet()：返回该Map中所有key组成的Set集合。
• Object put(Object key, Object value)：添加一个key-value对，如果当前Map中已有一个与该key相等的key-value对，则新的key-value对会覆盖原来的key-value对。
• void putAll(Map m)：将指定Map中的key-value对复制到本Map中。
• Object remove(Object key)：删除指定key所对应的key-value对，返回被删除key所关联的value，如果该key不存在，则返回null。
• int size()：返回该Map里的key-value对的个数。
• Collection values()：返回该Map里所有value组成的Collection。

Map接口提供了大量的实现类，典型实现如HashMap和Hashtable等、HashMap的子类LinkedHashMap，还有SortedMap子接口及该接口的实现类TreeMap，以及WeakHashMap、IdentityHashMap等。

下面将详细介绍Map接口实现类。

Map中包括一个内部类Entry，该类封装了一个key-value对。Entry包含如下三个方法：

• Object getKey()：返回该Entry里包含的key值。
• Object getValue()：返回该Entry里包含的value值。
• Object setValue(V value)：设置该Entry里包含的value值，并返回新设置的value值。

1.*.& HashMap和Hashtable实现类

HashMap和Hashtable都是Map接口的典型实现类，它们之间的关系完全类似于ArrayList和Vector的关系：Hashtable是一个古老的Map实现类，它从JDK 1.0起就已经出现了，当它出现时，Java还没有提供Map接口，所以它包含了两个烦琐的方法，即elements()（类似于Map接口定义的values()方法）和keys()（类似于Map接口定义的keySet()方法），现在很少使用这两个方法。

除此之外，Hashtable和HashMap存在两点典型区别：

• Hashtable是一个线程安全的Map实现，但HashMap是线程不安全的实现，所以HashMap比Hashtable的性能高一点；但如果有多个线程访问同一个Map对象时，使用Hashtable实现类会更好。
• Hashtable不允许使用null作为key和value，如果试图把null值放进Hashtable中，将会引发NullPointerException异常；但HashMap可以使用null作为key或value。

由于HashMap里的key不能重复，所以HashMap里最多只有一个key-value对的key为null，但可以有无数多个key-value对的value为null。下面程序示范了用null值作为HashMap的key和value的情形：

查看代码

上面程序试图向HashMap中放入三个key-value对，其中1代码处无法将key-value对放入，因为Map中已经有一个key-value对的key为null值，所以无法再放入key为null值的key-value对。[2]代码处可以放入该key-value对，因为一个HashMap中可以有多个value为null值。编译、运行上面程序，看到如下输出结果：

根据上面输出结果可以看出，HashMap重写了toString()方法，实际上所有的Map实现类都重写了toString()方法，调用Map对象的toString()方法总是返回如下格式的字符串：{key1 = value1, key2 = value2...}。

注意：从Hashtable的类名上就可以看出它是一个古老的类，它的命名甚至没有遵守Java的命名规范：每个单词的首字母都应该大写。也许当初开发Hashtable的工程师也没有注意到这一点，后来大量Java程序中使用了Hashtable类，所以这个类名也就不能改为HashTable了，否则将导致大量程序需要改写。与Vector类似的是，尽量少用Hashtable实现类，即使需要创建线程安全的Map实现类，也无须使用Hashtable实现类，可以通过后面介绍的Collections工具类把HashMap变成线程安全的。

为了成功地在HashMap、Hashtable中存储、获取对象，用作key的对象必须实现hashCode()方法和equals()方法。

与HashSet集合不能保证元素的顺序一样，HashMap、Hashtable也不能保证其中key-value对的顺序。类似于HashSet，HashMap、Hashtable判断两个key相等的标准也是：两个key通过equals()方法比较返回true，两个key的hashCode值也相等。

除此之外，HashMap、Hashtable中还包含一个containsValue()方法，用于判断是否包含指定的value。那么HashMap、Hashtable如何判断两个value相等呢？HashMap、Hashtable判断两个value相等的标准更简单：只要两个对象通过equals()方法比较返回true即可。下面程序示范了Hashtable判断两个key相等的标准和两个value相等的标准：

查看代码

上面程序定义了ClassA类和ClassB类，其中ClassA类判断两个ClassA对象相等的标准是count实例变量：只要两个ClassA对象的count变量相等，则通过equals()方法比较它们返回true，它们的hashCode值也相等；而ClassB对象则可以与任何对象相等。

Hashtable判断value相等的标准是：value与另外一个对象通过equals()方法比较返回true即可。上面程序中的ht对象中包含了一个B对象，它与任何对象通过equals()方法比较总是返回true，所以在1代码处返回true。在这种情况下，不管传给ht对象的containtsValue()方法参数是什么，程序总是返回true。

根据Hashtable判断两个key相等的标准，程序在[2]处也将输出true，因为两个ClassA对象虽然不是同一个对象，但它们通过equals()方法比较返回true，且hashCode值相等，Hashtable即认为它们是同一个key。类似的是，程序在[3]处也可以删除对应的key-value对。

程序最后还示范了如何遍历Map中的全部key-value对：调用Map对象的keySet()方法返回全部key组成的Set集合，通过遍历该Set集合的所有元素（就是Map的全部key）就可以遍历Map中的所有key-value对。

注意：当使用自定义类作为HashMap、Hashtable的key时，如果重写该类的equals(Object obj)和hashCode()方法，则应该保证两个方法的判断标准一致，当两个key通过equals()方法比较返回true时，两个key的hashCode()返回值也应该相同。因为HashMap、Hashtable保存key的方式与HashSet保存集合元素的方式完全相同，所以HashMap、Hashtable对key的要求与HashSet对集合元素的要求完全相同。

与HashSet类似的是，如果使用可变对象作为HashMap、Hashtable的key，并且程序修改了作为key的可变对象，则也可能出现与HashSet类似的情形：程序再也无法准确访问到Map中被修改过的key。看下面程序：

查看代码

该程序使用了前一个程序定义的ClassA类实例作为key，而ClassA对象是可变对象。当程序在[1]处修改了ClassA对象后，实际上修改了Hashtable对象的key，这就导致该key不能被准确访问。当程序试图删除count为87563的ClassA对象时，只能删除没被修改的key所对应的key-value对。程序[2]和[3]处的代码都不能访问“疯狂Java讲义”字符串，这都是因为它对应的key被修改过的原因。

注意：与HashSet类似的是，尽量不要使用可变对象作为HashMap、Hashtable的key，如果确实需要使用可变对象作为HashMap、Hashtable的key，则尽量不要在程序中修改作为key的可变对象。

1.*.& LinkedHashMap实现类

HashSet有一个子类是LinkedHashSet，HashMap也有一个LinkedHashMap子类；LinkedHashMap也使用双向链表来维护key-value对的次序（其实只需要考虑key的次序），该链表负责维护Map的迭代顺序，迭代顺序与key-value对的插入顺序保持一致。

LinkedHashMap可以避免对HashMap、Hashtable里的key-value对进行排序（只要插入key-value对时保持顺序即可），同时又可避免使用TreeMap所增加的成本。

LinkedHashMap需要维护元素的插入顺序，因此性能略低于HashMap的性能；但因为它以链表来维护内部顺序，所以在迭代访问Map里的全部元素时将有较好的性能。下面程序示范了LinkedHashMap的功能：迭代输出LinkedHashMap的元素时，将会按添加key-value对的顺序输出：

查看代码

编译、运行上面程序，即可看到LinkedHashMap的功能：LinkedHashMap可以记住key-value对的添加顺序。

1.*.& 使用Properties读写属性文件

Properties类是Hashtable类的子类，正如它的名字所暗示的，该对象在处理属性文件时特别方便（Windows操作平台上的ini文件就是一种属性文件）。Properties类可以把Map对象和属性文件关联起来，从而可以把Map对象中的key-value对写入属性文件中，也可以把属性文件中的“属性名 = 属性值”加载到Map对象中。由于属性文件里的属性名、属性值只能是字符串类型，所以Properties里的key、value都是字符串类型。该类提供了如下三个方法来修改Properties里的key、value值：

• String getProperty(String key)：获取Properties中指定属性名对应的属性值，类似于Map的get(Object key)方法。
• String getProperty(String key, String defaultValue)：该方法与前一个方法基本相似。该方法多一个功能，如果Properties中不存在指定的key时，则该方法指定默认值。
• Object setProperty(String key, String value)：设置属性值，类似于Hashtable的put()方法。

除此之外，它还提供了两个读写Field文件的方法：

• void load(InputStream inStream)：从属性文件（以输入流表示）中加载key-value对，把加载到的key-value对追加到Properties里（Properties是Hashtable的子类，它不保证key-value对之间的次序）。
• void store(OutputStream out, String comments)：将Properties中的key-value对输出到指定的属性文件（以输出流表示）中。

提示：上面两个方法中使用了InputStream类和OutputStream类，它们是Java IO体系中的两个基类。

查看代码

上面程序示范了Properties类的用法，其中props.store(new FileOutputStream("a.ini"), "comment line")将Properties对象中的key-value对写入a.ini文件中；props2.load(new FileInputStream("a.ini"))则从a.ini文件中读取key-value对，并添加到props2对象中。编译、运行上面程序，该程序输出结果如下：

上面程序还在当前路径下生成了一个a.ini文件，该文件的内容如下：

#comment line
#Sat Nov 05 20:11:57 CST 2022
password=123456
username=yeeku

提示：Properties可以把key-value对以XML文件的形式保存起来，也可以从XML文件中加载key-value对，用法与此类似，此处不再赘述。

1.*.& SortedMap接口和TreeMap实现类

正如Set接口派生出SortedSet子接口，SortedSet接口有一个TreeSet实现类一样，Map接口也派生出一个SortedMap子接口，SortedMap接口也有一个TreeMap实现类。

TreeMap就是一个红黑树数据结构，每个key-value对即作为红黑树的一个节点。TreeMap存储key-value对（节点）时，需要根据key对节点进行排序。TreeMap可以保证所有的key-value对处于有序状态。TreeMap也有两种排序方式：

• 自然排序：TreeMap的所有key必须实现Comparable接口，而且所有的key应该是同一个类的对象，否则将会抛出ClassCastException异常。
• 定制排序：创建TreeMap时，传入一个Comparator对象，该对象负责对TreeMap中的所有key进行排序。采用定制排序时不要求Map的key实现Comparable接口。

类似于TreeSet中判断两个元素相等的标准，TreeMap中判断两个key相等的标准是：两个key通过compareTo()方法返回0，TreeMap即认为这两个key是相等的。

如果使用自定义类作为TreeMap的key，且想让TreeMap良好地工作，则重写该类的equals()方法和compareTo()方法时应保持一致的返回结果：两个key通过equals()方法比较返回true时，它们通过compareTo()方法比较应该返回0。如果equals()方法与compareTo()方法的返回结果不一致，TreeMap与Map接口的规则就会冲突。

注意：再次强调：Set和Map的关系十分密切，Java源码就是先实现了HashMap、TreeMap等集合，然后通过包装一个所有的value都为null的Map集合实现了Set集合类。

与TreeSet类似的是，TreeMap中也提供了一系列根据key顺序访问key-value对的方法：

• Map.Entry firstEntry()：返回该Map中最小key所对应的key-value对，如果该Map为空，则返回null。
• Object firstKey()：返回该Map中的最小key值，如果该Map为空，则返回null。
• Map.Entry lastEntry()：返回该Map中最大key所对应的key-value对，如果该Map为空或不存在这样的key-value对，则都返回null。
• Object lastKey()：返回该Map中的最大key值，如果该Map为空或不存在这样的key，则都返回null。
• Map.Entry higherEntry(Object key)：返回该Map中位于key后一位的key-value对（即大于指定key的最小key所对应的key-value对）。如果该Map为空，则返回null。
• Object higherKey(Object key)：返回该Map中位于key后一位的key值（即大于指定key的最小key值）。如果该Map为空或不存在这样的key-value对，则都返回null。
• Map.Entry lowerEntry(Object key)：返回该Map中位于key前一位的key-value对（即小于指定key的最大key所对应的key-value对）。如果该Map为空或不存在这样的key-value对，则都返回null。
• Object lowerKey(Object key)：返回该Map中位于key前一位的key值（即小于指定key的最大key值）。如果该Map为空或不存在这样的key，则都返回null。
• NavigableMap subMap(Object fromKey, boolean fromInclusive, Object toKey, boolean toInclusive)：返回该Map的子Map，其key的范围是从fromKey（是否包括取决于第二个参数）到toKey（是否包括取决于第四个参数）。
• SortedMap subMap(Object fromKey, Object toKey)：返回该Map的子Map，其key的范围是从fromKey（包括）到toKey（不包括）。
• SortedMap tailMap(Object fromKey)：返回该Map的子Map，其key的范围是大于fromKey（包括）的所有key。
• NavigableMap tailMap(Object fromKey, boolean inclusive)：返回该Map的子Map，其key的范围是大于fromKey（是否包括取决于第二个参数）的所有key。
• SortedMap headMap(Object toKey)：返回该Map的子Map，其key的范围是小于toKey（不包括）的所有key。
• NavigableMap headMap(Object toKey, boolean inclusive)：返回该Map的子Map，其key的范围是小于toKey（是否包括取决于第二个参数）的所有key。

提示：表面上看起来这些方法很复杂，其实它们很简单。因为TreeMap中的key-value对是有序的，所以增加了访问第一个、前一个、后一个、最后一个key-value对的方法，并提供了几个从TreeMap中截取子TreeMap的方法。

下面以自然排序为例，介绍TreeMap的基本用法：

查看代码

上面程序中定义了一个ClassR类，该类重写了equals()方法，并实现了Comparable接口，所以可以使用该ClassR对象作为TreeMap的key，该TreeMap使用自然排序。运行上面程序，看到如下运行结果：

1.*.& WeakHashMap实现类

WeakHashMap与HashMap的用法基本相似。与HashMap的区别在于，HashMap的key保留了对实际对象的强引用，这意味着只要该HashMap对象不被销毁，该HashMap的所有key所引用的对象就不会被垃圾回收，HashMap也不会自动删除这些key所对应的key-value对；但WeakHashMap的key只保留了对实际对象的弱引用，这意味着如果WeakHashMap对象的key所引用的对象没有被其他强引用变量所引用，则这些key所引用的对象可能被垃圾回收，WeakHashMap也可能自动删除这些key所对应的key-value对。

WeakHashMap中的每个key对象只持有对实际对象的弱引用，因此，当垃圾回收了该key所对应的实际对象之后，WeakHashMap会自动删除该key对应的key-value对。看如下程序：

查看代码

编译、运行上面程序，看到如下运行结果：

从上面运行结果可以看出，当系统进行垃圾回收时，删除了WeakHashMap对象的前三个key-value对。这是因为添加前三个key-value对时，这三个key都是匿名的字符串对象，WeakHashMap只保留了对它们的弱引用，这样垃圾回收时会自动删除这三个key-value对。

WeakHashMap对象中第4个组key-value对，也就是whm.put("java", new String("中等"))的key是一个字符串直接量，系统会自动保留对该字符串对象的强引用，所以垃圾回收时不会回收它。

注意：如果需要使用WeakHashMap的key来保留对象的弱引用，则不要让该key所引用的对象具有任何强引用，否则将失去使用WeakHashMap的意义。

1.*.& IdentityHashMap实现类

这个Map实现类的实现机制与HashMap基本相似，但它在处理两个key相等时比较独特：在IdentityHashMap中，当且仅当两个key严格相等（key1 == key2）时，IdentityHashMap才认为两个key相等；对于普通的HashMap而言，只要key1和key2通过equals()方法比较返回true，且它们的hashCode值相等即可。

注意：IdentityHashMap是一个特殊的Map实现！此类实现Map接口时，它有意违反Map的通常规范：IdentityHashMap要求两个key严格相等时才认为两个key相等。

IdentityHashMap提供了与HashMap基本相似的方法，也允许使用null作为key和value。与HashMap相似：IdentityHashMap也不保证key-value对之间的顺序，更不能保证它们的顺序随时间的推移保持不变。

查看代码

编译、运行上面程序，看到如下运行结果：

上面程序试图向IdentityHashMap对象中添加4个key-value对，前2个key-value对中的key是新创建的字符串对象，它们通过==比较不相等，所以IdentityHashMap会把它们当成2个key来处理。

后2个key-value对中的key都是字符串直接量，而且它们的字节序列完全相同，Java使用常量池来管理字符串直接量，所以它们通过==比较返回true，IdentityHashMap会认为它们是同一个key，因此只有一次可以添加成功。

1.*.& EnumMap实现类

EnumMap是一个与枚举类一起使用的Map实现，EnumMap中的所有key都必须是单个枚举类的枚举值。创建EnumMap时必须显式或隐式指定它对应的枚举类。

EnumMap在内部以数组形式保存，所以这种实现形式非常紧凑、高效。

EnumMap根据key的自然顺序（即枚举值在枚举类中的定义顺序）来维护key-value对的顺序。当程序通过keySet()、entrySet()、values()等方法遍历EnumMap时可以看到这种顺序。

EnumMap不允许使用null作为key，但允许使用null作为value。如果试图使用null作为key时将抛出NullPointerException异常。如果只是查询是否包含值为null的key，或只是删除值为null的key，都不会抛出异常。

与创建普通的Map有所区别的是，创建EnumMap时必须指定一个枚举类，从而将该EnumMap和指定枚举类关联起来。

下面程序示范了EnumMap的用法：

查看代码

上面程序中创建了一个EnumMap对象，创建该EnumMap对象时指定它的key只能是Season枚举类的枚举值。如果向该EnumMap中添加两个key-value对后，这两个key-value对将会以Season枚举值的自然顺序排序。

编译、运行上面程序，看到如下运行结果：

1.*.& 各Map实现类的性能分析

对于Map的常用实现类而言，HashMap和Hashtable的效率大致相同，因为它们的实现机制几乎完全一样；但HashMap通常比Hashtable要快一点，因为Hashtable需要额外的线程同步控制。

TreeMap通常比HashMap、Hashtable要慢（尤其在插入、删除key-value对时更慢），因为TreeMap底层采用红黑树来管理key-value对（红黑树的每个节点就是一个key-value对）。

使用TreeMap有一个好处：TreeMap中的key-value对总是处于有序状态，无须专门进行排序操作。当TreeMap被填充之后，就可以调用keySet()，取得由key组成的Set，然后使用toArray()方法生成key的数组，接下来使用Arrays的binarySearch()方法在已排序的数组中快速地查询对象。

对于一般的应用场景，程序应该多考虑使用HashMap，因为HashMap正是为快速查询设计的（HashMap底层其实也是采用数组来存储key-value对）。但如果程序需要一个总是排好序的Map时，则可以考虑使用TreeMap。

LinkedHashMap比HashMap慢一点，因为它需要维护链表来保持Map中key-value时的添加顺序。IdentityHashMap性能没有特别出色之处，因为它采用与HashMap基本相似的实现，只是它使用==而不是equals()方法来判断元素相等。EnumMap的性能最好，但它只能使用同一个枚举类的枚举值作为key。