跟着 Guava 学 Java 之不可变集合

2023-02-28

list add jdk

什么是不可变集合不可变集合，英文叫immutable，顾名思义就是说集合是不可被修改的。集合的数据项是在创建的时候提供，并且在整个生命周期中都不可改变。为什么要用不可变集合？第一：防御性编程需要我有一个集合，你拿来使用，鬼知道你会不会乱搞，往集合里添加不合适的元素，或者随便删除元素，我不放心，对，就

什么是不可变集合

不可变集合，英文叫 immutable，顾名思义就是说集合是不可被修改的。集合的数据项是在创建的时候提供，并且在整个生命周期中都不可改变。

为什么要用不可变集合？

第一：防御性编程需要

我有一个集合，你拿来使用，鬼知道你会不会乱搞，往集合里添加不合适的元素，或者随便删除元素，我不放心，对，就是不信你，我的集合我做主，给你个不可变的吧，这样你就不可能乱搞我的集合了，我就放心了，不担心你的操作给我带来风险。官方解释：防御，defensive programming，听起来高级不？

第二：线程安全

没有买卖就没有杀害！

集合是不可变的，不让你有变化，不可能有变化。没有变化，就没有竞态条件，多少个线程来都是一个样，安全，就是***安全。

第三：节省开销

不需要支持可变性，可以尽量节省空间和时间的开销，所有的不可变集合实现都比可变集合更加有效的利用内存。

JDK9 之前的实现

Collections提供了一组方法把可变集合封装成不可变集合：

但这玩意儿有问题，举个例子：

List<String> list = new ArrayList<String>();
  list.add("a");
  list.add("b");
  list.add("c");
  
  List<String> unmodifiableList = Collections.unmodifiableList(list);
  list.add("d");
  System.out.println(unmodifiableList);1.
2.
3.
4.
5.
6.
7.
8.

这个输出的结果居然是 [a,b,c,d]。

what ? 这不就变了吗，我要的是不可变集合啊，这坑爹的玩意儿。有兄弟说了，那我切断 list 的引用是不就行了？

List<String> list = new ArrayList<String>();
  list.add("a");
  list.add("b");
  list.add("c");
  
  List<String> unmodifiableList = Collections.unmodifiableList(list);
  list.add("d");
  list = null;
  System.out.println(unmodifiableList);1.
2.
3.
4.
5.
6.
7.
8.
9.

呵呵，不行，输出仍然是 [a,b,c,d] 果然坑爹，而且你发现没有，编码也比较麻烦，还得用 Collections 间接转一下。

Collections.unmodifiableList 实现的不是真正的不可变集合，当原始集合修改后，不可变集合也发生变化。此外，它返回的数据结构本质仍旧是原来的集合类，所以它的操作开销，包括并发下修改检查，hash table 里的额外数据空间都和原来的集合是一样的。

由于这些问题，JDK9 出了些新的生成不可变集合的方法，比如：

List.of
Set.of
Map.of
......

确实可以直接生成不可变集合，编码也比较方便了：

List<String> immutableList= List.of("a", "b", "c");1.

如果你要修改集合会抛出异常 java.lang.UnsupportedOperationException：

immutableList.add("d");1.

but；

List<String> list = new ArrayList<String>();
  list.add("a");
  list.add("b");
  list.add("c");

  List<List<String>> list1 = List.of(list);
  list.add("d");
  System.out.println(list1);1.
2.
3.
4.
5.
6.
7.
8.

上面代码的输出仍然是 : [a,b,c,d]；

当然我们不是说人家 api 是错的，人家就是这么设计的（爱信不信），可我感觉不爽，如果不小心可能会犯错，本来是防御性编程，搞不好干成跑路性编程了。

再次强调，不是说人家 JDK 设计错了，人家就是这么设计的，你的明白？当然不爽的还有 google 的工程师们，所以我们下面介绍下拿起键盘自己解决问题的 google 工程师们写的 guava 是怎么解决问题的。

Guava

来，我们接着上面的那个例子，直接写个 Guava 版本的你自己体会下：

List<String> list = new ArrayList<String>();
  list.add("a");
  list.add("b");
  list.add("c");

  ImmutableList<String> strings = ImmutableList.copyOf(list);
  list.add("d");

  System.out.println(strings);1.
2.
3.
4.
5.
6.
7.
8.
9.

输出终于如我所愿的是 : [a,b,c] 了。

无论是从命名、语义、结果、代码可读性是不是都比 JDK 版本的好很多？这样的代码让我感觉世界又美好了一些。

美好的东西都想拥有，但问题来了， 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

介绍几个方法：

of 方法，用法是一脉相承的，就是构建集合用的
copyOf ，上面例子中出现过，官方文档上说它是智能的，比如它可以判断参数是不是一个 immutable 对象，这样可以避免做拷贝

JDK10

List<String> list = new ArrayList<String>();
  list.add("a");
  list.add("b");
  list.add("c");

  List<String> strings = List.copyOf(list);

  list.add("d");
  System.out.println(strings);1.
2.
3.
4.
5.
6.
7.
8.
9.