Guava BiMap指南

1. 概述

在本教程中，我们将展示如何使用Google Guava的BiMap接口及其多个实现。

BiMap(或“双向Map”)是一种特殊的Map，它保持Map的反向视图，同时确保不存在重复值，并且始终可以安全地使用值来取回键。

BiMap的基本实现是HashBiMap，它在内部使用两个Map，一个用于键到值的Map，另一个用于值到键的Map。

2. Google Guava的BiMap

让我们看看如何使用BiMap类。

首先我们需要在pom.xml中添加Google Guava库依赖项：

<dependency>
    <groupId>com.google.guava</groupId>
    <artifactId>guava</artifactId>
    <version>31.0.1-jre</version>
</dependency>

可以在[此处](https://search.maven.org/classic/#search

gav

g%3A”com.google.guava”ANDa%3A”guava”)检查最新版本的依赖项。

3. 创建BiMap

你可以通过多种方式创建BiMap的实例，如下所示：

如果要处理自定义Java对象，请使用类HashBiMap中的create方法：
```
BiMap<String, String> capitalCountryBiMap = HashBiMap.create();
```
如果我们已经有一个现有的Map，你可以使用类HashBiMap中create方法的重载版本创建BiMap的实例：
```
Map<String, String> capitalCountryBiMap = new HashMap<>();
//...
HashBiMap.create(capitalCountryBiMap);
```

如果要处理Enum类型的键，请使用EnumHashBiMap类中的create方法：

BiMap<MyEnum, String> operationStringBiMap = EnumHashBiMap.create(MyEnum.class);

如果要创建不可变Map，请使用ImmutableBiMap类(遵循构建器模式)：

BiMap<String, String> capitalCountryBiMap = new ImmutableBiMap.Builder<>()
    .put("New Delhi", "India")
    .build();

4. 使用BiMap

让我们从一个简单的例子开始展示BiMap的用法，我们可以在其中根据值获取键，并根据键获取值：

@Test
public void givenBiMap_whenQueryByValue_shouldReturnKey() {
    BiMap<String, String> capitalCountryBiMap = HashBiMap.create();
    capitalCountryBiMap.put("New Delhi", "India");
    capitalCountryBiMap.put("Washington, D.C.", "USA");
    capitalCountryBiMap.put("Moscow", "Russia");

    String keyFromBiMap = capitalCountryBiMap.inverse().get("Russia");
    String valueFromBiMap = capitalCountryBiMap.get("Washington, D.C.");
 
    assertEquals("Moscow", keyFromBiMap);
    assertEquals("USA", valueFromBiMap);
}

注意：上面的inverse方法返回BiMap的反向视图，它将每个BiMap的值映射到它的关联键。

当我们尝试存储重复值两次时，BiMap会抛出IllegalArgumentException。

让我们看一个相同的例子：

@Test(expected = IllegalArgumentException.class)
public void givenBiMap_whenSameValueIsPresent_shouldThrowException() {
    BiMap<String, String> capitalCountryBiMap = HashBiMap.create();
    capitalCountryBiMap.put("Mumbai", "India");
    capitalCountryBiMap.put("Washington, D.C.", "USA");
    capitalCountryBiMap.put("Moscow", "Russia");
    capitalCountryBiMap.put("New Delhi", "India");
}

如果我们希望覆盖BiMap中已经存在的值，我们可以使用forcePut方法：

@Test
public void givenSameValueIsPresent_whenForcePut_completesSuccessfully() {
    BiMap<String, String> capitalCountryBiMap = HashBiMap.create();
    capitalCountryBiMap.put("Mumbai", "India");
    capitalCountryBiMap.put("Washington, D.C.", "USA");
    capitalCountryBiMap.put("Moscow", "Russia");
    capitalCountryBiMap.forcePut("New Delhi", "India");

    assertEquals("USA", capitalCountryBiMap.get("Washington, D.C."));
    assertEquals("Washington, D.C.", capitalCountryBiMap.inverse().get("USA"));
}

5. 总结

在这个简洁的教程中，我们举例说明了在Guava库中使用BiMap的例子。它主要用于根据Map中的值获取键。

与往常一样，本教程的完整源代码可在GitHub上获得。

Show Disqus Comments

1. 概述

2. Google Guava的BiMap

3. 创建BiMap

4. 使用BiMap

5. 总结

Post Directory