Guava新集合类型

开发中，集合类型无疑是JDK最常用的数据类型之一。但是JDK提供的诸如List、Set、Map都是一些基础的集合类型，有这特定的使用场景限制，往往不能满足我们的开发需求，比如集合类型嵌套的情况，Map<string, List<String>>甚至更复杂的嵌套类型等。Guava在JDK集合框架的基础上新开发了一套常用的集合类型，以简化开发。包括MutilSet、MultiMap、BiMap、Table、ClassToinstanceMap、RangeSet、RangeMap等等，本文依照我的理解，对Multiset、MultiMap、BiMap做一些简单的介绍，如有需要了解其他集合类型的可以去看一下Guava官方用户文档

• MultiSet

JDK中的set和数学上集合的概念是相同的，Set最大的特性就是不允许在其中存放重复的元素，可以被用来过滤在其他集合中存放的元素，从而得到一个没有包含重复新的集合。假如需要统计一个词在文档中出现了多少次，传统的做法是这样的：

Map<String, Integer> counts = new HashMap<String, Integer>();
for (String word : words) {
    Integer count = counts.get(word);
    if (count == null) {
        counts.put(word, 1);
    } else {
        counts.put(word, count + 1);
    }
}

写法比较繁琐，容易出错，并且不支持同时收集多种统计信息，如总词数。为此Guava提供了一种新型的set集合类型 Multiset，它可以多次添加相等的元素。同时，Multiset继承自JDK中的Collection接口，而不是Set接口，并没有破坏Set的原有特性。除了支持添加重复的元素，其他的属性跟JDK中的set相同，比如都是无序集合。

示例代码：

@Test
public void multiSetTest() {
    Multiset<String> multiset = HashMultiset.create();
    multiset.add("a");
    multiset.add("b", 2);
    List<String> addList = Lists.newArrayList("c", "c", "c");
    multiset.addAll(addList);
    /*输出 [a, b x 2, c x 3] */
    System.out.println(multiset);
    assertEquals(2, multiset.count("b"));

    assertEquals(6, multiset.size());

    assertTrue(multiset.contains("a"));

    assertTrue(multiset.containsAll(Lists.newArrayList("a", "c")));
    assertFalse(multiset.containsAll(Lists.newArrayList("a", "c", "e")));

    Set<String> set = Sets.newLinkedHashSet("a", "b", "c");
    assertEquals(set, multiset.elementSet());

    Set<Multiset.Entry<String>> setEntry = multiset.entrySet();
    setEntry.forEach(entry -> {
        System.out.println(entry.getElement() + ": " + entry.getCount());
    });

    multiset.remove("a");
    assertEquals(5, multiset.size());
    multiset.remove("b", 10);
    assertEquals(3, multiset.size());
    multiset.removeAll(Lists.newArrayList("c"));
    assertEquals(0, multiset.size());

    multiset.setCount("x", 10);
    assertEquals(10, multiset.size());

    multiset.setCount("y", 3);
    assertEquals(13, multiset.size());

    multiset.setCount("y", 3, 5);
    assertEquals(15, multiset.size());
    multiset.setCount("y", 3, 8);
    assertEquals(15, multiset.size());
}

Guava提供了多种Multiset的实现，大致对应JDK中Map的各种实现：

• MultiMap

JDK中的Map，如果先后为同一个key添加value，后添加的value会覆盖之前添加的value，所以当需要一个key可以映射多个value值时，往往需要做类似于这样的Map<K, List<V>>或Map<K, Set<V>>这样的嵌套，而这种嵌套的操作往往是比较繁琐的。Guava中提供了一种新的Map集合类型MultiMap，允许在map中一个key映射多个value值。

示例代码：

