Guava 中的 Maps 工具类详解

1. 概述

这篇文章主要介绍如何使用 Guava 来优雅地操作 Java 中的 Map 结构。

我们从最简单的开始：使用 Guava 创建一个 HashMap，而无需显式使用 new 关键字：

Map<String, String> aNewMap = Maps.newHashMap();

✅ 这种方式虽然简单，但减少了样板代码，让代码更简洁。

2. 不可变 Map（ImmutableMap）

Guava 提供了 ImmutableMap 类型，创建后无法修改，非常适合用于配置或常量映射。

下面是一个典型的使用示例：

@Test
public void whenCreatingImmutableMap_thenCorrect() {
    Map<String, Integer> salary = ImmutableMap.<String, Integer> builder()
      .put("John", 1000)
      .put("Jane", 1500)
      .put("Adam", 2000)
      .put("Tom", 2000)
      .build();

    assertEquals(1000, salary.get("John").intValue());
    assertEquals(2000, salary.get("Tom").intValue());
}

⚠️ 注意：一旦构建完成，这个 Map 就不能被修改了。

3. 有序 Map（SortedMap）

如果需要键值对按键排序，Guava 提供了 ImmutableSortedMap，可以轻松实现排序逻辑。

@Test
public void whenUsingSortedMap_thenKeysAreSorted() {
    ImmutableSortedMap<String, Integer> salary = new ImmutableSortedMap
      .Builder<String, Integer>(Ordering.natural())
      .put("John", 1000)
      .put("Jane", 1500)
      .put("Adam", 2000)
      .put("Tom", 2000)
      .build();

    assertEquals("Adam", salary.firstKey());
    assertEquals(2000, salary.lastEntry().getValue().intValue());
}

✅ 使用 Ordering.natural() 可以让字符串按键的自然顺序排序。

4. 双向映射 Map（BiMap）

BiMap 是一种特殊的 Map，它确保键和值都唯一，并支持通过 inverse() 方法快速反转键值。

@Test
public void whenCreateBiMap_thenCreated() {
    BiMap<String, Integer> words = HashBiMap.create();
    words.put("First", 1);
    words.put("Second", 2);
    words.put("Third", 3);

    assertEquals(2, words.get("Second").intValue());
    assertEquals("Third", words.inverse().get(3));
}

⚠️ 如果你尝试插入一个已存在的值，会抛出异常，因为 BiMap 要求值也唯一。

5. 多值映射 Map（Multimap）

在 Java 原生 Map 中，一个 key 只能对应一个 value。而 Multimap 允许一个 key 映射多个值。

@Test
public void whenCreateMultimap_thenCreated() {
    Multimap<String, String> multimap = ArrayListMultimap.create();
    multimap.put("fruit", "apple");
    multimap.put("fruit", "banana");
    multimap.put("pet", "cat");
    multimap.put("pet", "dog");

    assertThat(multimap.get("fruit"), containsInAnyOrder("apple", "banana"));
    assertThat(multimap.get("pet"), containsInAnyOrder("cat", "dog"));
}

✅ 这在处理一对多关系时非常实用，比如分类标签、角色权限等。

6. 表格结构（Table）

当需要使用两个维度的 key 来索引一个值时，可以用 Table。比如城市之间的距离：

@Test
public void whenCreatingTable_thenCorrect() {
    Table<String,String,Integer> distance = HashBasedTable.create();
    distance.put("London", "Paris", 340);
    distance.put("New York", "Los Angeles", 3940);
    distance.put("London", "New York", 5576);

    assertEquals(3940, distance.get("New York", "Los Angeles").intValue());
    assertThat(distance.columnKeySet(), 
      containsInAnyOrder("Paris", "New York", "Los Angeles"));
    assertThat(distance.rowKeySet(), containsInAnyOrder("London", "New York"));
}

你还可以使用 Tables.transpose() 来反转行和列：

@Test
public void whenTransposingTable_thenCorrect() {
    Table<String,String,Integer> distance = HashBasedTable.create();
    distance.put("London", "Paris", 340);
    distance.put("New York", "Los Angeles", 3940);
    distance.put("London", "New York", 5576);

    Table<String, String, Integer> transposed = Tables.transpose(distance);

    assertThat(transposed.rowKeySet(), 
      containsInAnyOrder("Paris", "New York", "Los Angeles"));
    assertThat(transposed.columnKeySet(), containsInAnyOrder("London", "New York"));
}

7. 类到实例的映射（ClassToInstanceMap）

如果你希望以类的类型作为 key 来存储对应的实例，可以使用 ClassToInstanceMap：

@Test
public void whenCreatingClassToInstanceMap_thenCorrect() {
    ClassToInstanceMap<Number> numbers = MutableClassToInstanceMap.create();
    numbers.putInstance(Integer.class, 1);
    numbers.putInstance(Double.class, 1.5);

    assertEquals(1, numbers.get(Integer.class));
    assertEquals(1.5, numbers.get(Double.class));
}

✅ 这在处理多态集合时非常方便，避免了手动类型转换。

8. 利用 Multimap 对 List 进行分组

Guava 提供了 Multimaps.index() 方法，可以轻松对 List 按照某种规则进行分组。

比如，我们按名字长度对 List 进行分组：

@Test
public void whenGroupingListsUsingMultimap_thenGrouped() {
    List<String> names = Lists.newArrayList("John", "Adam", "Tom");
    Function<String,Integer> func = new Function<String,Integer>(){
        public Integer apply(String input) {
            return input.length();
        }
    };
    Multimap<Integer, String> groups = Multimaps.index(names, func);

    assertThat(groups.get(3), containsInAnyOrder("Tom"));
    assertThat(groups.get(4), containsInAnyOrder("John", "Adam"));
}

✅ 这种方式比手动遍历 List 然后分组要简洁得多。

9. 总结

这篇文章我们介绍了 Guava 中用于操作 Map 的几个核心工具类和数据结构：

ImmutableMap：不可变 Map
ImmutableSortedMap：有序 Map
BiMap：双向映射 Map
Multimap：多值映射 Map
Table：二维表结构 Map
ClassToInstanceMap：类到实例的映射
Multimaps.index()：对 List 进行分组

这些工具类在实际开发中能极大提升代码的可读性和健壮性，强烈推荐熟练掌握。

📌 所有示例代码可以在 GitHub 项目中找到。项目基于 Eclipse，导入即可运行。

Persistence

REST

Security