Java源码解析系列(二)ArrayList源码解析

版权声明:本文为博主原创文章,欢迎大家转载!

但是转载请标明出处: https://blog.csdn.net/t000818/article/details/82798745 ,本文出自:【唐宏宇的博客】


备注:以下都是基于JDK8 源码分析

ArrayList简介

       ArrayList 是一个数组队列,相当于 动态数组。与Java中的数组相比,它的容量能动态增长。它继承于AbstractList,实现了List, RandomAccess, Cloneable, java.io.Serializable这些接口。
ArrayList 继承了AbstractList,实现了List。它是一个数组队列,提供了相关的添加、删除、修改、遍历等功能。


ArrayList 实现了RandmoAccess接口,即提供了随机访问功能。RandmoAccess是java中用来被List实现,为List提供快速访问功能的。在ArrayList中,我们即以O(1)的时间复杂度,通过元素的序号快速获取元素对象,这就是快速随机访问。稍后,我们会比较List的“快速随机访问”和“通过Iterator迭代器访问”的效率。


ArrayList 实现了Cloneable接口,即覆盖了函数clone(),能被克隆。
ArrayList 实现java.io.Serializable接口,这意味着ArrayList支持序列化,能通过序列化去传输。

和Vector不同,ArrayList中的操作不是线程安全的!所以,建议在单线程中才使用ArrayList,而在多线程中可以选择Vector或者CopyOnWriteArrayList。

因其底层数据结构是数组,所以可想而知,它是占据一块连续的内存空间(容量就是数组的length),所以它也有数组的缺点,空间效率不高

由于数组的内存连续,可以根据下标以O1的时间读写(改查)元素,因此时间效率很高

当集合中的元素超出这个容量,便会进行扩容操作。扩容操作也是ArrayList 的一个性能消耗比较大的地方,所以若我们可以提前预知数据的规模,应该通过public ArrayList(int initialCapacity) {}构造方法,指定集合的大小,去构建ArrayList实例,以减少扩容次数,提高效率

 

ArrayList属性

ArrayList属性主要就是当前数组长度size,以及存放数组的对象elementData数组,除此之外还有一个经常用到的属性就是从AbstractList继承过来的modCount属性,代表ArrayList集合的修改次数。

public class ArrayList<E> extends AbstractList<E>
        implements List<E>, RandomAccess, Cloneable, java.io.Serializable
{
    
    //序列化ID
    private static final long serialVersionUID = 8683452581122892189L;

    //默认初始化容量大小
    private static final int DEFAULT_CAPACITY = 10;

    //有参构造函数,初始化空数组数据
    private static final Object[] EMPTY_ELEMENTDATA = {};

  
    //无参构造函数,初始化空数组数据。用来区分,第一次添加元素时,是否需要扩容
    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
    
    //存储集合元素的底层实现:真正存放元素的数组,不参与序列化  
    transient Object[] elementData; 

    //实际数据大小
    private int size;

注意:EMPTY_ELEMENTDATA、DEFAULTCAPACITY_EMPTY_ELEMENTDATA都用static修饰,也就是当再次创建默认构造函数或0容量的ArrayList,并不会重新分配内存,其内部数据都指向同一个引用,起到缓存的作用。

elementData 之所以用transient关键字修饰,是因为序列化的时候,其中有一些空数据,并不需要把整个数组都序列化,只需要序列化实际数据大小的数据即可。

 

ArrayList构造函数

无参构造函数

如果不传入参数,则使用默认无参构建方法创建ArrayList对象,如下:

//赋予一个空数组对象,当第一添加元素时,elementData长度会设置成10
public ArrayList() {this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;}

 

带int类型的构造函数

如果传入参数,则代表指定ArrayList的初始数组长度,传入参数如果是大于等于0,则使用用户的参数初始化,如果用户传入的参数小于0,则抛出异常,构造方法如下:

/**
  * 传入指定容量来初始化ArrayList容量,如果大于0使用指定容量。
  *  如果等于0则使用缓存的空数组对象。
  *
  * @param  initialCapacity  容量大小
  * @throws IllegalArgumentException 如果容量小于0,则抛出异常
  *         
  */  
public ArrayList(int initialCapacity) {
        if (initialCapacity > 0) {
            this.elementData = new Object[initialCapacity];
        } else if (initialCapacity == 0) {
            this.elementData = EMPTY_ELEMENTDATA;
        } else {
            throw new IllegalArgumentException("Illegal Capacity: "+
                                               initialCapacity);
        }
}

 

带Collection对象的构造函数

1)将collection对象转换成数组,然后将数组的地址的赋给elementData。