@Test
public void multiMapTest(){
    Multimap<String, String> multimap = ArrayListMultimap.create();
    multimap.put("key1", "this");
    multimap.put("key1", "is");
    multimap.put("key1", "key1List");
    System.out.println(multimap);
    assertEquals(3, multimap.size());
    List<String> key2List = Lists.newArrayList("this", "is", "key2List");
    multimap.putAll("key2", key2List);
    System.out.println(multimap);
    assertEquals(6, multimap.size());

    assertTrue(multimap.containsKey("key1"));
    assertTrue(multimap.containsValue("key2List"));

    Multiset<String> key1MultiSet = multimap.keys();
    assertEquals(3, key1MultiSet.count("key1"));
    /*对keys返回的视图操作会影响multiMap*/
    key1MultiSet.remove("key1");
    System.out.println(multimap);
    assertEquals(5, multimap.size());

    /*对keySet返回的视图操作会影响multiMap*/
    Set<String> keySet = multimap.keySet();
    assertEquals(2, keySet.size());
    keySet.remove("key1");
    System.out.println(multimap);

    multimap.remove("key2", "this");
    System.out.println(multimap);
    multimap.remove("key2","testDeleteNonExistValue");
    System.out.println(multimap);
    assertEquals(2, multimap.size());

    List<String> key3List = Lists.newArrayList("key3","is", "create");
    multimap.putAll("key3", key3List);
    multimap.removeAll("key2");
    System.out.println(multimap);
    assertEquals(3, multimap.size());

    key3List = Lists.newArrayList("new", "key3","has","been","created");
    multimap.replaceValues("key3", key3List);
    System.out.println(multimap);
    assertEquals(5, multimap.size());
    /*key2不存在，新建key2*/
    multimap.replaceValues("key2", key3List);
    System.out.println(multimap);
    assertEquals(10, multimap.size());

    List<String> valuesCollection = Lists.newArrayList(multimap.values());
    /*对values返回的视图的操作不会影响multiMap*/
    valuesCollection.removeAll(Lists.newArrayList("key3"));
    valuesCollection.add("addNew");
    System.out.println(multimap);
    assertEquals(10, multimap.size());

    multimap.clear();
    assertTrue(multimap.isEmpty());
}

Guava提供了多种Multiset的实现，可以在大多数使用Map <K，Collection <V >>的地方使用：

• BiMap

如果要实现一个双向Map，需要维护两个单独的map，并保持它们间的同步，显然这种方式很容易出错，比如更新一个Map的时候忘了同步更新另一个Map就会产生一些bug。Guava中提供了一个新型的双向Map集合类型BiMap，继承自java.util.Map

注：BiMap继承自Map，Map中的方法，BiMap也可以使用

示例代码：

@Test
public void biMapTest(){
    BiMap<Integer, String> idNameBiMap = HashBiMap.create();
    idNameBiMap.put(1, "Michael");
    idNameBiMap.put(2, "Jane");
    idNameBiMap.put(3, "Marry");
    /*put添加已存在的value会报IllegalArgumentException*/
    assertThatThrownBy(()->idNameBiMap.put(4, "Marry"))
            .isInstanceOf(IllegalArgumentException.class)
            .hasNoCause();

    /*put添加已存在的key，会覆盖之前key对应的value值*/
    idNameBiMap.put(3,"zhuoli");
    System.out.println(idNameBiMap);
    assertEquals(3, idNameBiMap.size());

    /*forcePut强制插入已存在的valu，会删除之前的键值对 2 - Jane*/
    idNameBiMap.forcePut(4, "Jane");
    System.out.println(idNameBiMap);
    assertEquals(3, idNameBiMap.size());

    Set<String> biMapValuesSet = idNameBiMap.values();
    System.out.println(biMapValuesSet);

    BiMap<String, Integer> nameIdBiMap = idNameBiMap.inverse();
    System.out.println(nameIdBiMap);
    assertEquals(4, nameIdBiMap.get("Jane").intValue());
}

Guava提供了多种BiMap的实现

测试代码：码云 – 卓立 – Guava测试代码

1. Google Guava Docs
2. Google Guava User Guide