Guava學習筆記：Guava新增集合類型-Multimap

　　在日常的開發工作中，我們有的時候需要構造像Map<K, List<V>>或者Map<K, Set<V>>這樣比較復雜的集合類型的數據結構，以便做相應的業務邏輯處理。例如：

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.junit.Test;

public class MultimapTest {

    Map<String, List<StudentScore>> StudentScoreMap = new HashMap<String, List<StudentScore>>();
    
    @Test
    public void testStudentScore(){
        
        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);
            }
        }
    }
    
    public 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);
    }
}

class StudentScore{
    int CourseId;
    int score;
}

　　說明：想 Map<String, List<StudentScore>> StudentScoreMap = new HashMap<String, List<StudentScore>>()這樣的數據結構，自己實現起來太麻煩，你需要檢查key是否存在，不存在時則創建一個，存在時在List后面添加上一個。這個過程是比較痛苦的，如果你希望檢查List中的對象是否存在，刪除一個對象，或者遍歷整個數據結構，那么則需要更多的代碼來實現。

　　Multimap

　　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里的所有值“平展”成一個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()。

　　@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 studentScore1=new StudentScore();
        studentScore1.CourseId=1034;
        studentScore1.score=67;
        studentScore.add(studentScore1);
        
        StudentScore studentScore2=new StudentScore();
        studentScore2.CourseId=1045;
        studentScore2.score=56;
        scoreMultimap.put("jerry",studentScore2);
        
        System.out.println("scoreMultimap:"+scoreMultimap.size());
        System.out.println("scoreMultimap:"+scoreMultimap.keys());
        
        
        for(StudentScore stuScore : scoreMultimap.values()) {
            System.out.println("stuScore one:"+stuScore.CourseId+" score:"+stuScore.score);
        }
        
        scoreMultimap.remove("jerry",studentScore2); 
        System.out.println("scoreMultimap:"+scoreMultimap.size());
        System.out.println("scoreMultimap:"+scoreMultimap.get("jerry"));
        
        scoreMultimap.put("harry",studentScore2);
        scoreMultimap.removeAll("harry");
        System.out.println("scoreMultimap:"+scoreMultimap.size());
        System.out.println("scoreMultimap:"+scoreMultimap.get("harry"));
    }

　　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）