在Java中使用List.subList(intfromIndex,inttoIndex)方法时需要注意的问题

关于集合类&＃xff0c;《阿里巴巴Java开发手册》中有一个规定&＃xff1a;

&＃xfffc;这里我们简单分析下。

subList

subList是List接口中定义的一个方法&＃xff0c;该方法主要用于返回一个集合中的一段、可以理解为截取一个集合中的部分元素&＃xff0c;他的返回值也是一个List。

如以下代码&＃xff1a;

public static void main(String[] args) {List names &＃61; new ArrayList() {{add("Hollis");add("hollischuang");add("H");}};List subList &＃61; names.subList(0, 1);System.out.println(subList);
}

以上代码输出结果为&＃xff1a;

[Hollis]

如果我们改动下代码&＃xff0c;将subList的返回值强转成ArrayList试一下&＃xff1a;

public static void main(String[] args) {List names &＃61; new ArrayList() {{add("Hollis");add("hollischuang");add("H");}};ArrayList subList &＃61; names.subList(0, 1);System.out.println(subList);
}

以上代码将抛出异常&＃xff1a;

java.lang.ClassCastException: java.util.ArrayList$SubList cannot be cast to java.util.ArrayList


不只是强转成ArrayList会报错&＃xff0c;强转成LinkedList、Vector等List的实现类同样也都会报错。

那么&＃xff0c;为什么会发生这样的报错呢&＃xff1f;我们接下来深入分析一下。

底层原理

首先&＃xff0c;我们看下subList方法给我们返回的List到底是个什么东西&＃xff0c;这一点在JDK源码中注释是这样说的&＃xff1a;

Returns a view of the portion of this list between the specifiedfromIndex, inclusive, and toIndex, exclusive.

也就是说subList 返回是一个视图&＃xff0c;那么什么叫做视图呢&＃xff1f;

我们看下subList的源码&＃xff1a;

public List subList(int fromIndex, int toIndex) {subListRangeCheck(fromIndex, toIndex, size);return new SubList(this, 0, fromIndex, toIndex);
}

这个方法返回了一个SubList&＃xff0c;这个类是ArrayList中的一个内部类。

SubList这个类中单独定义了set、get、size、add、remove等方法。

当我们调用subList方法的时候&＃xff0c;会通过调用SubList的构造函数创建一个SubList&＃xff0c;那么看下这个构造函数做了哪些事情&＃xff1a;

SubList(AbstractList parent,int offset, int fromIndex, int toIndex) {this.parent &＃61; parent;this.parentOffset &＃61; fromIndex;this.offset &＃61; offset &＃43; fromIndex;this.size &＃61; toIndex - fromIndex;this.modCount &＃61; ArrayList.this.modCount;
}

可以看到&＃xff0c;这个构造函数中把原来的List以及该List中的部分属性直接赋值给自己的一些属性了。

也就是说&＃xff0c;SubList并没有重新创建一个List&＃xff0c;而是直接引用了原有的List&＃xff08;返回了父类的视图&＃xff09;&＃xff0c;只是指定了一下他要使用的元素的范围而已&＃xff08;从fromIndex&＃xff08;包含&＃xff09;&＃xff0c;到toIndex&＃xff08;不包含&＃xff09;&＃xff09;。

所以&＃xff0c;为什么不能讲subList方法得到的集合直接转换成ArrayList呢&＃xff1f;因为SubList只是ArrayList的内部类&＃xff0c;他们之间并没有集成关系&＃xff0c;故无法直接进行强制类型转换。

视图有什么问题

前面通过查看源码&＃xff0c;我们知道&＃xff0c;subList()方法并没有重新创建一个ArrayList&＃xff0c;而是返回了一个ArrayList的内部类——SubList。

这个SubList是ArrayList的一个视图。

那么&＃xff0c;这个视图又会带来什么问题呢&＃xff1f;我们需要简单写几段代码看一下。

1、非结构性改变SubList

public static void main(String[] args) {List sourceList &＃61; new ArrayList() {{add("H");add("O");add("L");add("L");add("I");add("S");}};List subList &＃61; sourceList.subList(2, 5);System.out.println("sourceList &＃xff1a; " &＃43; sourceList);System.out.println("sourceList.subList(2, 5) 得到List &＃xff1a;");System.out.println("subList &＃xff1a; " &＃43; subList);subList.set(1, "666");System.out.println("subList.set(3,666) 得到List &＃xff1a;");System.out.println("subList &＃xff1a; " &＃43; subList);System.out.println("sourceList &＃xff1a; " &＃43; sourceList);}

