你好,我是朱晔。今天,我来和你说说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搜索的性能问题等几个方面着手,来聊聊其中最可能遇到的一些坑。
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.UnsupportedOperationExceptionat 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);}...@Overridepublic 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的“解耦”,不再相互影响。同时,因为操作的是真正的ArrayList,add也不再出错:
13:34:50.829 [main] INFO org.geekbang.time.commonmistakes.collection.aslist.AsListApplication - arr:[1, 4, 3] list:[1, 2, 3, 5]
业务开发时常常要对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 spaceat 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.ConcurrentModificationExceptionat 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)
可以看到两个现象:
我们分析下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 codeif (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的视图,那么避免相互影响的修复方式有两种:
//方式一: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]24
可以看到,删除SubList的元素不再影响原始List,而对原始List的修改也不会再出现List迭代异常。
在介绍并发工具时,我提到要根据业务场景选择合适的并发工具或容器。在使用List集合类的时候,不注意使用场景也会遇见两个常见误区。
第一个误区是,使用数据结构不考虑平衡时间和空间。
首先,定义一个只有一个int类型订单号字段的Order类:
@Data@NoArgsConstructor@AllArgsConstructorstatic 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毫秒。
2086199272388672StopWatch '': running time = 3506699764 ns---------------------------------------------ns % Task name---------------------------------------------3398413176 097% listSearch108286588 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)。
所以,在应用内存吃紧的情况下,我们需要考虑是否值得使用更多的内存消耗来换取更高的性能。这里我们看到的是平衡的艺术,空间换时间,还是时间换空间,只考虑任何一个方面都是不对的。
第二个误区是,过于迷信教科书的大O时间复杂度。
数据结构中要实现一个列表,有基于连续存储的数组和基于指针串联的链表两种方式。在Java中,有代表性的实现是ArrayList和LinkedList,前者背后的数据结构是数组,后者则是(双向)链表。
在选择数据结构的时候,我们通常会考虑每种数据结构不同操作的时间复杂度,以及使用场景两个因素。查看这里,你可以看到数组和链表大O时间复杂度的显著差异:
那么,在大量的元素插入、很少的随机访问的业务场景下,是不是就应该使用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% linkedListGet011494583 000% arrayListGetStopWatch '': running time = 10729378832 ns---------------------------------------------ns % Task name---------------------------------------------9253355484 086% linkedListAdd1476023348 014% arrayListAdd
翻看LinkedList源码发现,插入操作的时间复杂度是O(1)的前提是,你已经有了那个要插入节点的指针。但,在实现的时候,我们需要先通过循环获取到那个节点的Node,然后再执行插入操作。前者也是有开销的,不可能只考虑插入操作本身的代价:
public void add(int index, E element) {checkPositionIndex(index);if (index == size)linkLast(element);elselinkBefore(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是我写的但我从来不用,有谁会真的用吗?
这告诉我们,任何东西理论上和实际上是有差距的,请勿迷信教科书的理论,最好在下定论之前实际测试一下。抛开算法层面不谈,由于CPU缓存、内存连续性等问题,链表这种数据结构的实现方式对性能并不友好,即使在它最擅长的场景都不一定可以发挥威力。
今天,我分享了若干和List列表相关的错误案例,基本都是由“想当然”导致的。
第一,想当然认为,Arrays.asList和List.subList得到的List是普通的、独立的ArrayList,在使用时出现各种奇怪的问题。
第二,想当然认为,Arrays.asList一定可以把所有数组转换为正确的List。当传入基本类型数组的时候,List的元素是数组本身,而不是数组中的元素。
第三,想当然认为,内存中任何集合的搜索都是很快的,结果在搜索超大ArrayList的时候遇到性能问题。我们考虑利用HashMap哈希表随机查找的时间复杂度为O(1)这个特性来优化性能,不过也要考虑HashMap存储空间上的代价,要平衡时间和空间。
第四,想当然认为,链表适合元素增删的场景,选用LinkedList作为数据结构。在真实场景中读写增删一般是平衡的,而且增删不可能只是对头尾对象进行操作,可能在90%的情况下都得不到性能增益,建议使用之前通过性能测试评估一下。
今天用到的代码,我都放在了GitHub上,你可以点击这个链接查看。
最后,我给你留下与ArrayList在删除元素方面的坑有关的两个思考题吧。
你还遇到过与集合类相关的其他坑吗?我是朱晔,欢迎在评论区与我留言分享你的想法,也欢迎你把这篇文章分享给你的朋友或同事,一起交流。