guava中对Map的扩展数据结构

Multimap - 多值Map

guava中的Multimap提供了将一个键映射到多个值的形式，使用起来无需定义复杂的内层集合，可以像使用普通的Map一样使用它，定义及放入数据如下：

Multimap<String, Integer> multimap = ArrayListMultimap.create();
multimap.put("day",1);
multimap.put("day",2);
multimap.put("day",8);
multimap.put("month",3);

打印这个Multimap的内容，可以直观的看到每个key对应的都是一个集合：

{month=[3], day=[1, 2, 8]}

1、获取值的集合

在上面的操作中，创建的普通Multimap的get(key)方法将返回一个Collection类型的集合：

Collection<Integer> day = multimap.get("day");

如果在创建时指定为ArrayListMultimap类型，那么get方法将返回一个List：

ArrayListMultimap<String, Integer> multimap = ArrayListMultimap.create();
List<Integer> day = multimap.get("day");

同理，你还可以创建HashMultimap、TreeMultimap等类型的Multimap。

Multimap的get方法会返回一个非null的集合，但是这个集合的内容可能是空，看一下下面的例子：

List<Integer> day = multimap.get("day");
List<Integer> year = multimap.get("year");
System.out.println(day);
System.out.println(year);


//打印结果：
[1, 2, 8]
[]

2、操作get后的集合

和BiMap的使用类似，使用get方法返回的集合也不是一个独立的对象，可以理解为集合视图的关联，对这个新集合的操作仍然会作用于原始的Multimap上，看一下下面的例子：

ArrayListMultimap<String, Integer> multimap = ArrayListMultimap.create();
multimap.put("day",1);
multimap.put("day",2);
multimap.put("day",8);
multimap.put("month",3);

List<Integer> day = multimap.get("day");
List<Integer> month = multimap.get("month");

day.remove(0);//这个0是下标
month.add(12);
System.out.println(multimap);



//查看修改后的结果：
{month=[3, 12], day=[2, 8]}

3、转换为Map

使用asMap方法，可以将Multimap转换为Map<K,Collection>的形式，同样这个Map也可以看做一个关联的视图，在这个Map上的操作会作用于原始的Multimap。

Map<String, Collection<Integer>> map = multimap.asMap();
for (String key : map.keySet()) {
    System.out.println(key+" : "+map.get(key));
}
map.get("day").add(20);
System.out.println(multimap);



//执行结果：
month : [3]
day : [1, 2, 8]
{month=[3], day=[1, 2, 8, 20]}

4、数量问题

Multimap中的数量在使用中也有些容易混淆的地方，先看下面的例子：

System.out.println(multimap.size());
System.out.println(multimap.entries().size());
for (Map.Entry<String, Integer> entry : multimap.entries()) {
    System.out.println(entry.getKey()+","+entry.getValue());
}



//打印结果：
4
4
month,3
day,1
day,2
day,8

这是因为size()方法返回的是所有key到单个value的映射，因此结果为4，entries()方法同理，返回的是key和单个value的键值对集合。但是它的keySet中保存的是不同的key的个数，例如下面这行代码打印的结果就会是2。

System.out.println(multimap.keySet().size());

再看看将它转换为Map后，数量则会发生变化：

Set<Map.Entry<String, Collection<Integer>>> entries = multimap.asMap().entrySet();
System.out.println(entries.size());

代码运行结果是2，因为它得到的是key到Collection的映射关系。

RangeMap - 范围Map

guava中的RangeMap描述了一种从区间到特定值的映射关系，让我们能够以更为优雅的方法来书写代码。下面用RangeMap改造上面的代码并进行测试：

RangeMap<Integer, String> rangeMap = TreeRangeMap.create();
rangeMap.put(Range.closedOpen(0,60),"fail");
rangeMap.put(Range.closed(60,90),"satisfactory");
rangeMap.put(Range.openClosed(90,100),"excellent");

System.out.println(rangeMap.get(59));
System.out.println(rangeMap.get(60));
System.out.println(rangeMap.get(90));
System.out.println(rangeMap.get(91));



//在上面的代码中，先后创建了[0,60)的左闭右开区间、[60,90]的闭区间、(90,100]的左开右闭区间，并分别映射到某个值上。运行结果打印：

fail
satisfactory
satisfactory
excellent

当然我们也可以移除一段空间，下面的代码移除了[70,80]这一闭区间后，再次执行get时返回结果为null：

rangeMap.remove(Range.closed(70,80));
System.out.println(rangeMap.get(75));

ClassToInstanceMap - 实例Map

ClassToInstanceMap是一个比较特殊的Map，它的键是Class，而值是这个Class对应的实例对象。先看一个简单使用的例子，使用putInstance方法存入对象：

ClassToInstanceMap<Object> instanceMap = MutableClassToInstanceMap.create();
User user=new User("Hydra",18);
Dept dept=new Dept("develop",200);

instanceMap.putInstance(User.class,user);
instanceMap.putInstance(Dept.class,dept);



//使用getInstance方法取出对象：

User user1 = instanceMap.getInstance(User.class);
System.out.println(user==user1);

运行结果打印了true，说明了取出的确实是我们之前创建并放入的那个对象。

大家可能会疑问，如果只是存对象的话，像下面这样用普通的Map<Class,Object>也可以实现：

Map<Class,Object> map=new HashMap<>();
User user=new User("Hydra",18);
Dept dept=new Dept("develop",200);
map.put(User.class,user);
map.put(Dept.class,dept);

那么，使用ClassToInstanceMap这种方式有什么好处呢？

首先，这里最明显的就是在取出对象时省去了复杂的强制类型转换，避免了手动进行类型转换的错误。其次，我们可以看一下ClassToInstanceMap接口的定义，它是带有泛型的：

public interface ClassToInstanceMap<B> extends Map<Class<? extends B>, B>{...}

这个泛型同样可以起到对类型进行约束的作用，value要符合key所对应的类型，再看看下面的例子：

ClassToInstanceMap<Map> instanceMap = MutableClassToInstanceMap.create();
HashMap<String, Object> hashMap = new HashMap<>();
TreeMap<String, Object> treeMap = new TreeMap<>();
ArrayList<Object> list = new ArrayList<>();

instanceMap.putInstance(HashMap.class,hashMap);
instanceMap.putInstance(TreeMap.class,treeMap);

这样是可以正常执行的，因为HashMap和TreeMap都集成了Map父类，但是如果想放入其他类型，就会编译报错：

所以，如果你想缓存对象，又不想做复杂的类型校验，那么使用方便的ClassToInstanceMap就可以了。