得到结果&＃xff1a;

sourceList &＃xff1a; [H, O, L, L, I, S]
sourceList.subList(2, 5) 得到List &＃xff1a;
subList &＃xff1a; [L, L, I]
subList.set(3,666) 得到List &＃xff1a;
subList &＃xff1a; [L, 666, I]
sourceList &＃xff1a; [H, O, L, 666, I, S]

当我们尝试通过set方法&＃xff0c;改变subList中某个元素的值得时候&＃xff0c;我们发现&＃xff0c;原来的那个List中对应元素的值也发生了改变。

同理&＃xff0c;如果我们使用同样的方法&＃xff0c;对sourceList中的某个元素进行修改&＃xff0c;那么subList中对应的值也会发生改变。读者可以自行尝试一下。

1、结构性改变SubList

public static void main(String[] args) {List sourceList &＃61; new ArrayList() {{add("H");add("O");add("L");add("L");add("I");add("S");}};List subList &＃61; sourceList.subList(2, 5);System.out.println("sourceList &＃xff1a; " &＃43; sourceList);System.out.println("sourceList.subList(2, 5) 得到List &＃xff1a;");System.out.println("subList &＃xff1a; " &＃43; subList);subList.add("666");System.out.println("subList.add(666) 得到List &＃xff1a;");System.out.println("subList &＃xff1a; " &＃43; subList);System.out.println("sourceList &＃xff1a; " &＃43; sourceList);}

得到结果&＃xff1a;

sourceList &＃xff1a; [H, O, L, L, I, S]
sourceList.subList(2, 5) 得到List &＃xff1a;
subList &＃xff1a; [L, L, I]
subList.add(666) 得到List &＃xff1a;
subList &＃xff1a; [L, L, I, 666]
sourceList &＃xff1a; [H, O, L, L, I, 666, S]

我们尝试对subList的结构进行改变&＃xff0c;即向其追加元素&＃xff0c;那么得到的结果是sourceList的结构也同样发生了改变。

1、结构性改变原List

public static void main(String[] args) {List sourceList &＃61; new ArrayList() {{add("H");add("O");add("L");add("L");add("I");add("S");}};List subList &＃61; sourceList.subList(2, 5);System.out.println("sourceList &＃xff1a; " &＃43; sourceList);System.out.println("sourceList.subList(2, 5) 得到List &＃xff1a;");System.out.println("subList &＃xff1a; " &＃43; subList);sourceList.add("666");System.out.println("sourceList.add(666) 得到List &＃xff1a;");System.out.println("sourceList &＃xff1a; " &＃43; sourceList);System.out.println("subList &＃xff1a; " &＃43; subList);}

得到结果&＃xff1a;

Exception in thread "main" 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.util.AbstractCollection.toString(AbstractCollection.java:454)at java.lang.String.valueOf(String.java:2994)at java.lang.StringBuilder.append(StringBuilder.java:131)at com.hollis.SubListTest.main(SubListTest.java:28)


我们尝试对sourceList的结构进行改变&＃xff0c;即向其追加元素&＃xff0c;结果发现抛出了ConcurrentModificationException。关于这个异常&＃xff0c;我们在《一不小心就踩坑的fail-fast是个什么鬼&＃xff1f;》中分析过&＃xff0c;这里原理相同&＃xff0c;就不再赘述了。

小结

我们简单总结一下&＃xff0c;List的subList方法并没有创建一个新的List&＃xff0c;而是使用了原List的视图&＃xff0c;这个视图使用内部类SubList表示。

所以&＃xff0c;我们不能把subList方法返回的List强制转换成ArrayList等类&＃xff0c;因为他们之间没有继承关系。

另外&＃xff0c;视图和原List的修改还需要注意几点&＃xff0c;尤其是他们之间的相互影响&＃xff1a;

1、对父(sourceList)子(subList)List做的非结构性修改&＃xff08;non-structural changes&＃xff09;&＃xff0c;都会影响到彼此。

2、对子List做结构性修改&＃xff0c;操作同样会反映到父List上。

3、对父List做结构性修改&＃xff0c;会抛出异常ConcurrentModificationException。

所以&＃xff0c;阿里巴巴Java开发手册中有另外一条规定&＃xff1a;

如何创建新的List

如果需要对subList作出修改&＃xff0c;又不想动原list。那么可以创建subList的一个拷贝&＃xff1a;

subList &＃61; Lists.newArrayList(subList);
list.stream().skip(strart).limit(end).collect(Collectors.toList());