ArrayList源码分析

493 阅读6分钟

ArrayList简介

ArrayList是一个数组队列,相当于动态数组。与Java中的数组相比,它的容量能动态增长。它的继承关系如图所示:

和Vector不同,ArrayList中的操作是非线程安全的。

ArrayList属性

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

/**
 * 默认初始的容量
 */
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;
/**
 * 数组最大长度
 */
private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;

ArrayList构造函数

带int类型的构造函数

如果传入参数小于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对象的构造函数

  • 将collection对象转换成数组,然后将数组的地址赋给elementData。
  • 更新size的值,同时判断size的大小,如果是size等于0,直接将空对象EMPTY_ELEMENTDATA的地址赋给elementData。
  • 如果size的值大于0,则执行Arrays.copy方法,把collection对象的内容(可以理解为深度拷贝)copy到elementData中。
  • 注意:elementData = c.toArray();这里执行的简单赋值是浅拷贝,所以要执行Arrays.copy做深拷贝。
public ArrayList(Collection<? extends E> c) {
    elementData = c.toArray();
    if ((size = elementData.length) != 0) {
        if (elementData.getClass() != Object[].class)
            elementData = Arrays.copyOf(elementData, size, Object[].class);
    } else {
        this.elementData = EMPTY_ELEMENTDATA;
    }
}

Add方法

add(E e)方法

add主要的执行逻辑如下:

  • 修改次数modCount标识自增1,如果当前数组已使用长度(size)加1之后大于当前数组长度,则调用grow方法,增长数组,grow方法会将当前数组的长度变成原来容量的1.5倍。
  • 确保新增的数据有地方存储之后,则将新元素添加到位于size的位置上。
  • 返回添加成功布尔值。
    添加元素方法入口:
public boolean add(E e) {
    ensureCapacityInternal(size + 1);
    elementData[size++] = e;
    return true;
}

确保添加的元素有地方存储,当第一次添加元素的时候size+1的值为1,所以第一次添加的时候会将当前elementData数组的长度变成10:

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

将修改次数(modCount)自增1,判断是否需要扩充数组长度,判断条件就是用当前所需的数组最小长度与数组的长度对比,如果大于0,则增长数组长度:

private void ensureExplicitCapacity(int minCapacity) {
    modCount++;
    if (minCapacity - elementData.length > 0)
        grow(minCapacity);
}

如果当前数组已使用空间(size)加1之后大于数组长度,则增大数组容量,扩大为原来的1.5倍:

private void grow(int minCapacity) {
    int oldCapacity = elementData.length;
    int newCapacity = oldCapacity + (oldCapacity >> 1);
    if (newCapacity - minCapacity < 0)
        newCapacity = minCapacity;
    if (newCapacity - MAX_ARRAY_SIZE > 0)
        newCapacity = hugeCapacity(minCapacity);
    elementData = Arrays.copyOf(elementData, newCapacity);
}

add(int index, E element)方法

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

  • 确保index数据的合法性。
  • 确保数组已使用长度+1后足够存下下一个数据。
  • 修改次数标识自增1,如果当前数组已使用长度(size)+1后大于当前数组长度,则调用grow方法,增长数组。
  • grow方法会将当前数组的长度变成原来的1.5倍。
  • 确保有足够的容量之后,使用System.arraycopy将需要插入的位置(index)后面的元素统统往后移动一位。
  • 将新的数据内容存放到指定位置(index)上。
public void add(int index, E element) {
    rangeCheckForAdd(index);
    ensureCapacityInternal(size + 1);
    System.arraycopy(elementData, index, elementData, index + 1, size - index);
    elementData[index] = element;
    size++;
}

get方法

返回指定位置上的元素:

public E get(int index) {
    rangeCheck(index);
    return elementData(index);
}

set方法

确保set的位置小于当前数组的长度(size)并且大于0,设置新元素并且返回久元素内容:

public E set(int index, E element) {
    rangeCheck(index);
    E oldValue = elementData(index);
    elementData[index] = element;
    return oldValue;
}

contains方法

调用indexOf方法,遍历数组中的每一个元素作对比,找到返回true,否则返回false:

public boolean contains(Object o) {
    return indexOf(o) >= 0;
}

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

  • 判断索引有没有越界
  • 自增修改次数
  • 将指定位置(index)上的元素保存到oldValue
  • 将指定位置(index)上后面的元素都往前移动一位
  • 将最后面的一个元素置空,好让垃圾回收器回收
  • 将原来的值oldValue返回
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;
    return oldValue;
}

注意:调用这个方法不会缩减数组的长度,只是将最后一个数组元素置空而已。
根据对象remove
循环遍历所有对象,得到对象所在索引位置,然后调用fastRemove方法,执行remove操作,最后返回成功失败:

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

clear方法

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

public void clear() {
    modCount++;
    for (int i = 0; i < size; i++)
        elementData[i] = null;
    size = 0;
}

sublist方法

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

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

trimToSize方法

  • 修改次数加1。
  • 将elementData中空余的空间(包括null值)去除。
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方法时候的修改次数)不一致的时候,会发生该异常,详细我们看一下代码实现:

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

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

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

小结

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

  • ArrayList自己实现了序列化和反序列化的方法,因为它自己实现了 private void writeObject(java.io.ObjectOutputStream s)和 private void readObject(java.io.ObjectInputStream s) 方法。
  • ArrayList基于数组方式实现,无容量的限制(会扩容)。
  • 添加元素时可能要扩容(所以最好预判一下),删除元素时不会减少容量(若希望减少容量,trimToSize()),删除元素时,将删除掉的位置元素置为null,下次gc就会回收这些元素所占的内存空间。
  • 线程不安全。
  • get(int index):获取指定位置上的元素时,可以通过索引直接获取(O(1))。
  • remove(int index)不需要遍历数组,只需判断index是否符合条件即可,效率比remove(Object o)高。
  • contains(E)需要遍历数组。
  • 使用iterator遍历可能会引发多线程异常。