Java集合框架之ArrayList(二)

一、ArrayList简介

  • ArrayList是基于数组实现的List类,内部封装一个动态的、允许再分配的数组,数据可以动态增长扩容。
  • ArrayList是线程不安全的,当多个线程访问同一个ArrayList集合时,如果有超过一个线程修改了ArrayList集合,则程序需要手动保证集合的同步性。在多线程环境下可以考虑用Collections.synchronizedList(List l)函数返回一个线程安全的ArrayList集合。
  • ArrayList继承了AbstractList,并实现了List接口。是一个数组队列,具有添加、删除、修改、遍历等功能。
  • ArrayList实现了RandomAccess接口,因此具有随机访问功能,实际上就是通过数组的下标进行快速访问。
  • ArrayList实现了Serializable接口,支持序列化,可以用于数据传输。
  • ArrayList实现了Cloneable接口,即覆盖了函数clone(),能被克隆。

二、ArrayList继承关系

java.lang.Object 
    java.util.AbstractCollection<E> 
        java.util.AbstractList<E> 
            java.util.ArrayList<E> 
public class ArrayList<E> extends AbstractList<E>
        implements List<E>, RandomAccess, Cloneable, java.io.Serializable{……}

ArrayList与Collection的关系图UML:
这里写图片描述

从UML图中可以得知:ArrayList有两个重要的对象:elementDatasize.

  • elementData:是个Object[]类型的数组,保存着ArrayList集合的所有元素。是一个动态扩容的数组,会根据ArrayList集合元素大小自动增长容量。具体可以参考源码分析中的ensureCapacity()函数。
  • size:动态数组的实际长度,默认是10.

