• 为什么阿里巴巴要求谨慎使用ArrayList中的subList方法


    GitHub 3.7k Star 的Java工程师成神之路 ,不来了解一下吗?

    GitHub 3.7k Star 的Java工程师成神之路 ,真的不来了解一下吗?

    GitHub 3.7k Star 的Java工程师成神之路 ,真的确定不来了解一下吗?

    集合是Java开发日常开发中经常会使用到的。在之前的一些文章中,我们介绍过一些关于使用集合类应该注意的事项,如《为什么阿里巴巴禁止在 foreach 循环里进行元素的 remove/add 操作》、《为什么阿里巴巴建议集合初始化时,指定集合容量大小》等。

    关于集合类,《阿里巴巴Java开发手册》中其实还有另外一个规定:

    -w1379

    本文就来分析一下为什么会有如此建议?其背后的原理是什么?

    subList

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

    如以下代码:

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

    以上代码输出结果为:

    [Hollis]
    

    如果我们改动下代码,将subList的返回值强转成ArrayList试一下:

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

    以上代码将抛出异常:

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

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

    那么,为什么会发生这样的报错呢?我们接下来深入分析一下。

    底层原理

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

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

    也就是说subList 返回是一个视图,那么什么叫做视图呢?

    我们看下subList的源码:

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

    这个方法返回了一个SubList,这个类是ArrayList中的一个内部类。

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

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

    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;
    }
    

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

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

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

    视图有什么问题

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

    这个SubList是ArrayList的一个视图。

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

    1、非结构性改变SubList

    public static void main(String[] args) {
        List<String> sourceList = new ArrayList<String>() {{
            add("H");
            add("O");
            add("L");
            add("L");
            add("I");
            add("S");
        }};
    
        List subList = sourceList.subList(2, 5);
    
        System.out.println("sourceList : " + sourceList);
        System.out.println("sourceList.subList(2, 5) 得到List :");
        System.out.println("subList : " + subList);
    
        subList.set(1, "666");
    
        System.out.println("subList.set(3,666) 得到List :");
        System.out.println("subList : " + subList);
        System.out.println("sourceList : " + sourceList);
    
    }
    

    得到结果:

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

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

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

    1、结构性改变SubList

    public static void main(String[] args) {
        List<String> sourceList = new ArrayList<String>() {{
            add("H");
            add("O");
            add("L");
            add("L");
            add("I");
            add("S");
        }};
    
        List subList = sourceList.subList(2, 5);
    
        System.out.println("sourceList : " + sourceList);
        System.out.println("sourceList.subList(2, 5) 得到List :");
        System.out.println("subList : " + subList);
    
        subList.add("666");
    
        System.out.println("subList.add(666) 得到List :");
        System.out.println("subList : " + subList);
        System.out.println("sourceList : " + sourceList);
    
    }
    

    得到结果:

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

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

    1、结构性改变原List

    public static void main(String[] args) {
        List<String> sourceList = new ArrayList<String>() {{
            add("H");
            add("O");
            add("L");
            add("L");
            add("I");
            add("S");
        }};
    
        List subList = sourceList.subList(2, 5);
    
        System.out.println("sourceList : " + sourceList);
        System.out.println("sourceList.subList(2, 5) 得到List :");
        System.out.println("subList : " + subList);
    
        sourceList.add("666");
    
        System.out.println("sourceList.add(666) 得到List :");
        System.out.println("sourceList : " + sourceList);
        System.out.println("subList : " + subList);
    
    }
    

    得到结果:

    Exception in thread "main" 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.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的结构进行改变,即向其追加元素,结果发现抛出了ConcurrentModificationException。关于这个异常,我们在《一不小心就踩坑的fail-fast是个什么鬼?》中分析过,这里原理相同,就不再赘述了。

    小结

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

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

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

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

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

    3、对父List做结构性修改,会抛出异常ConcurrentModificationException。

    所以,阿里巴巴Java开发手册中有另外一条规定:

    如何创建新的List

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

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

    PS:最近,《阿里巴巴Java开发手册》已经正式更名为《Java开发手册》,并发布了新版本,增加了21条新规约,修改描述112处。

    关注公众号后台回复:手册,即可获取最新版Java开发手册。

    参考资料: https://www.jianshu.com/p/5854851240df https://www.cnblogs.com/ljdblog/p/6251387.html

  • 相关阅读:
    数据结构与算法简记--拓扑排序
    数据结构与算法简记--redis有序集合数据结构-跳表
    数据结构与算法简记--动态规划实战
    数据结构与算法简记--动态规划理论
    数据结构与算法简记--动态规划初识
    数据结构与算法简记--回溯算法
    数据结构与算法简记--分治算法
    数据结构与算法简记--贪心算法
    数据结构与算法简记--搜索算法
    数据结构与算法简记--图
  • 原文地址:https://www.cnblogs.com/hollischuang/p/11081090.html
Copyright © 2020-2023  润新知