Guava集合--Immutable(不可變)集合

不懶人發表於2020-07-14
Guava

  所謂不可變集合，顧名思義就是定義了之後不可修改的集合。

一.為什麼要使用不可變集合

不可變物件有很多優點，包括：

  • 當物件被不可信的庫呼叫時，不可變形式是安全的；
  • 不可變物件被多個執行緒呼叫時，不存在競態條件問題
  • 不可變集合不需要考慮變化，因此可以節省時間和空間。所有不可變的集合都比它們的可變形式有更好的記憶體利用率（分析和測試細節）；
  • 不可變物件因為有固定不變，可以作為常量來安全使用。

建立物件的不可變拷貝是一項很好的防禦性程式設計技巧。Guava為所有JDK標準集合型別和Guava新集合型別都提供了簡單易用的不可變版本。
 JDK也提供了Collections.unmodifiableXXX方法把集合包裝為不可變形式，但我們認為不夠好：

  • 笨重而且累贅：不能舒適地用在所有想做防禦性拷貝的場景；
  • 不安全：要保證沒人通過原集合的引用進行修改，返回的集合才是事實上不可變的；
  • 低效：包裝過的集合仍然保有可變集合的開銷，比如併發修改的檢查、雜湊表的額外空間，等等。

如果你沒有修改某個集合的需求，或者希望某個集合保持不變時，把它防禦性地拷貝到不可變集合是個很好的實踐。

重要提示：所有Guava不可變集合的實現都不接受null值。我們對Google內部的程式碼庫做過詳細研究，發現只有5%的情況需要在集合中允許null元素，剩下的95%場景都是遇到null值就快速失敗。如果你需要在不可變集合中使用null，請使用JDK中的Collections.unmodifiableXXX方法。更多細節建議請參考“使用和避免null”。

 

二.JDK中實現immutable集合

package collections;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

public class JDKImmutable {

    public static void main(String[] args) {
        List<String> list = new ArrayList<>();
        list.add("a");
        list.add("b");
        list.add("c");

        System.out.println("list：" + list);

        List<String> unmodifiableList = Collections.unmodifiableList(list);
        System.out.println("unmodifiableList：" + unmodifiableList);

        list.add("d");
        System.out.println("list add a item after list:"+list);
        System.out.println("list add a item after unmodifiableList:"+unmodifiableList);

        List<String> unmodifiableList1 = Collections.unmodifiableList(Arrays.asList("a", "b", "c"));
        System.out.println("unmodifiableList1：" + unmodifiableList1);
        unmodifiableList1.add("bb");
        System.out.println("unmodifiableList add a item after list:"+unmodifiableList1);
    }
}

執行結果：

 

 

說明：Collections.unmodifiableList實現的不是真正的不可變集合，當原始集合修改後，不可變集合也發生變化。不可變集合不可以修改集合資料，當強制修改時會報錯，例項中的最後兩個add會直接丟擲不可修改的錯誤。

　　總結一下JDK的Collections.unmodifiableXXX方法實現不可變集合的一些問題：

　　1.它用起來笨拙繁瑣你不得不在每個防禦性程式設計拷貝的地方用這個方法
　　2.它不安全：如果有物件reference原始的被封裝的集合類，這些方法返回的集合也就不是正真的不可改變。
　　3.效率低：因為它返回的資料結構本質仍舊是原來的集合類，所以它的操作開銷，包括併發下修改檢查，hash table裡的額外資料空間都和原來的集合是一樣的。

 

三.如何使用Guava中的不可變集合

　　Guava提供了對JDK裡標準集合類裡的immutable版本的簡單方便的實現，以及Guava自己的一些專門集合類的immutable實現。當你不希望修改一個集合類，或者想做一個常量集合類的時候，使用immutable集合類就是一個最佳的程式設計實踐。

　　Immutable集合使用方法：
　　　　一個immutable集合可以有以下幾種方式來建立：
　　　　1.用copyOf方法, 譬如, ImmutableSet.copyOf(set)
　　　　2.使用of方法，譬如，ImmutableSet.of("a", "b", "c")或者ImmutableMap.of("a", 1, "b", 2)
　　　　3.使用Builder類

　　例子：

package collections;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.ImmutableSortedSet;

import java.awt.*;
import java.util.ArrayList;
import java.util.List;

public class GuavaImmutable  {