2)更新size的值,同时判断size的大小,如果是size等于0,直接将空对象EMPTY_ELEMENTDATA的地址赋给elementData

3)如果size的值大于0,则执行Arrays.copy方法,把collection对象的内容(可以理解为深拷贝)copy到elementData中。

/**
*
* 传入一个集合构造ArrayList
* 
* @param c 集合数据
* @throws NullPointerException 如果集合为空,则抛出异常
*/
public ArrayList(Collection<? extends E> c) {
     elementData = c.toArray();
     if ((size = elementData.length) != 0) {
         // c.toArray might (incorrectly) not return Object[] (see 6260652)
         if (elementData.getClass() != Object[].class)
             elementData = Arrays.copyOf(elementData, size, Object[].class);
     } else {
         // replace with empty array.
         this.elementData = EMPTY_ELEMENTDATA;
     }
}

注意:this.elementData = c.toArray(); 这里会有一个bug。如果是Arrays.asList调用产出的集合,其会保留原始类型,会导致后面加入其它类型的数据,抛出异常。所以需要判断其中的类型是否是Object[].class,如果不是则执行深度拷贝,将类型转为Object[].class。

其测试代码如下

public static void test2()  
{  
    List<String> list = Arrays.asList("abc");  
  
    // 这里是 java.util.Arrays$ArrayList  
    System.out.println(list.getClass());  
  
    // 数组中的实际类型是 [java.lang.String];  
    Object[] objArray = list.toArray();  
    System.out.println(objArray.getClass());  
  
    objArray[0] = new Object(); // 此处会抛出 ArrayStoreException  
}  

 

 

add(E e) 方法

add主要的执行逻辑如下:

1)计算数组已使用长度(size)加1之后,所需的最小容量

2)修改次数modCount 标识自增1,如果当前数组已使用长度(size)加1后的大于当前的数组长度,则调用grow方法,增长数组,grow方法会将当前数组的长度变为原来容量的1.5倍。如果还是小于所需容量,则以所需容量为准。如果大于MAX_ARRAY_SIZE,则使用Integer.MAX_VALUE。备注:数组作为一个对象,一些机器需要一定的内存存储对象头信息,对象头信息最大占用内存不可超过8字节。所以MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8,避免出错。

3)确保新增的数据有地方存储之后,则将新元素添加到位于size的位置上。

4)返回添加成功布尔值。

    /**
     * 在列表末尾添加元素
     *
     * @param e  元素
     * @return true 添加成功返回值
     */
    public boolean add(E e) {
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        elementData[size++] = e;
        return true;
    }

    //计算添加数据后,所需容量
    private static int calculateCapacity(Object[] elementData, int minCapacity) {
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
            return Math.max(DEFAULT_CAPACITY, minCapacity);
        }
        return minCapacity;
        }

    //确认容量
    private void ensureCapacityInternal(int minCapacity) {
        ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));
    }
    
    //确认需要扩容容量
    private void ensureExplicitCapacity(int minCapacity) {
        modCount++;

        // overflow-conscious code
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }

    //扩容
    private void grow(int minCapacity) {
        // overflow-conscious code
        int oldCapacity = elementData.length;
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;
        if (newCapacity - MAX_ARRAY_SIZE > 0)
            newCapacity = hugeCapacity(minCapacity);
        // minCapacity is usually close to size, so this is a win:
        elementData = Arrays.copyOf(elementData, newCapacity);
    }

 

add(int index, E element)方法

这个方法其实和上面的add类似,该方法可以按照元素的位置,指定位置插入元素,具体的执行逻辑如下:

1)确保数插入的位置小于等于当前数组长度,并且不小于0,否则抛出异常

2)确保数组已使用长度(size)加1之后足够存下 下一个数据

3)修改次数(modCount)标识自增1,如果当前数组已使用长度(size)加1后的大于当前的数组长度,则调用grow方法,增长数组

4)grow方法会将当前数组的长度变为原来容量的1.5倍。

5)确保有足够的容量之后,使用System.arraycopy 将需要插入的位置(index)后面的元素统统往后移动一位。

6)将新的数据内容存放到数组的指定位置(index)上

 

    /**
     * 在List中的指定位置插入元素 
     *  
     * @param index 插入的指定坐标
     * @param element 插入元素
     * @throws IndexOutOfBoundsException 越界后抛异常
     */
    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++;
    }

    /**
     * 确认下标是否越界
     */
    private void rangeCheckForAdd(int index) {
        if (index > size || index < 0)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

 

get方法

返回指定位置上的元素,

   /**
     * 返回指定坐标下的元素
     *
     * @param  index 指定坐标
     * @return the element at the specified position in this list
     * @throws IndexOutOfBoundsException 
     */
    public E get(int index) {
        rangeCheck(index);

        return elementData(index);
    }

 

set方法

确保set的位置小于当前数组的长度(size)并且大于0,获取指定位置(index)元素,然后放到oldValue存放,将需要设置的元素放到指定的位置(index)上,然后将原来位置上的元素oldValue返回给用户。

   /**
     * 替换指定坐标下的元素为指定新元素
     * 
     *
     * @param index 被替换的下标
     * @param element 指定的新元素
     * @return the element 老元素
     * @throws IndexOutOfBoundsException 
     */
    public E set(int index, E element) {
        rangeCheck(index);

        E oldValue = elementData(index);
        elementData[index] = element;
        return oldValue;
    }

 

contains方法

调用indexOf方法,遍历数组中的每一个元素作对比,如果找到对于的元素,则返回true,没有找到则返回false。

   /**
     * 
     * 确认List中是否包含指定元素
     *
     * @param o 指定元素
     * @return 如果包含,则返回true
     */
    public boolean contains(Object o) {
        return indexOf(o) >= 0;
    }


   /**
     * 返回List中,找到的第一个元素的坐标,如果不包含则返回-1
     *
     * 
     */
    public int indexOf(Object o) {
        if (o == null) {
            for (int i = 0; i < size; i++)
                if (elementData[i]==null)
                    return i;
        } else {
            for (int i = 0; i < size; i++)
                if (o.equals(elementData[i]))
                    return i;
        }
        return -1;
    }

 

remove方法

根据索引remove

1)判断索引有没有越界

2)自增修改次数

3)将指定位置(index)上的元素保存到oldValue

4)将指定位置(index)上的元素都往前移动一位

5)将最后面的一个元素置空,好让垃圾回收器回收

6)将原来的值oldValue返回

    /**
     * 删除指定下标的元素,右边的元素往左移
     * 
     *
     * @param index 指定下标
     * @return 返回已删除的旧元素
     * @throws IndexOutOfBoundsException
     */
    public E remove(int index) {
        rangeCheck(index);

        modCount++;
        E oldValue = elementData(index);

        int numMoved = size - index - 1;
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
        elementData[--size] = null; // clear to let GC do its work

        return oldValue;
    }

 

 

根据对象remove

循环遍历所有对象,得到对象所在索引位置,然后调用fastRemove方法,执行remove操作,调用此方法不会缩减数组长度

   /**
     * 移除List中第一个匹配找到的对象
     *
     * @param o 要删除的对象
     * @return 找到并移除返回true,否则返回false
     */
    public boolean remove(Object o) {
        if (o == null) {
            for (int index = 0; index < size; index++)
                if (elementData[index] == null) {
                    fastRemove(index);
                    return true;
                }
        } else {
            for (int index = 0; index < size; index++)
                if (o.equals(elementData[index])) {
                    fastRemove(index);
                    return true;
                }
        }
        return false;
    }

   //移除指定下标元素,并置空
   private void fastRemove(int index) {
        modCount++;
        int numMoved = size - index - 1;
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index,
                             numMoved);
        elementData[--size] = null; // clear to let GC do its work
    }

 