三、源码分析


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

     //数组默认初始容量,默认是10
    private static final int DEFAULT_CAPACITY = 10;

    //用于空实例的共享空数组实例。
    private static final Object[] EMPTY_ELEMENTDATA = {};
    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

   //ArrayList基于该数组实现,用该数组保存数据   
    transient Object[] elementData; 

   //ArrayList集合元素数量
    private int size;

    //创建一个指定容量的ArrayList
    public ArrayList(int initialCapacity) {
        if (initialCapacity > 0) {
            this.elementData = new Object[initialCapacity];
        } else if (initialCapacity == 0) {
            this.elementData = EMPTY_ELEMENTDATA;
        } else {
        //initialCapacity为负数会抛出异常
            throw new IllegalArgumentException("Illegal Capacity: "+
                                               initialCapacity);
        }
    }

    //创建一个默认容量为10的空集合
    public ArrayList() {
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }

     // 创建一个包含collection的ArrayList  
    public ArrayList(Collection<? extends E> c) {
        elementData = c.toArray();
        if ((size = elementData.length) != 0) 
            //c.toArray()转化可能不是Object[]对象,如果不是,需要重新复制一个数组
            if (elementData.getClass() != Object[].class)
                elementData = Arrays.copyOf(elementData, size, Object[].class);
        } else {
            this.elementData = EMPTY_ELEMENTDATA;
        }
    }

     // 将当前容量值设为实际元素个数   
    public void trimToSize() {
    //记录对集合的操作次数
        modCount++;
        if (size < elementData.length) {
            elementData = (size == 0)
              ? EMPTY_ELEMENTDATA
              : Arrays.copyOf(elementData, size);
        }
    }

     //当Object[]数组容量不足时,此方法承担着自动扩容的作用
    public void ensureCapacity(int minCapacity) {
        //根据minExpand来判断数组是否需要扩容
        int minExpand = (elementData != DEFAULTCAPACITY_EMPTY_ELEMENTDATA)
            ? 0: DEFAULT_CAPACITY;

        if (minCapacity > minExpand) {
            ensureExplicitCapacity(minCapacity);
        }
    }

    private void ensureCapacityInternal(int minCapacity) {
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
            minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
        }

        ensureExplicitCapacity(minCapacity);
    }

    private void ensureExplicitCapacity(int minCapacity) {
        modCount++;
        //当当前数组容器不能容下新元素个数,会调用扩容的函数
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }

    //数组的最大容量
    private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;

    //计算数组所需要多少容量
    private void grow(int minCapacity) {
        // overflow-conscious code
        int oldCapacity = elementData.length;
        //首先在旧容量的基础上,增加1.5倍的容量。
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        //在增加1.5倍容量后还不足以容纳当前的元素个数,则把实际所需容量(minCapacity )设置成最新容量  
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;
        //若所需容量大小超过最大设定容量
        if (newCapacity - MAX_ARRAY_SIZE > 0)
            newCapacity = hugeCapacity(minCapacity);
        //在原来数组的基础上,复制一个新数组并自动扩容
        elementData = Arrays.copyOf(elementData, newCapacity);
    }

    private static int hugeCapacity(int minCapacity) {
        if (minCapacity < 0) // overflow
            throw new OutOfMemoryError();
        return (minCapacity > MAX_ARRAY_SIZE) ?
            Integer.MAX_VALUE :
            MAX_ARRAY_SIZE;
    }

    //返回集合元素个数
    public int size() {
        return size;
    }

   //返回集合是否为空
    public boolean isEmpty() {
        return size == 0;
    }

    //集合中是否包含某个对象
    public boolean contains(Object o) {
        return indexOf(o) >= 0;
    }

   //正向查询某个对象在集合中第一次出现的位置,即索引下标
    public int indexOf(Object o) {
    //在null情况下,也进行遍历查询,说明了ArrayList可以盛装null对象。
        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;
        }
        //返回-1,说明集合中不存在该对象
        return -1;
    }

    //反向查询某个对象在集合中最后一次出现的位置,即索引下标
    public int lastIndexOf(Object o) {
        if (o == null) {
            for (int i = size-1; i >= 0; i--)
                if (elementData[i]==null)
                    return i;
        } else {
            for (int i = size-1; i >= 0; i--)
                if (o.equals(elementData[i]))
                    return i;
        }
        return -1;
    }

    // 克隆函数 
    public Object clone() {
        try {
         // 将当前ArrayList的全部元素拷贝到v中 
            ArrayList<?> v = (ArrayList<?>) super.clone();
            v.elementData = Arrays.copyOf(elementData, size);
            v.modCount = 0;
            return v;
        } catch (CloneNotSupportedException e) {
            // this shouldn't happen, since we are Cloneable
            throw new InternalError(e);
        }
    }

   //转成一个有顺序的Object数组
    public Object[] toArray() {
        return Arrays.copyOf(elementData, size);
    }

  //转成带泛型的数组
    @SuppressWarnings("unchecked")
    public <T> T[] toArray(T[] a) {
        //若新数组的长度小于当前数组长度时,会以当前数组的长度创建一个数组
        if (a.length < size)
            // Make a new array of a's runtime type, but my contents:
            return (T[]) Arrays.copyOf(elementData, size, a.getClass());
        System.arraycopy(elementData, 0, a, 0, size);
        if (a.length > size)
            a[size] = null;
        return a;
    }


    @SuppressWarnings("unchecked")
    E elementData(int index) {
        return (E) elementData[index];
    }

   //返回集合中指定位置的元素
    public E get(int index) {
        rangeCheck(index);
        return elementData(index);
    }

    //设置index位置的值为element 
    public E set(int index, E element) {
        rangeCheck(index);

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

    // 将e添加到ArrayList中
    public boolean add(E e) {
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        elementData[size++] = e;
        return true;
    }

    //将e添加到ArrayList的指定位置  
    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++;
    }

     // 删除ArrayList指定位置的元素   
    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;
    }

    // 删除ArrayList的指定元素  
    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;
    }

    // 快速删除第index个元素    
    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
    }

    /**
     * Removes all of the elements from this list.  The list will
     * be empty after this call returns.
     */
    public void clear() {
        modCount++;

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

        size = 0;
    }

    // 将集合c追加到ArrayList中
    public boolean addAll(Collection<? extends E> c) {
        Object[] a = c.toArray();
        int numNew = a.length;
        ensureCapacityInternal(size + numNew);  // Increments modCount
        System.arraycopy(a, 0, elementData, size, numNew);
        size += numNew;
        return numNew != 0;
    }

    // 从index位置开始,将集合c添加到ArrayList
    public boolean addAll(int index, Collection<? extends E> c) {
        rangeCheckForAdd(index);

        Object[] a = c.toArray();
        int numNew = a.length;
        ensureCapacityInternal(size + numNew);  // Increments modCount

        int numMoved = size - index;
        if (numMoved > 0)
            System.arraycopy(elementData, index, elementData, index + numNew,
                             numMoved);

        System.arraycopy(a, 0, elementData, index, numNew);
        size += numNew;
        return numNew != 0;
    }

    // 删除fromIndex到toIndex之间的全部元素。
    protected void removeRange(int fromIndex, int toIndex) {
        modCount++;
        int numMoved = size - toIndex;
        System.arraycopy(elementData, toIndex, elementData, fromIndex,
                         numMoved);

        // clear to let GC do its work
        int newSize = size - (toIndex-fromIndex);
        for (int i = newSize; i < size; i++) {
            elementData[i] = null;
        }
        size = newSize;
    }


    private void rangeCheck(int index) {
        if (index >= size)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

    private void rangeCheckForAdd(int index) {
        if (index > size || index < 0)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

    private String outOfBoundsMsg(int index) {
        return "Index: "+index+", Size: "+size;
    }

   //删除集合中所有的元素
    public boolean removeAll(Collection<?> c) {
        Objects.requireNonNull(c);
        return batchRemove(c, false);
    }


     // java.io.Serializable的写入函数
    // 将ArrayList的“容量,所有的元素值”都写入到输出流中
     private void writeObject(java.io.ObjectOutputStream s)
         throws java.io.IOException{     // Write out element count, and any hidden stuff
        int expectedModCount = modCount;
        s.defaultWriteObject();

         // 写入“数组的容量”
         s.writeInt(elementData.length);

     // 写入“数组的每一个元素”
    for (int i=0; i<size; i++)
             s.writeObject(elementData[i]);

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

     }


     // java.io.Serializable的读取函数:根据写入方式读出
     // 先将ArrayList的“容量”读出,然后将“所有的元素值”读出
     private void readObject(java.io.ObjectInputStream s)
         throws java.io.IOException, ClassNotFoundException {
        s.defaultReadObject();

         // 从输入流中读取ArrayList的“容量”
         int arrayLength = s.readInt();
         Object[] a = elementData = new Object[arrayLength];

         // 从输入流中将“所有的元素值”读出
         for (int i=0; i<size; i++)
             a[i] = s.readObject();
     }
………

}

总结:

  1. ArrayList实际上是通过数组来保存数据的。提供了 三个不同的构造函数,一个指定容量的构造函数,无参的构造函数(默认容量是10),一个带有Collection参数的构造方法,将Collection转化为数组赋给ArrayList的实现数组elementData。
  2. ArrayList当容量不足时会重新设置容量,先以原容量的1.5倍自动扩容,如果设置后的新容量还不够,则直接新容量设置为传入的参数(也就是所需的容量)。
  3. ArrayList中的add和remove方法以及其他处大量用到了System.arraycopy()会移动index之后所有元素即可。这就意味着,ArrayList的add(int index, E element)函数,会引起index之后所有元素的改变,所有当存在大量插入和删除的操作的,ArrayList的效率比较低,建议使用LinkedList。由于实现了RandomAccess接口,随机访问ArrayList有明显的优势。
  4. 在查询的函数内,元素的值分了null和非null两种情况,可见ArrayList允许存在null。

猜你喜欢

转载自blog.csdn.net/hzw2017/article/details/80317212