编程中list我们所踩过的坑

本文设计的知识点如下：

一、arraylist不支持增加和删除？what?

用ArrayList所遇到的坑：先看一段简单的代码

String[] arrays = {"1","2","3"};
List<String> list = Arrays.asList(arrays);
list.add("other element");

这段代码表面上看是没有什么问题的，编译也能通过，但在测试时候就会抛出UnsupportedOperationException

刚开始很不解，Arrays#asList 返回明明也是一个 ArrayList，为什么添加一个元素就会报错？这以后还能好好新增元素吗？

答：最后通过 Debug 才发现这个Arrays#asList 返回的 ArrayList 其实是个假集合，仅仅只是 Arrays 一个内部类，并非真正的java.util.ArrayList。

那么这又是为什么呢？

add/remove 等方法实际都来自 AbstractList，而 java.util.Arrays$ArrayList 并没有重写父类的方法。而父类方法恰恰都会抛出 UnsupportedOperationException。这就是采用Arrays变换后的集合不支持add/remove的真正原因

二、我改了这个list,原来的list怎么变了呢

除了不支持增删操作这个坑以外，还存在另外一个大坑，改动内部元素将会同步影响原数组。

String[] arrays = {"1","2","3"};
List<String> list = Arrays.asList(arrays);
list.set(0,"modify_1");
arrays[1]="modify_2";
System.out.println("arrays:"+Arrays.toString(arrays));
System.out.println("list:"+list);
//输出结果:
//arrays:[modify_1,modify_2,3];
//list:[modify_1,modify_2,3];

从日志输出可以看到，不管我们是修改原数组，还是新 List 集合，两者都会互相影响。
查看 java.util.Arrays$ArrayList 实现，我们可以发现底层实际使用了原始数组。
修复的办法也很简单，套娃一层 ArrayList 呗！

List<String> list = new ArrayList<>(Arrays.asList(arrays));

不过我们也可以用Guava（Java）Lists提供的方法
List<String> list = Lists.newArrayList(arrays);

通过上面两种方式，我们将新的list和原始的list进行解耦，不再互相影响，同时也不会再担心add/remove会报错了

三、说好的不可变，你怎么就变了呢

为了防止 List 集合被误操作，我们可以使用 Collections#unmodifiableList 生成一个不可变（immutable）集合，进行防御性编程。

这个不可变集合只能被读取，不能做任何修改，包括增加，删除，修改，从而保护不可变集合的安全。

//不可变集合添加元素
List<String> list = new ArrayList<(Arrays.asList("one","two","three"));
List<String> unmodifiableList = Collections.unmodifiableList(list);
//以下都将抛出 UnsupportedOperationException
unmodifiableList.add("four");
unmodifiableList.remove(1);
unmodifiableList.set(0,"test");

上面最后三行写操作都将会抛出 UnsupportedOperationException 异常
但是你以为这样就安全了吗？

如果有谁不小心改动原始 List，你就会发现这个不可变集合，竟然就变了。。。

List<String> list = new ArrayList<(Arrays.asList("one","two","three"));
List<String> unmodifiableList = Collections.unmodifiableList(list);
//测试修改源集合元素是否会影响不可变集合
list.set(0,"modify_one");
//以下测试都会通过
Assertions.assertEquals(list.get(0),unmodifiableList.get(0));
//测试增加元素
list.add("four");
//以下测试都会通过
Assertions.assertEquals(list.get(3),unmodifiableList.get(3));
Assertions.assertEquals(list.size(),unmodifiableList.size());

上面单元测试结果将会全部通过，这就代表 Collections#unmodifiableList 产生不可变集合将会被原始 List 所影响。

这跟上面 SubList 其实是同一个问题，新集合底层实际使用了原始 List。
由于不可变集合所有修改操作都会报错，所以不可变集合不会产生任何改动，所以并不影响的原始集合。但是防过来，却不行，原始 List 随时都有可能被改动，从而影响不可变集合。
可以使用如下两种方式防止上卖弄的情况。

使用 JDK9 List#of 方法。

List<String> list = new ArrayList<>(Arrays.asList("one", "two", "three"));
List<String> unmodifiableList = List.of(list.toArray(new String[]{}));

使用 Guava immutable list

List<String> list = new ArrayList<>(Arrays.asList("one", "two", "three"));
List<String> unmodifiableList = ImmutableList.copyOf(list);

相比而言 Guava 方式比较清爽，使用也比较简单，推荐使用 Guava 这种方式生成不可变集合。

四、foreach 增加/删除元素大坑

String arrays = {"1","2","3"};
List<String> list = new ArrayList<>(Arrays.asList(arrays));
for(String str : list){
	if(str.equals("1")){
		list.remove(str);
	}
}

上面的代码我们从list集合中删除“1”，这个程序在编译时是没有问题的，但是运行时就会发生异常，日志如下

java.util.ConcurrentModificationException
	at java.base/java.util.ArrayList$Itr.checkForComodification(ArrayList.java:939)
	at java.base/java.util.ArrayList$Itr.next(ArrayList.java:893)

可以看到程序最终错误是由 ArrayList$Itr.next 处的代码抛出，但是代码中我们并没有调用该方法，为什么会这样?

foreach 这种方式实际就是 Iterator 迭代器实现方式，这就是为什么 foreach 被遍历的类需要实现 Iterator接口的原因。

接着我们来看下抛出异常方法：

expectedModCount 来源于 list#iterator 方法：

ArrayList#remove 之后将会使 modCount 加一，expectedModCount与 modCount将会不相等，这就导致迭代器遍历时将会抛错。

那么我们该如何删除list集合中的元素呢？这里推荐两种方法

使用Iterator#remove删除元素

JDK1.8 List#removeIf

五、总结

第一，我们不要先入为主，想当然就认为 Arrays.asList 和 List.subList 就是一个普通，独立的 ArrayList。

如果没办法，使用了 Arrays.asList 和 List.subList ，返回给其他方法的时候，一定要记得再套娃一层真正的 java.util.ArrayList。

第二 JDK 的提供的不可变集合实际非常笨重，并且低效，还不安全，所以推荐使用 Guava 不可变集合代替。

最后，切记，不要随便在 foreach增加/删除元素。