clear方法

添加操作次数(modCount),将数组内的元素都置空,等待垃圾收集器收集,不减小数组容量。

   //删除所有元素,并把数组内数据置空,等待GC回收内存
   public void clear() {
        modCount++;

        // clear to let GC do its work
        for (int i = 0; i < size; i++)
            elementData[i] = null;

        size = 0;
    }

sublist方法

我们看到代码中是创建了一个ArrayList 类里面的一个内部类SubList对象,传入的值中第一个参数时this参数,其实可以理解为返回当前list的部分视图,真实指向的存放数据内容的地方还是同一个地方,如果修改了sublist返回的内容的话,那么原来的list也会变动。

    /**
     * 返回指定区域内的元素List,包含fromIndex,不包含toIndex,如果fromIndex与toIndex相同
     * 则返回空List。子List是原List的备份,如果对子List操作都会影响到原List,反之亦然。
     *  
     *
     * @throws IndexOutOfBoundsException 
     * @throws IllegalArgumentException 
     */
    public List<E> subList(int fromIndex, int toIndex) {
        subListRangeCheck(fromIndex, toIndex, size);
        return new SubList(this, 0, fromIndex, toIndex);
    }

 

trimToSize方法

1)修改次数加1

2)将elementData中空余的空间(包括null值)去除,例如:数组长度为10,其中只有前三个元素有值,其他为空,那么调用该方法之后,数组的长度变为3。

   public void trimToSize() {
        modCount++;
        if (size < elementData.length) {
            elementData = (size == 0)
              ? EMPTY_ELEMENTDATA
              : Arrays.copyOf(elementData, size);
        }
    }

 

 

iterator方法

interator方法返回的是一个内部类,由于内部类的创建默认含有外部的this指针,所以这个内部类可以调用到外部类的属性。

    public Iterator<E> iterator() {
        return new Itr();
    }

一般的话,调用完iterator之后,我们会使用iterator做遍历,这里使用next做遍历的时候有个需要注意的地方,就是调用next的时候,可能会引发ConcurrentModificationException,当修改次数,与期望的修改次数(调用iterator方法时候的修改次数)不一致的时候,会发生该异常.

expectedModCount这个值是在用户调用ArrayList的iterator方法时候确定的,但是在这之后用户add,或者remove了ArrayList的元素,那么modCount就会改变,那么这个值就会不相等,将会引发ConcurrentModificationException异常,这个是在多线程使用情况下,比较常见的一个异常。

    private class Itr implements Iterator<E> {
        int cursor;       // index of next element to return
        int lastRet = -1; // index of last element returned; -1 if no such
        int expectedModCount = modCount;

        public boolean hasNext() {
            return cursor != size;
        }

        @SuppressWarnings("unchecked")
        public E next() {
            checkForComodification();
            int i = cursor;
            if (i >= size)
                throw new NoSuchElementException();
            Object[] elementData = ArrayList.this.elementData;
            if (i >= elementData.length)
                throw new ConcurrentModificationException();
            cursor = i + 1;
            return (E) elementData[lastRet = i];
        }

        public void remove() {
            if (lastRet < 0)
                throw new IllegalStateException();
            checkForComodification();

            try {
                ArrayList.this.remove(lastRet);
                cursor = lastRet;
                lastRet = -1;
                expectedModCount = modCount;
            } catch (IndexOutOfBoundsException ex) {
                throw new ConcurrentModificationException();
            }
        }

        @Override
        @SuppressWarnings("unchecked")
        public void forEachRemaining(Consumer<? super E> consumer) {
            Objects.requireNonNull(consumer);
            final int size = ArrayList.this.size;
            int i = cursor;
            if (i >= size) {
                return;
            }
            final Object[] elementData = ArrayList.this.elementData;
            if (i >= elementData.length) {
                throw new ConcurrentModificationException();
            }
            while (i != size && modCount == expectedModCount) {
                consumer.accept((E) elementData[i++]);
            }
            // update once at end of iteration to reduce heap write traffic
            cursor = i;
            lastRet = i - 1;
            checkForComodification();
        }

        final void checkForComodification() {
            if (modCount != expectedModCount)
                throw new ConcurrentModificationException();
        }
    }

