Guava新集合-Multimap

使用场景

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

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

import com.google.common.collect.ArrayListMultimap;
import com.google.common.collect.Multimap;
import com.google.common.collect.Multiset;
import org.junit.Test;

import java.util.*;

/**
 * @author Kevin
 * @description
 * @date 2016/8/5
 */
public class MultimapTest {

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

    // 普通实现
    @Test
    public void testStudentScore() {
        for (int i = 0; i < 10; i++) {
            StudentScore studentScore = new StudentScore();
            studentScore.courseId = i;
            studentScore.score = 100 - i;
            addStudentScore("Han", studentScore);
        }

        System.out.println("studentScoreMap size = " + studentScoreMap.size());
        System.out.println("studentScoreMap contains Han?  " + studentScoreMap.containsKey("Han"));
    }

    private void addStudentScore(String name, StudentScore studentScore) {
        List<StudentScore> list = studentScoreMap.get(name);
        if (list == null) {
            list = new ArrayList<StudentScore>();
            studentScoreMap.put(name, list);
        }
        list.add(studentScore);
    }

    // guava实现
    @Test
    public void testMultimap() {
        Multimap<String, StudentScore> studentScoreMap = ArrayListMultimap.create();
        for (int i = 0; i < 10; i++) {
            StudentScore studentScore = new StudentScore();
            studentScore.courseId = i;
            studentScore.score = 100 - i;
            studentScoreMap.put("Han", studentScore);
        }

        // size = 10
        System.out.println("studentScoreMap size = " + studentScoreMap.size());
        // true
        System.out.println("studentScoreMap contains Han?  " + studentScoreMap.containsKey("Han"));

        // ====================================================

        Collection<StudentScore> studentScores = studentScoreMap.get("Han");
        StudentScore studentScore = new StudentScore();
        studentScore.courseId = 100;
        studentScore.score = 100;
        studentScores.add(studentScore);
        // size = 11
        System.out.println("studentScoreMap size = " + studentScoreMap.size());

        // 清空数据同时,对应的key也同时删除
        studentScores.clear();
        // size = 0
        System.out.println("studentScoreMap size = " + studentScoreMap.size());
        // false
        System.out.println("studentScoreMap contains Han?  " + studentScoreMap.containsKey("Han"));

        studentScores.add(studentScore);
        Map<String, Collection<StudentScore>> asMap = studentScoreMap.asMap();
        asMap.remove("Han");
        // asMap unsupport put and putAll
        System.out.println("studentScoreMap contains Han?  " + studentScoreMap.containsKey("Han"));

        Collection<Map.Entry<String, StudentScore>> entries = studentScoreMap.entries();
        // entries unsupport add and addAll

        Set<String> keySet = studentScoreMap.keySet();
        // keySet unsupport add and addAll

        Multiset<String> keys = studentScoreMap.keys();
        // keys unsupport add and addAll

        Collection<StudentScore> values = studentScoreMap.values();
        // values unsupport add and addAll
    }
}

class StudentScore {
    int courseId;
    int score;

}

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里的全部值“平展”成一个Collection<V>。这个操做和Iterables.concat(multimap.asMap().values())很类似，只是它返回的是一个完整的Collection。

　　尽管Multimap的实现用到了Map，但Multimap<K, V>不是Map<K, Collection<V>>。由于二者有明显区别：
　　1.Multimap.get(key)必定返回一个非null的集合。但这不表示Multimap使用了内存来关联这些键，相反，返回的集合只是个容许添加元素的视图。
　　2.若是你喜欢像Map那样当不存在键的时候要返回null，而不是Multimap那样返回空集合的话，能够用asMap()返回的视图来获得Map<K, Collection<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()。

Multimap的实现

　　Multimap提供了丰富的实现，因此你能够用它来替代程序里的Map<K, Collection<V>>，具体的实现以下：
　　Implementation                  Keys 的行为相似       　　　Values的行为相似
　　ArrayListMultimap             HashMap                   　　     ArrayList
　　HashMultimap                    HashMap                  　　     HashSet
　　LinkedListMultimap           LinkedHashMap*                  LinkedList*
　　LinkedHashMultimap        LinkedHashMap                   LinkedHashSet
　　TreeMultimap                     TreeMap                                TreeSet
　　ImmutableListMultimap     ImmutableMap                       ImmutableList
　　ImmutableSetMultimap     ImmutableMap                       ImmutableSet

　　以上这些实现，除了immutable的实现都支持null的键和值。
　　1.LinkedListMultimap.entries()能维持迭代时的顺序。

　　2.LinkedHashMultimap维持插入的顺序，以及键的插入顺序。
　　要注意并非全部的实现都正真实现了Map<K, Collection<V>>！（尤为是有些Multimap的实现为了最小话开销，使用了自定义的hash table）