Guava使用之MultiMap

在日常的开发工作中，我们有的时候需要构造像Map<K, List<V>>或者Map<K, Set<V>>这样比较复杂的集合类型的数据结构，以便做相应的业务逻辑处理。例如：

private class  StudentScore{
    int CourseId;
    int score;
}

private Map<String, List<StudentScore>> StudentScoreMap = new HashMap<String, List<StudentScore>>();

@Test
public void multimapDemo(){


    for(int i=10;i<20;i++){
        StudentScore studentScore=new StudentScore();
        studentScore.CourseId=1001+i;
        studentScore.score=100-i;
        addStudentScore("peida",studentScore);
    }

    System.out.println("StudentScoreMap:"+StudentScoreMap.size());
    System.out.println("StudentScoreMap:"+StudentScoreMap.containsKey("peida"));

    System.out.println("StudentScoreMap:"+StudentScoreMap.containsKey("jerry"));
    System.out.println("StudentScoreMap:"+StudentScoreMap.size());
    System.out.println("StudentScoreMap:"+StudentScoreMap.get("peida").size());

    List<StudentScore> StudentScoreList=StudentScoreMap.get("peida");
    if(StudentScoreList!=null&&StudentScoreList.size()>0){
        for(StudentScore stuScore:StudentScoreList){
            System.out.println("stuScore one:"+stuScore.CourseId+" score:"+stuScore.score);
        }
    }
}

private void addStudentScore(final String stuName,final StudentScore studentScore) {
    List<StudentScore> stuScore = StudentScoreMap.get(stuName);
    if (stuScore == null) {
        stuScore = new ArrayList<StudentScore>();
        StudentScoreMap.put(stuName, stuScore);
    }
    stuScore.add(studentScore);
}

说明：想 Map<String, List<StudentScore>> StudentScoreMap = new HashMap<String, <StudentScore>>()这样的数据结构，自己实现起来太麻烦，你需要检查key是否存在，不存在时则创建一个，存在时在List后面添加上一个。这个过程是比较痛苦的，如果你希望检查List中的对象是否存在，删除一个对象，或者遍历整个数据结构，那么则需要更多的代码来实现。

Guava的Multimap就提供了一个方便地把一个键对应到多个值的数据结构。让我们可以简单优雅的实现上面复杂的数据结构，让我们的精力和时间放在实现业务逻辑上，而不是在数据结构上，下面我们具体来看看Multimap的相关知识点。

上面的代码和数据结构用Multimap来实现，代码结构清晰简单了很多吧，具体代码如下：

@Test
public void testStuScoreMultimap(){
    Multimap<String,StudentScore> scoreMultimap = ArrayListMultimap.create();
    for(int i=10;i<20;i++){
        StudentScore studentScore=new StudentScore();
        studentScore.CourseId=1001+i;
        studentScore.score=100-i;
        scoreMultimap.put("peida",studentScore);
    }
    System.out.println("scoreMultimap:"+scoreMultimap.size());
    System.out.println("scoreMultimap:"+scoreMultimap.keys());
}

调用Multimap.get(key)会返回这个键对应的值的集合的视图（view），没有对应集合就返回空集合。对于ListMultimap来说，这个方法会返回一个List，对于SetMultimap来说，这个方法就返回一个Set。修改数据是通过修改底层Multimap来实现的。例如：

@Test
public void teststuScoreMultimap(){
    Multimap<String,StudentScore> scoreMultimap = ArrayListMultimap.create();
    for(int i=10;i<20;i++){
        StudentScore studentScore=new StudentScore();
        studentScore.CourseId=1001+i;
        studentScore.score=100-i;
        scoreMultimap.put("peida",studentScore);
    }
    System.out.println("scoreMultimap:"+scoreMultimap.size());
    System.out.println("scoreMultimap:"+scoreMultimap.keys());

    Collection<StudentScore> studentScore = scoreMultimap.get("peida");
    studentScore.clear();
    StudentScore studentScoreNew=new StudentScore();
    studentScoreNew.CourseId=1034;
    studentScoreNew.score=67;
    studentScore.add(studentScoreNew);

    System.out.println("scoreMultimap:"+scoreMultimap.size());
    System.out.println("scoreMultimap:"+scoreMultimap.keys());
}

Multimap也支持一系列强大的视图功能：

1. asMap把自身Multimap<K, V>映射成Map<K, Collection<V>>视图。这个Map视图支持remove和修改操作，但是不支持put和putAll。严格地来讲，当你希望传入参数是不存在的key，而且你希望返回的是null而不是一个空的可修改的集合的时候就可以调用asMap().get(key)。

   你可以强制转型asMap().get(key)的结果类型
   －对SetMultimap的结果转成Set，对ListMultimap的结果转成List型
   －但是直接把ListMultimap转成Map<K, List<V>>是不行的。

2. entries视图是把Multimap里所有的键值对以Collection<Map.Entry<K, V>>的形式展现。

3. keySet视图是把Multimap的键集合作为视图
4. keys视图返回的是个Multiset，这个Multiset是以不重复的键对应的个数作为视图。这个Multiset可以通过支持移除操作而不是添加操作来修改Multimap。
5. values()视图能把Multimap里的所有值“平展”成一个<V>。这个操作和Iterables.concat(multimap.asMap().values())很相似，只是它返回的是一个完整的Collection。

尽管Multimap的实现用到了Map，但Multimap<K, V>不是<K, Collection<V>>。因为两者有明显区别：

1. Multimap.get(key)一定返回一个非null的集合。但这不表示Multimap使用了内存来关联这些键，相反，返回的集合只是个允许添加元素的视图。
2. 如果你喜欢像Map那样当不存在键的时候要返回null，而不是Multimap那样返回空集合的话，可以用asMap()返回的视图来得到<K, <V>>。（这种情况下，你得把返回的Collection<V>强转型为List或Set）。
3. Multimap.containsKey(key)只有在这个键存在的时候才返回true。
4. Multimap.entries()返回的是Multimap所有的键值对。但是如果需要key-collection的键值对，那就得用asMap().entries()。
5. Multimap.size()返回的是entries的数量，而不是不重复键的数量。如果要得到不重复键的数目就得用Multimap.keySet().size()。