    public static void main(String[] args) {
        List<String> list=new ArrayList<String>();
        list.add("a");
        list.add("b");
        list.add("c");
        System.out.println("list："+list);

        ImmutableList<String> imlist=ImmutableList.copyOf(list);
        System.out.println("imlist："+imlist);

        ImmutableList<String> imOflist=ImmutableList.of("peida","jerry","harry");
        System.out.println("imOflist："+imOflist);

        ImmutableSortedSet<String> imSortList=ImmutableSortedSet.of("a", "b", "c", "a", "d", "b");
        System.out.println("imSortList："+imSortList);

        list.add("baby");
        System.out.println("list add a item after list:"+list);
        System.out.println("list add a item after imlist:"+imlist);

        ImmutableSet<Color> imColorSet =
                ImmutableSet.<Color>builder()
                        .add(new Color(0, 255, 255))
                        .add(new Color(0, 191, 255))
                        .build();

        System.out.println("imColorSet:"+imColorSet);
    }
}

　　執行結果：

 

 

比想象中更智慧的copyOf

請注意，ImmutableXXX.copyOf方法會嘗試在安全的時候避免做拷貝——實際的實現細節不詳，但通常來說是很智慧的，比如：

package collections;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.ImmutableSortedSet;

import java.util.ArrayList;
import java.util.List;

public class GuavaImmutableCopyOf {

    public static void main(String[] args) {
        ImmutableSet<String> imSet=ImmutableSet.of("peida","jerry","harry","lisa");
        System.out.println("imSet："+imSet);
        ImmutableList<String> imlist=ImmutableList.copyOf(imSet);
        System.out.println("imlist："+imlist);
        ImmutableSortedSet<String> imSortSet=ImmutableSortedSet.copyOf(imSet);
        System.out.println("imSortSet："+imSortSet);

        List<String> list=new ArrayList<String>();
        for(int i=0;i<20;i++){
            list.add(i+"x");
        }
        System.out.println("list："+list);
        ImmutableList<String> imInfolist=ImmutableList.copyOf(list.subList(2, 18));
        System.out.println("imInfolist："+imInfolist);
        int imInfolistSize=imInfolist.size();
        System.out.println("imInfolistSize："+imInfolistSize);
        ImmutableSet<String> imInfoSet=ImmutableSet.copyOf(imInfolist.subList(2, imInfolistSize-3));
        System.out.println("imInfoSet："+imInfoSet);
    }
}

執行結果：

 

 

ImmutableXXX.copyOf(ImmutableCollection)會試圖對如下情況避免線性時間拷貝：

  • 在常量時間內使用底層資料結構是可能的——例如，ImmutableSet.copyOf(ImmutableList)就不能在常量時間內完成。
  • 不會造成記憶體洩露——例如，你有個很大的不可變集合ImmutableList<String>
    hugeList， ImmutableList.copyOf(hugeList.subList(0, 10))就會顯式地拷貝，以免不必要地持有hugeList的引用。
  • 不改變語義——所以ImmutableSet.copyOf(myImmutableSortedSet)會顯式地拷貝，因為和基於比較器的ImmutableSortedSet相比，ImmutableSet對hashCode()和equals有不同語義。

在可能的情況下避免線性拷貝，可以最大限度地減少防禦性程式設計風格所帶來的效能開銷。

asList檢視

所有不可變集合都有一個asList()方法提供ImmutableList檢視，來幫助你用列表形式方便地讀取集合元素。例如，你可以使用sortedSet.asList().get(k)從ImmutableSortedSet中讀取第k個最小元素。

asList()返回的ImmutableList通常是——並不總是——開銷穩定的檢視實現，而不是簡單地把元素拷貝進List。也就是說，asList返回的列表檢視通常比一般的列表平均效能更好，比如，在底層集合支援的情況下，它總是使用高效的contains方法。

package collections;

import com.google.common.collect.ImmutableSortedSet;

public class GuavaImmutableAsList {

    public static void main(String[] args) {
        ImmutableSortedSet<String> imSortSet=ImmutableSortedSet.of("aa","bb","cc","dd","ee");
        System.out.println(imSortSet.asList().get(2));
    }
}

執行結果：

 

 

Guava集合和不可變對應關係

可變集合介面 屬於JDK還是Guava 不可變版本
Collection JDK ImmutableCollection
List JDK ImmutableList
Set JDK ImmutableSet
SortedSet/NavigableSet JDK ImmutableSortedSet
Map JDK ImmutableMap
SortedMap JDK ImmutableSortedMap
Multiset Guava ImmutableMultiset
SortedMultiset Guava ImmutableSortedMultiset
Multimap Guava ImmutableMultimap
ListMultimap Guava ImmutableListMultimap
SetMultimap Guava ImmutableSetMultimap
BiMap Guava ImmutableBiMap
ClassToInstanceMap Guava ImmutableClassToInstanceMap
Table Guava ImmutableTable

相關文章