在本篇文章中我们将介绍Guava集合中的BiMap这个接口.
Interface BiMap<K,V>
BiMap接口的父接口是Map<K,V>。
而BiMap接口的实现类有：EnumBiMap, EnumHashBiMap, HashBiMap, ImmutableBiMap这四个。
我们可以通过源码可以看到BiMap接口的定义为：
|
1
2
3
|
@GwtCompatible
public
interface
BiMap<K,V>
extends
Map<K,V>
|
如果我们用一句话来介绍BiMap的话，那就是：“它就是一个双向映射的Map”。我们可以通过key找到value，反之也能够根据value找到对应的key。
我们来面对一个比较常见的需求吧：
对一个map进行逆转，原始的value作为key，key作为value。
好吧，这个需求其实并不是怎么的明确，没有说清楚是否需要考虑value重复的情况，我们假设不考虑value重复的情况，我们可以有下面的代码：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
|
Map<String,String> britishToAmerican =
Maps.newHashMap();
britishToAmerican.put(
"aubergine"
,
"egglant"
);
britishToAmerican.put(
"courgette"
,
"zucchini"
);
britishToAmerican.put(
"jam"
,
"jelly"
);
// Generic method to reverse map.
public
<S,T> Map<T,S> getInverseMap(Map<S,T> map) {
Map<T,S> inverseMap =
new
HashMap<T,S>();
for
(Entry<S,T> entry: map.entrySet()) {
inverseMap.put(entry.getValue(), entry.getKey());
}
return
inverseMap;
}
|
正如上面所提到的，这样做能实现功能，但是有一些你要考虑的问题：
1）如何处理重复的value的情况，不考虑的话，那么反转的时候会覆盖前面的值
2）如果我们需要在反转的map中增加新的key呢？我们是否也需 要在原始的map中更新一个值呢！这个实在太烦了
在这种情况下，我们就可以使用BiMap.我们先来看看完成上面的功能的使用BiMap的代码：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
BiMap<String,String> britishToAmerican =
HashBiMap.create();
// Initialise and use just like a normal map
britishToAmerican.put(
"aubergine"
,
"egglant"
);
britishToAmerican.put(
"courgette"
,
"zucchini"
);
britishToAmerican.put(
"jam"
,
"jelly"
);
System.out.println(britishToAmerican.get
(
"aubergine"
));
// eggplant
BiMap<String,String> americanToBritish =
britishToAmerican.inverse();
System.out.println(americanToBritish.get(
"eggplant"
));
// aubergine
System.out.println(americanToBritish.get(
"zucchini"
));
// courgette
|
很简单是吧，但是在使用BiMap的时候，需要注意几个地方：
BiMap强制其value的唯一性，如果发现违规则会抛出 IllegalArgumentException。
|
1
2
3
4
5
6
7
|
IllegalArgumentException。
britishToAmerican.put(
"pudding"
,
"dessert"
);
britishToAmerican.put(
"sweet"
,
"dessert"
);
//
IllegalArgumentException.
|
但是如果你确实希望增加一个已经存在的值，那么可以使用forcePut 方法覆盖原有值。
|
1
2
3
4
5
6
7
|
britishToAmerican.put(
"pudding"
,
"dessert"
);
britishToAmerican.forcePut(
"sweet"
,
"dessert"
);
// Overwrites the previous entry
System.out.println(britishToAmerican.get(
"sweet"
));
// dessert
System.out.println(britishToAmerican.get(
"pudding"
));
// null
|
另外一个关键点就是理解inverse方法，这个方法返回一个反转 后的BiMap，即key/value互相切换的映射。 这个反转的map并不是一个新的map，而是一个视图，这意味着， 你在这个反转后的map中的任何增删改操作都会影响原来的map。
|
1
2
3
4
5
6
7
8
9
|
americanToBritish.put(
"potato chips"
,
"crisps"
);
System.out.println(britishToAmerican.containsKey
(
"crisps"
));
// true
System.out.println(britishToAmerican.get(
"crisps"
));
// potato chips
|
BiMap的常用实现有：
HashBiMap: key 集合与 value 集合都有 HashMap 实现
EnumBiMap: key 与 value 都必须是 enum 类型
ImmutableBiMap: 不可修改的 BiMap
