You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

560 lines
26 KiB
Markdown

2 years ago
# 10 | 集合类坑满地的List列表操作
你好我是朱晔。今天我来和你说说List列表操作有哪些坑。
Pascal之父尼克劳斯 · 维尔特Niklaus Wirth曾提出一个著名公式“程序=数据结构+算法”。由此可见数据结构的重要性。常见的数据结构包括List、Set、Map、Queue、Tree、Graph、Stack等其中List、Set、Map、Queue可以从广义上统称为集合类数据结构。
现代编程语言一般都会提供各种数据结构的实现供我们开箱即用。Java也是一样比如提供了集合类的各种实现。Java的集合类包括Map和Collection两大类。Collection包括List、Set和Queue三个小类其中List列表集合是最重要也是所有业务代码都会用到的。所以今天我会重点介绍List的内容而不会集中介绍Map以及Collection中其他小类的坑。
今天我们就从把数组转换为List集合、对List进行切片操作、List搜索的性能问题等几个方面着手来聊聊其中最可能遇到的一些坑。
## 使用Arrays.asList把数据转换为List的三个坑
Java 8中Stream流式处理的各种功能大大减少了集合类各种操作投影、过滤、转换的代码量。所以在业务开发中我们常常会把原始的数组转换为List类数据结构来继续展开各种Stream操作。
你可能也想到了使用Arrays.asList方法可以把数组一键转换为List但其实没这么简单。接下来就让我们看看其中的缘由以及使用Arrays.asList把数组转换为List的几个坑。
在如下代码中我们初始化三个数字的int\[\]数组然后使用Arrays.asList把数组转换为List
```
int[] arr = {1, 2, 3};
List list = Arrays.asList(arr);
log.info("list:{} size:{} class:{}", list, list.size(), list.get(0).getClass());
```
这样初始化的List并不是我们期望的包含3个数字的List。通过日志可以发现这个List包含的其实是一个int数组整个List的元素个数是1元素类型是整数数组。
```
12:50:39.445 [main] INFO org.geekbang.time.commonmistakes.collection.aslist.AsListApplication - list:[[I@1c53fd30] size:1 class:class [I
```
其原因是只能是把int装箱为Integer不可能把int数组装箱为Integer数组。我们知道Arrays.asList方法传入的是一个泛型T类型可变参数最终int数组整体作为了一个对象成为了泛型类型T
```
public static <T> List<T> asList(T... a) {
return new ArrayList<>(a);
}
```
直接遍历这样的List必然会出现Bug修复方式有两种如果使用Java8以上版本可以使用Arrays.stream方法来转换否则可以把int数组声明为包装类型Integer数组
```
int[] arr1 = {1, 2, 3};
List list1 = Arrays.stream(arr1).boxed().collect(Collectors.toList());
log.info("list:{} size:{} class:{}", list1, list1.size(), list1.get(0).getClass());
Integer[] arr2 = {1, 2, 3};
List list2 = Arrays.asList(arr2);
log.info("list:{} size:{} class:{}", list2, list2.size(), list2.get(0).getClass());
```
修复后的代码得到如下日志可以看到List具有三个元素元素类型是Integer
```
13:10:57.373 [main] INFO org.geekbang.time.commonmistakes.collection.aslist.AsListApplication - list:[1, 2, 3] size:3 class:class java.lang.Integer
```
可以看到第一个坑是,**不能直接使用Arrays.asList来转换基本类型数组**。那么我们获得了正确的List是不是就可以像普通的List那样使用了呢我们继续往下看。
把三个字符串1、2、3构成的字符串数组使用Arrays.asList转换为List后将原始字符串数组的第二个字符修改为4然后为List增加一个字符串5最后数组和List会是怎样呢
```
String[] arr = {"1", "2", "3"};
List list = Arrays.asList(arr);
arr[1] = "4";
try {
list.add("5");
} catch (Exception ex) {
ex.printStackTrace();
}
log.info("arr:{} list:{}", Arrays.toString(arr), list);
```
可以看到日志里有一个UnsupportedOperationException为List新增字符串5的操作失败了而且把原始数组的第二个元素从2修改为4后asList获得的List中的第二个元素也被修改为4了
```
java.lang.UnsupportedOperationException
at java.util.AbstractList.add(AbstractList.java:148)
at java.util.AbstractList.add(AbstractList.java:108)
at org.geekbang.time.commonmistakes.collection.aslist.AsListApplication.wrong2(AsListApplication.java:41)
at org.geekbang.time.commonmistakes.collection.aslist.AsListApplication.main(AsListApplication.java:15)
13:15:34.699 [main] INFO org.geekbang.time.commonmistakes.collection.aslist.AsListApplication - arr:[1, 4, 3] list:[1, 4, 3]
```
这里,又引出了两个坑。
第二个坑,**Arrays.asList返回的List不支持增删操作。**Arrays.asList返回的List并不是我们期望的java.util.ArrayList而是Arrays的内部类ArrayList。ArrayList内部类继承自AbstractList类并没有覆写父类的add方法而父类中add方法的实现就是抛出UnsupportedOperationException。相关源码如下所示
```
public static <T> List<T> asList(T... a) {
return new ArrayList<>(a);
}
private static class ArrayList<E> extends AbstractList<E>
implements RandomAccess, java.io.Serializable
{
private final E[] a;
ArrayList(E[] array) {
a = Objects.requireNonNull(array);
}
...
@Override
public E set(int index, E element) {
E oldValue = a[index];
a[index] = element;
return oldValue;
}
...
}
public abstract class AbstractList<E> extends AbstractCollection<E> implements List<E> {
...
public void add(int index, E element) {
throw new UnsupportedOperationException();
}
}
```
第三个坑,**对原始数组的修改会影响到我们获得的那个List**。看一下ArrayList的实现可以发现ArrayList其实是直接使用了原始的数组。所以我们要特别小心把通过Arrays.asList获得的List交给其他方法处理很容易因为共享了数组相互修改产生Bug。
修复方式比较简单重新new一个ArrayList初始化Arrays.asList返回的List即可
```
String[] arr = {"1", "2", "3"};
List list = new ArrayList(Arrays.asList(arr));
arr[1] = "4";
try {
list.add("5");
} catch (Exception ex) {
ex.printStackTrace();
}
log.info("arr:{} list:{}", Arrays.toString(arr), list);
```
修改后的代码实现了原始数组和List的“解耦”不再相互影响。同时因为操作的是真正的ArrayListadd也不再出错
```
13:34:50.829 [main] INFO org.geekbang.time.commonmistakes.collection.aslist.AsListApplication - arr:[1, 4, 3] list:[1, 2, 3, 5]
```
## 使用List.subList进行切片操作居然会导致OOM
业务开发时常常要对List做切片处理即取出其中部分元素构成一个新的List我们通常会想到使用List.subList方法。但和Arrays.asList的问题类似List.subList返回的子List不是一个普通的ArrayList。这个子List可以认为是原始List的视图会和原始List相互影响。如果不注意很可能会因此产生OOM问题。接下来我们就一起分析下其中的坑。
如下代码所示定义一个名为data的静态List来存放Integer的List也就是说data的成员本身是包含了多个数字的List。循环1000次每次都从一个具有10万个Integer的List中使用subList方法获得一个只包含一个数字的子List并把这个子List加入data变量
```
private static List<List<Integer>> data = new ArrayList<>();
private static void oom() {
for (int i = 0; i < 1000; i++) {
List<Integer> rawList = IntStream.rangeClosed(1, 100000).boxed().collect(Collectors.toList());
data.add(rawList.subList(0, 1));
}
}
```
你可能会觉得这个data变量里面最终保存的只是1000个具有1个元素的List不会占用很大空间但程序运行不久就出现了OOM
```
Exception in thread "main" java.lang.OutOfMemoryError: Java heap space
at java.util.Arrays.copyOf(Arrays.java:3181)
at java.util.ArrayList.grow(ArrayList.java:265)
```
**出现OOM的原因是循环中的1000个具有10万个元素的List始终得不到回收因为它始终被subList方法返回的List强引用。**那么返回的子List为什么会强引用原始的List它们又有什么关系呢我们再继续做实验观察一下这个子List的特性。
首先初始化一个包含数字1到10的ArrayList然后通过调用subList方法取出2、3、4随后删除这个SubList中的元素数字3并打印原始的ArrayList最后为原始的ArrayList增加一个元素数字0遍历SubList输出所有元素
```
List<Integer> list = IntStream.rangeClosed(1, 10).boxed().collect(Collectors.toList());
List<Integer> subList = list.subList(1, 4);
System.out.println(subList);
subList.remove(1);
System.out.println(list);
list.add(0);
try {
subList.forEach(System.out::println);
} catch (Exception ex) {
ex.printStackTrace();
}
```
代码运行后得到如下输出:
```
[2, 3, 4]
[1, 2, 4, 5, 6, 7, 8, 9, 10]
java.util.ConcurrentModificationException
at java.util.ArrayList$SubList.checkForComodification(ArrayList.java:1239)
at java.util.ArrayList$SubList.listIterator(ArrayList.java:1099)
at java.util.AbstractList.listIterator(AbstractList.java:299)
at java.util.ArrayList$SubList.iterator(ArrayList.java:1095)
at java.lang.Iterable.forEach(Iterable.java:74)
```
可以看到两个现象:
* 原始List中数字3被删除了说明删除子List中的元素影响到了原始List
* 尝试为原始List增加数字0之后再遍历子List会出现ConcurrentModificationException。
我们分析下ArrayList的源码看看为什么会是这样。
```
public class ArrayList<E> extends AbstractList<E>
implements List<E>, RandomAccess, Cloneable, java.io.Serializable
{
protected transient int modCount = 0;
private void ensureExplicitCapacity(int minCapacity) {
modCount++;
// overflow-conscious code
if (minCapacity - elementData.length > 0)
grow(minCapacity);
}
public void add(int index, E element) {
rangeCheckForAdd(index);
ensureCapacityInternal(size + 1); // Increments modCount!!
System.arraycopy(elementData, index, elementData, index + 1,
size - index);
elementData[index] = element;
size++;
}
public List<E> subList(int fromIndex, int toIndex) {
subListRangeCheck(fromIndex, toIndex, size);
return new SubList(this, offset, fromIndex, toIndex);
}
private class SubList extends AbstractList<E> implements RandomAccess {
private final AbstractList<E> parent;
private final int parentOffset;
private final int offset;
int size;
SubList(AbstractList<E> parent,
int offset, int fromIndex, int toIndex) {
this.parent = parent;
this.parentOffset = fromIndex;
this.offset = offset + fromIndex;
this.size = toIndex - fromIndex;
this.modCount = ArrayList.this.modCount;
}
public E set(int index, E element) {
rangeCheck(index);
checkForComodification();
return l.set(index+offset, element);
}
public ListIterator<E> listIterator(final int index) {
checkForComodification();
...
}
private void checkForComodification() {
if (ArrayList.this.modCount != this.modCount)
throw new ConcurrentModificationException();
}
...
}
}
```
第一ArrayList维护了一个叫作modCount的字段表示集合结构性修改的次数。所谓结构性修改指的是影响List大小的修改所以add操作必然会改变modCount的值。
第二分析第21到24行的subList方法可以看到获得的List其实是**内部类SubList**并不是普通的ArrayList在初始化的时候传入了this。
第三分析第26到39行代码可以发现这个SubList中的parent字段就是原始的List。SubList初始化的时候并没有把原始List中的元素复制到独立的变量中保存。我们可以认为SubList是原始List的视图并不是独立的List。双方对元素的修改会相互影响而且SubList强引用了原始的List所以大量保存这样的SubList会导致OOM。
第四分析第47到55行代码可以发现遍历SubList的时候会先获得迭代器比较原始ArrayList modCount的值和SubList当前modCount的值。获得了SubList后我们为原始List新增了一个元素修改了其modCount所以判等失败抛出ConcurrentModificationException异常。
既然SubList相当于原始List的视图那么避免相互影响的修复方式有两种
* 一种是不直接使用subList方法返回的SubList而是重新使用new ArrayList在构造方法传入SubList来构建一个独立的ArrayList
* 另一种是对于Java 8使用Stream的skip和limit API来跳过流中的元素以及限制流中元素的个数同样可以达到SubList切片的目的。
```
//方式一:
List<Integer> subList = new ArrayList<>(list.subList(1, 4));
//方式二:
List<Integer> subList = list.stream().skip(1).limit(3).collect(Collectors.toList());
```
修复后代码输出如下:
```
[2, 3, 4]
[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
2
4
```
可以看到删除SubList的元素不再影响原始List而对原始List的修改也不会再出现List迭代异常。
## 一定要让合适的数据结构做合适的事情
在介绍[并发工具](https://time.geekbang.org/column/article/209494)时我提到要根据业务场景选择合适的并发工具或容器。在使用List集合类的时候不注意使用场景也会遇见两个常见误区。
**第一个误区是,使用数据结构不考虑平衡时间和空间**。
首先定义一个只有一个int类型订单号字段的Order类
```
@Data
@NoArgsConstructor
@AllArgsConstructor
static class Order {
private int orderId;
}
```
然后定义一个包含elementCount和loopCount两个参数的listSearch方法初始化一个具有elementCount个订单对象的ArrayList循环loopCount次搜索这个ArrayList每次随机搜索一个订单号
```
private static Object listSearch(int elementCount, int loopCount) {
List<Order> list = IntStream.rangeClosed(1, elementCount).mapToObj(i -> new Order(i)).collect(Collectors.toList());
IntStream.rangeClosed(1, loopCount).forEach(i -> {
int search = ThreadLocalRandom.current().nextInt(elementCount);
Order result = list.stream().filter(order -> order.getOrderId() == search).findFirst().orElse(null);
Assert.assertTrue(result != null && result.getOrderId() == search);
});
return list;
}
```
随后定义另一个mapSearch方法从一个具有elementCount个元素的Map中循环loopCount次查找随机订单号。Map的Key是订单号Value是订单对象
```
private static Object mapSearch(int elementCount, int loopCount) {
Map<Integer, Order> map = IntStream.rangeClosed(1, elementCount).boxed().collect(Collectors.toMap(Function.identity(), i -> new Order(i)));
IntStream.rangeClosed(1, loopCount).forEach(i -> {
int search = ThreadLocalRandom.current().nextInt(elementCount);
Order result = map.get(search);
Assert.assertTrue(result != null && result.getOrderId() == search);
});
return map;
}
```
我们知道搜索ArrayList的时间复杂度是O(n)而HashMap的get操作的时间复杂度是O(1)。**所以要对大List进行单值搜索的话可以考虑使用HashMap其中Key是要搜索的值Value是原始对象会比使用ArrayList有非常明显的性能优势。**
如下代码所示对100万个元素的ArrayList和HashMap分别调用listSearch和mapSearch方法进行1000次搜索
```
int elementCount = 1000000;
int loopCount = 1000;
StopWatch stopWatch = new StopWatch();
stopWatch.start("listSearch");
Object list = listSearch(elementCount, loopCount);
System.out.println(ObjectSizeCalculator.getObjectSize(list));
stopWatch.stop();
stopWatch.start("mapSearch");
Object map = mapSearch(elementCount, loopCount);
stopWatch.stop();
System.out.println(ObjectSizeCalculator.getObjectSize(map));
System.out.println(stopWatch.prettyPrint());
```
可以看到仅仅是1000次搜索listSearch方法耗时3.3秒而mapSearch耗时仅仅108毫秒。
```
20861992
72388672
StopWatch '': running time = 3506699764 ns
---------------------------------------------
ns % Task name
---------------------------------------------
3398413176 097% listSearch
108286588 003% mapSearch
```
即使我们要搜索的不是单值而是条件区间也可以尝试使用HashMap来进行“搜索性能优化”。如果你的条件区间是固定的话可以提前把HashMap按照条件区间进行分组Key就是不同的区间。
的确如果业务代码中有频繁的大ArrayList搜索使用HashMap性能会好很多。类似如果要对大ArrayList进行去重操作也不建议使用contains方法而是可以考虑使用HashSet进行去重。说到这里还有一个问题使用HashMap是否会牺牲空间呢
为此我们使用ObjectSizeCalculator工具打印ArrayList和HashMap的内存占用可以看到ArrayList占用内存21M而HashMap占用的内存达到了72M是List的三倍多。进一步使用MAT工具分析堆可以再次证明ArrayList在内存占用上性价比很高77%是实际的数据如第1个图所示16000000/20861992**而HashMap的“含金量”只有22%**如第2个图所示16000000/72386640
![](https://static001.geekbang.org/resource/image/1e/24/1e8492040dd4b1af6114a6eeba06e524.png)
![](https://static001.geekbang.org/resource/image/53/c7/53d53e3ce2efcb081f8d9fa496cb8ec7.png)
所以,在应用内存吃紧的情况下,我们需要考虑是否值得使用更多的内存消耗来换取更高的性能。这里我们看到的是平衡的艺术,空间换时间,还是时间换空间,只考虑任何一个方面都是不对的。
**第二个误区是过于迷信教科书的大O时间复杂度**。
数据结构中要实现一个列表有基于连续存储的数组和基于指针串联的链表两种方式。在Java中有代表性的实现是ArrayList和LinkedList前者背后的数据结构是数组后者则是双向链表。
在选择数据结构的时候,我们通常会考虑每种数据结构不同操作的时间复杂度,以及使用场景两个因素。查看[这里](https://www.bigocheatsheet.com/)你可以看到数组和链表大O时间复杂度的显著差异
* 对于数组随机元素访问的时间复杂度是O(1)元素插入操作是O(n)
* 对于链表随机元素访问的时间复杂度是O(n)元素插入操作是O(1)。
那么在大量的元素插入、很少的随机访问的业务场景下是不是就应该使用LinkedList呢接下来我们写一段代码测试下两者随机访问和插入的性能吧。
定义四个参数一致的方法分别对元素个数为elementCount的LinkedList和ArrayList循环loopCount次进行随机访问和增加元素到随机位置的操作
```
//LinkedList访问
private static void linkedListGet(int elementCount, int loopCount) {
List<Integer> list = IntStream.rangeClosed(1, elementCount).boxed().collect(Collectors.toCollection(LinkedList::new));
IntStream.rangeClosed(1, loopCount).forEach(i -> list.get(ThreadLocalRandom.current().nextInt(elementCount)));
}
//ArrayList访问
private static void arrayListGet(int elementCount, int loopCount) {
List<Integer> list = IntStream.rangeClosed(1, elementCount).boxed().collect(Collectors.toCollection(ArrayList::new));
IntStream.rangeClosed(1, loopCount).forEach(i -> list.get(ThreadLocalRandom.current().nextInt(elementCount)));
}
//LinkedList插入
private static void linkedListAdd(int elementCount, int loopCount) {
List<Integer> list = IntStream.rangeClosed(1, elementCount).boxed().collect(Collectors.toCollection(LinkedList::new));
IntStream.rangeClosed(1, loopCount).forEach(i -> list.add(ThreadLocalRandom.current().nextInt(elementCount),1));
}
//ArrayList插入
private static void arrayListAdd(int elementCount, int loopCount) {
List<Integer> list = IntStream.rangeClosed(1, elementCount).boxed().collect(Collectors.toCollection(ArrayList::new));
IntStream.rangeClosed(1, loopCount).forEach(i -> list.add(ThreadLocalRandom.current().nextInt(elementCount),1));
}
```
测试代码如下10万个元素循环10万次
```
int elementCount = 100000;
int loopCount = 100000;
StopWatch stopWatch = new StopWatch();
stopWatch.start("linkedListGet");
linkedListGet(elementCount, loopCount);
stopWatch.stop();
stopWatch.start("arrayListGet");
arrayListGet(elementCount, loopCount);
stopWatch.stop();
System.out.println(stopWatch.prettyPrint());
StopWatch stopWatch2 = new StopWatch();
stopWatch2.start("linkedListAdd");
linkedListAdd(elementCount, loopCount);
stopWatch2.stop();
stopWatch2.start("arrayListAdd");
arrayListAdd(elementCount, loopCount);
stopWatch2.stop();
System.out.println(stopWatch2.prettyPrint());
```
运行结果可能会让你大跌眼镜。在随机访问方面我们看到了ArrayList的绝对优势耗时只有11毫秒而LinkedList耗时6.6秒,这符合上面我们所说的时间复杂度;**但随机插入操作居然也是LinkedList落败耗时9.3秒ArrayList只要1.5秒**
```
---------------------------------------------
ns % Task name
---------------------------------------------
6604199591 100% linkedListGet
011494583 000% arrayListGet
StopWatch '': running time = 10729378832 ns
---------------------------------------------
ns % Task name
---------------------------------------------
9253355484 086% linkedListAdd
1476023348 014% arrayListAdd
```
翻看LinkedList源码发现插入操作的时间复杂度是O(1)的前提是你已经有了那个要插入节点的指针。但在实现的时候我们需要先通过循环获取到那个节点的Node然后再执行插入操作。前者也是有开销的不可能只考虑插入操作本身的代价
```
public void add(int index, E element) {
checkPositionIndex(index);
if (index == size)
linkLast(element);
else
linkBefore(element, node(index));
}
Node<E> node(int index) {
// assert isElementIndex(index);
if (index < (size >> 1)) {
Node<E> x = first;
for (int i = 0; i < index; i++)
x = x.next;
return x;
} else {
Node<E> x = last;
for (int i = size - 1; i > index; i--)
x = x.prev;
return x;
}
}
```
所以对于插入操作LinkedList的时间复杂度其实也是O(n)。继续做更多实验的话你会发现在各种常用场景下LinkedList几乎都不能在性能上胜出ArrayList。
讽刺的是LinkedList的作者约书亚 · 布洛克Josh Bloch在其推特上回复别人时说虽然LinkedList是我写的但我从来不用有谁会真的用吗
![](https://static001.geekbang.org/resource/image/12/cc/122a469eb03f16ab61d893ec57b34acc.png)
这告诉我们任何东西理论上和实际上是有差距的请勿迷信教科书的理论最好在下定论之前实际测试一下。抛开算法层面不谈由于CPU缓存、内存连续性等问题链表这种数据结构的实现方式对性能并不友好即使在它最擅长的场景都不一定可以发挥威力。
## 重点回顾
今天我分享了若干和List列表相关的错误案例基本都是由“想当然”导致的。
第一想当然认为Arrays.asList和List.subList得到的List是普通的、独立的ArrayList在使用时出现各种奇怪的问题。
* Arrays.asList得到的是Arrays的内部类ArrayListList.subList得到的是ArrayList的内部类SubList不能把这两个内部类转换为ArrayList使用。
* Arrays.asList直接使用了原始数组可以认为是共享“存储”而且不支持增删元素List.subList直接引用了原始的List也可以认为是共享“存储”而且对原始List直接进行结构性修改会导致SubList出现异常。
* 对Arrays.asList和List.subList容易忽略的是新的List持有了原始数据的引用可能会导致原始数据也无法GC的问题最终导致OOM。
第二想当然认为Arrays.asList一定可以把所有数组转换为正确的List。当传入基本类型数组的时候List的元素是数组本身而不是数组中的元素。
第三想当然认为内存中任何集合的搜索都是很快的结果在搜索超大ArrayList的时候遇到性能问题。我们考虑利用HashMap哈希表随机查找的时间复杂度为O(1)这个特性来优化性能不过也要考虑HashMap存储空间上的代价要平衡时间和空间。
第四想当然认为链表适合元素增删的场景选用LinkedList作为数据结构。在真实场景中读写增删一般是平衡的而且增删不可能只是对头尾对象进行操作可能在90%的情况下都得不到性能增益,建议使用之前通过性能测试评估一下。
今天用到的代码我都放在了GitHub上你可以点击[这个链接](https://github.com/JosephZhu1983/java-common-mistakes)查看。
## 思考与讨论
最后我给你留下与ArrayList在删除元素方面的坑有关的两个思考题吧。
1. 调用类型是Integer的ArrayList的remove方法删除元素传入一个Integer包装类的数字和传入一个int基本类型的数字结果一样吗
2. 循环遍历List调用remove方法删除元素往往会遇到ConcurrentModificationException异常原因是什么修复方式又是什么呢
你还遇到过与集合类相关的其他坑吗?我是朱晔,欢迎在评论区与我留言分享你的想法,也欢迎你把这篇文章分享给你的朋友或同事,一起交流。