1. 概述
在本教程中，我们将探讨处理具有重复键的Map的可用选项，或者换句话说，允许为单个键存储多个值的Map。
2. 标准Map
Java有几种Map接口的实现，每一种都有自己的特殊性。
但是，现有的Java核心Map实现都不允许Map处理单个键的多个值。
如我们所见，如果我们尝试为同一个键插入两个值，则将存储第二个值，而第一个值将被删除。
它也将被返回(通过put(K key, V value)方法的每个正确实现)：
Map<String, String> map = new HashMap<>();
assertThat(map.put("key1", "value1")).isEqualTo(null);
assertThat(map.put("key1", "value2")).isEqualTo("value1");
assertThat(map.get("key1")).isEqualTo("value2");
那么，我们如何才能实现所需的行为呢？
3. Collection作为值
显然，为Map的每个值使用一个Collection就可以完成这项工作：
Map<String, List<String>> map = new HashMap<>();
List<String> list = new ArrayList<>();
map.put("key1", list);
map.get("key1").add("value1");
map.get("key1").add("value2");
assertThat(map.get("key1").get(0)).isEqualTo("value1");
assertThat(map.get("key1").get(1)).isEqualTo("value2");
然而，这种冗长的解决方案有多个缺点并且容易出错。这意味着我们需要为每个值实例化一个Collection，在添加或删除值之前检查它是否存在，在没有值时手动删除它，等等。
从Java 8开始，我们可以利用compute()方法并对其进行改进：
Map<String, List<String>> map = new HashMap<>();
map.computeIfAbsent("key1", k -> new ArrayList<>()).add("value1");
map.computeIfAbsent("key1", k -> new ArrayList<>()).add("value2");
assertThat(map.get("key1").get(0)).isEqualTo("value1");
assertThat(map.get("key1").get(1)).isEqualTo("value2");
但是，我们应该避免它，除非有充分的理由不这样做，例如限制性公司政策阻止我们使用第三方库。
否则，在编写我们自己的自定义Map实现并重新发明轮子之前，我们应该在开箱即用的几个选项中进行选择。
4. Apache Commons Collections
像往常一样，Apache为我们的问题提供了解决方案。
让我们首先导入最新版本的Common Collections(从现在开始是CC)：
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-collections4</artifactId>
<version>4.1</version>
</dependency>
4.1 MultiMap
org.apache.commons.collections4.MultiMap接口定义了一个Map，它包含针对每个键的值集合。
它由org.apache.commons.collections4.map.MultiValueMap类实现，该类会自动处理底层的大部分样板代码：
MultiMap<String, String> map = new MultiValueMap<>();
map.put("key1", "value1");
map.put("key1", "value2");
assertThat((Collection<String>) map.get("key1"))
.contains("value1", "value2");
虽然此类自CC3.2起可用，但它不是线程安全的，并且在CC4.1中已被弃用。我们应该只在无法升级到较新版本时才使用它。
4.2 MultiValuedMap
MultiMap的继承者是org.apache.commons.collections4.MultiValuedMap接口。它具有多个现成的实现。
让我们看看如何将多个值存储到一个ArrayList中，它保留了重复项：
MultiValuedMap<String, String> map = new ArrayListValuedHashMap<>();
map.put("key1", "value1");
map.put("key1", "value2");
map.put("key1", "value2");
assertThat((Collection<String>) map.get("key1"))
.containsExactly("value1", "value2", "value2");
或者，我们可以使用HashSet，它会删除重复项：
MultiValuedMap<String, String> map = new HashSetValuedHashMap<>();
map.put("key1", "value1");
map.put("key1", "value1");
assertThat((Collection<String>) map.get("key1"))
.containsExactly("value1");
以上两种实现都不是线程安全的。
让我们看看如何使用UnmodifiableMultiValuedMap装饰器使它们不可变：
@Test(expected = UnsupportedOperationException.class)
public void givenUnmodifiableMultiValuedMap_whenInserting_thenThrowingException() {
MultiValuedMap<String, String> map = new ArrayListValuedHashMap<>();
map.put("key1", "value1");
map.put("key1", "value2");
MultiValuedMap<String, String> immutableMap = MultiMapUtils.unmodifiableMultiValuedMap(map);
immutableMap.put("key1", "value3");
}
5. Guava Multimap
Guava是用于Java API的Google核心库。
让我们在项目中导入Guava：
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>31.0.1-jre</version>
</dependency>
Guava从一开始就遵循了多种实现的路径。
最常见的是com.google.common.collect.ArrayListMultimap，它为每个值使用由ArrayList支持的HashMap：
Multimap<String, String> map = ArrayListMultimap.create();
map.put("key1", "value2");
map.put("key1", "value1");
assertThat((Collection<String>) map.get("key1"))
.containsExactly("value2", "value1");
与往常一样，我们应该更倾向Multimap接口的不可变实现：com.google.common.collect.ImmutableListMultimap和com.google.common.collect.ImmutableSetMultimap。
5.1 常见的Map实现
当我们需要一个特定的Map实现时，首先要做的是检查它是否存在，因为Guava可能已经实现了它。
例如，我们可以使用com.google.common.collect.LinkedHashMultimap，保留键和值的插入顺序：
Multimap<String, String> map = LinkedHashMultimap.create();
map.put("key1", "value3");
map.put("key1", "value1");
map.put("key1", "value2");
assertThat((Collection<String>) map.get("key1"))
.containsExactly("value3", "value1", "value2");
或者，我们可以使用com.google.common.collect.TreeMultimap，它按自然顺序迭代键和值：
Multimap<String, String> map = TreeMultimap.create();
map.put("key1", "value3");
map.put("key1", "value1");
map.put("key1", "value2");
assertThat((Collection<String>) map.get("key1"))
.containsExactly("value1", "value2", "value3");
5.2 打造我们的自定义MultiMap
还有许多其他实现可用。
但是，我们可能想要装饰尚未实现的Map和/或List。
幸运的是，Guava有一个工厂方法允许我们这样做-Multimap.newMultimap()。
6. 总结
我们已经了解了如何以所有主要的现有方式在Map中存储一个键的多个值。
我们探索了Apache Commons Collections和Guava最流行的实现，如果可能的话，它们应该比自定义解决方案更优先。
与往常一样，本教程的完整源代码可在GitHub上获得。
Post Directory
