Google Guava 中Multimap的简单应用

在工作中，我们会经常需要用到如下类似的结构：

Map<String, Set<Stirng>> map = new HashMap<>();
Map<String, List<String>> map2 = new HashMap<>();

在Google Guava中，对这种结构的map进行封装， 提供了接口Multimap<K, V>，可以方便地把一个键对应到一个List或者Set。

上面的代码中的两种map结构，可以用如下代码：

SetMultimap<String, String> map= HashMultimap.create();

ListMultimap<String, String> map2 = ArrayListMultimap.create();

// 遍历取值
for (Entry<String, Collection<String>> en : map.asMap().entrySet()) {
    String key = en.getKey();
    Set<String> value = (Set<String>)en.getValue();
}

（以下摘自：https://www.cnblogs.com/parryyang/p/5776654.html）

特点：不会有任何键映射到空集合：一个键要么至少到一个值，要么根本就不在Multimap中。

主要方法介绍：

• put(K, V)：添加键到单个值的映射
• putAll(K, Iterable<V>)：依次添加键到多个值的映射
• remove(K, V)：移除键到值的映射；如果有这样的键值并成功移除，返回true
• removeAll(K)：清除键对应的所有值，返回的集合包含所有之前映射到K的值，但修改这个集合就不会影响Multimap了
• replaceValues(K, Iterable<V>)：清除键对应的所有值，并重新把key关联到Iterable中的每个元素。返回的集合包含所有之前映射到K的值

Multimap的视图

　　Multimap还支持若干强大的视图：

• asMap为Multimap<K, V>提供Map<K,Collection<V>>形式的视图。返回的Map支持remove操作，并且会反映到底层的 Multimap，但它不支持put或putAll操作。更重要的是，如果你想为Multimap中没有的键返回null，而不是一个新的、可写的空集 合，你就可以使用asMap().get(key)。（你可以并且应当把asMap.get(key)返回的结果转化为适当的集合类型——如 SetMultimap.asMap.get(key)的结果转为Set，ListMultimap.asMap.get(key)的结果转为List ——Java类型系统不允许ListMultimap直接为asMap.get(key)返回List——译者注：也可以用Multimaps中的asMap静态方法帮你完成类型转换）
• entries用Collection<Map.Entry<K, V>>返回Multimap中所有”键-单个值映射”——包括重复键。（对SetMultimap，返回的是Set）
• keySet用Set表示Multimap中所有不同的键。
• keys用Multiset表示Multimap中的所有键，每个键重复出现的次数等于它映射的值的个数。可以从这个Multiset中移除元素，但不能做添加操作；移除操作会反映到底层的Multimap。
• values()用 一个”扁平”的Collection<V>包含Multimap中的所有值。这有一点类似于 Iterables.concat(multimap.asMap().values())，但它直接返回了单个Collection，而不像 multimap.asMap().values()那样是按键区分开的Collection。

Multimap不是Map

　　Multimap<K, V>不是Map<K,Collection<V>>，虽然某些Multimap实现中可能使用了map。它们之间的显著区别包括：

• Multimap.get(key)总是返回非null、但是可能空的集合。这并不意味着Multimap为相应的键花费内存创建了集合，而只是提供一个集合视图方便你为键增加映射值——译者注：如果有这样的键，返回的集合只是包装了Multimap中已有的集合；如果没有这样的键，返回的空集合也只是持有Multimap引用的栈对象，让你可以用来操作底层的Multimap。因此，返回的集合不会占据太多内存，数据实际上还是存放在Multimap中。
• 如果你更喜欢像Map那样，为Multimap中没有的键返回null，请使用asMap()视图获取一个Map<K, Collection<V>>。（或者用静态方法Multimaps.asMap()为ListMultimap返回一个Map<K, List<V>>。对于SetMultimap和SortedSetMultimap，也有类似的静态方法存在）
• 当且仅当有值映射到键时，Multimap.containsKey(key)才会返回true。尤其需要注意的是，如果键k之前映射过一个或多个值，但它们都被移除后，Multimap.containsKey(key)会返回false。
• Multimap.entries()返回Multimap中所有”键-单个值映射”——包括重复键。如果你想要得到所有”键-值集合映射”，请使用asMap().entrySet()。
• Multimap.size()返回所有”键-单个值映射”的个数，而非不同键的个数。要得到不同键的个数，请改用Multimap.keySet().size()。