listIterator方法

listInterator方法返回的也是一个内部类,它继承了Itr内部类,与之不同的是。可以指定从某个位置,向前或向后遍历元素

    /**
     * 
     * 从指定位置开始,返回一个ListIterator
     * 
     *
     * @throws IndexOutOfBoundsException 
     */
    public ListIterator<E> listIterator(int index) {
        if (index < 0 || index > size)
            throw new IndexOutOfBoundsException("Index: "+index);
        return new ListItr(index);
    }


    /**
     * An optimized version of AbstractList.ListItr
     */
    private class ListItr extends Itr implements ListIterator<E> {
        ListItr(int index) {
            super();
            cursor = index;
        }

        public boolean hasPrevious() {
            return cursor != 0;
        }

        public int nextIndex() {
            return cursor;
        }

        public int previousIndex() {
            return cursor - 1;
        }

        @SuppressWarnings("unchecked")
        public E previous() {
            checkForComodification();
            int i = cursor - 1;
            if (i < 0)
                throw new NoSuchElementException();
            Object[] elementData = ArrayList.this.elementData;
            if (i >= elementData.length)
                throw new ConcurrentModificationException();
            cursor = i;
            return (E) elementData[lastRet = i];
        }

        public void set(E e) {
            if (lastRet < 0)
                throw new IllegalStateException();
            checkForComodification();

            try {
                ArrayList.this.set(lastRet, e);
            } catch (IndexOutOfBoundsException ex) {
                throw new ConcurrentModificationException();
            }
        }

        public void add(E e) {
            checkForComodification();

            try {
                int i = cursor;
                ArrayList.this.add(i, e);
                cursor = i + 1;
                lastRet = -1;
                expectedModCount = modCount;
            } catch (IndexOutOfBoundsException ex) {
                throw new ConcurrentModificationException();
            }
        }
    }

 

小结

ArrayList总体来说比较简单,不过ArrayList还有以下一些特点:

 

  • ArrayList自己实现了序列化和反序列化的方法,因为它自己实现了 private void writeObject(java.io.ObjectOutputStream s)和 private void readObject(java.io.ObjectInputStream s) 方法
  • ArrayList基于数组方式实现,无容量的限制(会扩容)
  • 添加元素时可能要扩容(所以最好预判一下),删除元素时会减少容量(若希望减少容量,trimToSize()),删除元素时,将删除掉的位置元素置为null,下次gc就会回收这些元素所占的内存空间
  • 线程不安全
  • add(int index, E element):添加元素到数组中指定位置的时候,需要将该位置及其后边所有的元素都整块向后复制一位
  • get(int index):获取指定位置上的元素时,可以通过索引直接获取(O(1))
  • remove(Object o)需要遍历数组
  • remove(int index)不需要遍历数组,只需判断index是否符合条件即可,效率比remove(Object o)高
  • contains(E)需要遍历数组
  • 使用iterator遍历过程中,如果对ArrayList做修改,可能会引发多线程异常
  • 增删改查中, 增导致扩容,则会修改modCount删一定会修改。 改和查一定不会修改modCount
  • 扩容操作会导致数组复制,批量删除会导致 找出两个集合的交集,以及数组复制操作,因此,增、删都相对低效。 而 改、查都是很高效的操作
  • 结合特点,在使用中,以Android中最常用的展示列表为例,列表滑动时需要展示每一个Item(element)的数组,所以 查 操作是最高频的。相对来说,增操作 只有在列表加载更多时才会用到 ,而且是在列表尾部插入,所以也不需要移动数据的操作。而删操作则更低频。 故选用ArrayList作为保存数据的结构

     

 

参考链接

https://juejin.im/post/59954d9e6fb9a0248a3fd606

https://blog.csdn.net/fighterandknight/article/details/61240861

https://blog.csdn.net/huzhigenlaohu/article/details/51702737

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值