ArrayList源码学习

前言：ArrayList源码学习

简介

底层是动态数组，数组元素的类型为Object类型，线程不安全，默认数组大小为10

常用方法：

boolean add(E e)
E get(int index)
E set(int index, E element)
boolean isEmpty()
int size()

类图如下

RandomAccess接口：标记性接口，用来快速随机存取，在实现了该接口的话，那么使用普通的for循环来遍历，性能更高，例如ArrayList。而没有实现该接口的话，使用Iterator来迭代，这样性能更高，例如LinkedList。另外说一点，使用foreach时，如果反编译代码会ArrayList的foreach是for循环，LinkedList的foreach是
Iterator

Cloneable接口：实现该接口，可使用Object.Clone()方法了。

Serializable接口：实现该接口，类对象才可以被序列化（对象变成字节流，字节类变成对象）

属性

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

/**
 * 空对象数组
 */
private static final Object[] EMPTY_ELEMENTDATA = {};

/**
 * 缺省空对象数组
 */
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

/**
 * 元素数组
 */
transient Object[] elementData;

/**
 * ArrayList 大小
 */
private int size;

/**
 * The maximum size of array to allocate.
 * Some VMs reserve some header words in an array.
 * Attempts to allocate larger arrays may result in
 * OutOfMemoryError: Requested array size exceeds VM limit
 * 数组作为一个对象，需要一定的内存存储对象头信息，对象头信息最大占用内存不可超过8字节
 */
private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;

ArrayList可以看做是数组的封装，使用elementData数组来存储数据，使用size来代表elementData的元素个数，capacity记录elementData数组的长度。elementData前没有访问修饰符，所以只有同类和同包下的类可以直接访问，外界想要知道ArrayList实例内元素的个数就要通过size属性。elementData数组类型是Object类型，可以存放任意的引用类型，不能存放基本的数据类型。

构造方法

public ArrayList() {
    // 初始化元素数组为缺省空对象数组
    this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
}

// 以其他集合创建ArrayList
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;
    }
}
    
public ArrayList(int initialCapacity) {
    if (initialCapacity > 0) {
        // 初始化元素数组为创建的指定数量对象数组
        this.elementData = new Object[initialCapacity];
    } else if (initialCapacity == 0) {
        // 初始化元素数组为空对象数组
        this.elementData = EMPTY_ELEMENTDATA;
    } else {
        // 初始容量小于0抛出异常
        throw new IllegalArgumentException("Illegal Capacity: "+
                                           initialCapacity);
    }
}

add

添加元素

public boolean add(E e) {
    // 确认内部容量是否足够存放size+1个元素，如果不足会进行扩容
    ensureCapacityInternal(size + 1);  // Increments modCount!!
    // 将新元素添加至尾部，size++
    elementData[size++] = e;
    return true;
}

添加元素至指定位置

public void add(int index, E element) {
    // 检查下标是否超过数组大小
    rangeCheckForAdd(index);
    // 确认内部容量是否足够存放size+1个元素，如果不足会进行扩容
    ensureCapacityInternal(size + 1);  // Increments modCount!!
    // 调用 System.arraycopy，将数组从index位置开始的数据copy到数组index+1位置，简单来说就是index后的数据后移1位
    System.arraycopy(elementData, index, elementData, index + 1,
                     size - index);
    // 将新元素添加至指定位置
    elementData[index] = element;
    size++;
}

添加一个集合的元素

public boolean addAll(Collection<? extends E> c) {
    // 集合转换为Object对象
    Object[] a = c.toArray();
    int numNew = a.length;
    // 确认内部容量是否足够存放size + numNew个元素，如果不足会进行扩容
    ensureCapacityInternal(size + numNew);  // Increments modCount
    // 将a数组从0位置开始的数据（也就是所有数据）添加到elementData数组size处，添加numNew个数据
    System.arraycopy(a, 0, elementData, size, numNew);
    size += numNew;
    return numNew != 0;
}

添加一个集合的元素至指定位置

public boolean addAll(int index, Collection<? extends E> c) {
    // 检查下标是否超过数组大小
    rangeCheckForAdd(index);
    
    // 集合转换为Object对象
    Object[] a = c.toArray();
    int numNew = a.length;
    
    // 确认内部容量是否足够存放size + numNew个元素，如果不足会进行扩容
    ensureCapacityInternal(size + numNew);  // Increments modCount
    
    // 将原数组index后的数据后移size - index位
    int numMoved = size - index;
    if (numMoved > 0)
        System.arraycopy(elementData, index, elementData, index + numNew,
                         numMoved);
    // 将a数组从0位置开始的数据（也就是所有数据）添加到elementData数组size处，添加numNew个数据
    System.arraycopy(a, 0, elementData, index, numNew);
    size += numNew;
    return numNew != 0;
}

batchRemove

批量去除，由removeAll方法和retainAll方法调用

private boolean batchRemove(Collection<?> c, boolean complement) {
    final Object[] elementData = this.elementData;
    int r = 0, w = 0;
    boolean modified = false;
    try {
        // retainAll方法调用时，complement为true,遍历容器数组，如果数据存在于c集合中，则保留，也就是去除不包含在指定集合中的所有元素
        // removeAll方法调用时，complement为false,遍历容器数组，如果数据不存在于c集合中，则保留，也就是去除包含在指定集合中的所有元素
        for (; r < size; r++)
            if (c.contains(elementData[r]) == complement)
                elementData[w++] = elementData[r];
    } finally {
        // 发生异常，for循环未执行完，将原数组从r位置开始的size-r个数据复制到w位置处，也就是说剩余的数据均保留
        if (r != size) {
            System.arraycopy(elementData, r,
                             elementData, w,
                             size - r);
            w += size - r;
        }
        // 经过批量去除，数组变小，所以数组w后的位置均设为null,GC垃圾回收，数据长度设为w
        if (w != size) {
            // clear to let GC do its work
            for (int i = w; i < size; i++)
                elementData[i] = null;
            modCount += size - w;
            size = w;
            modified = true;
        }
    }
    // 返回修改成功
    return modified;
}

calculateCapacity

计算容量

private static int calculateCapacity(Object[] elementData, int minCapacity) {
    // 如果当前数组是默认的空数组，返回DEFAULT_CAPACITY（10）与minCapacity的最大值
    if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
        return Math.max(DEFAULT_CAPACITY, minCapacity);
    }
    return minCapacity;
}

当数组是空数组，返回容量取DEFAULT_CAPACITY和minCapacity最大值，试想创建ArrayList时没有指定容量，elementData被赋值为空数组，然后add一个元素，此时扩容会直接将容量提高到10而不是乘1.5

clear

清空容器数据

public void clear() {
    // 结构性修改计数器+1
    modCount++;

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

    size = 0;
}

clone

浅复制，如果要实现深复制，需要实现对象类的clone方法。

public Object clone() {
    try {
        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);
    }
}

contains

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

elementData

使用数组下标返回数组值，该方法为默认访问权限，由get、set、remove等方法调用

E elementData(int index) {
    return (E) elementData[index];
}

ensureCapacity

ensureCapacity方法是共有方法，提供给开发者用来设定容器容量，因为扩容会消耗较多的时间，对于大量的add操作，最好提前设定好减少扩容次数。

public void ensureCapacity(int minCapacity) {
    // 如果elementData是默认的空数组，minExpand为10，否则为0
    int minExpand = (elementData != DEFAULTCAPACITY_EMPTY_ELEMENTDATA)
        // any size if not default element table
        ? 0
        // larger than default for default empty table. It's already
        // supposed to be at default size.
        : DEFAULT_CAPACITY;
    // 如果设定容量大于minExpand，则执行扩容
    if (minCapacity > minExpand) {
        ensureExplicitCapacity(minCapacity);
    }
}

ensureCapacityInternal

// 确保容器能存放minCapacity个元素
private void ensureCapacityInternal(int minCapacity) {
    ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));
}

calculateCapacity方法用于计算新增元素所需要的容量

ensureExplicitCapacity方法用于判断是否需要扩容

ensureExplicitCapacity

private void ensureExplicitCapacity(int minCapacity) {
    // 结构性修改计数器+1
    modCount++;

    if (minCapacity - elementData.length > 0)
        grow(minCapacity);
}

ensureExplicitCapacity(minCapacity)方法用于判断是否需要扩容。

首先将结构性修改计数器+1；然后判断minCapacity与当前元素数组的长度的大小，如果minCapacity比当前元素数组的长度大,就调用grow方法扩容

fastRemove

私有方法，由remove方法调用，去除指定位置数据

private void fastRemove(int index) {
    // 结构性修改计数器+1
    modCount++;
    // 因为去除一个数据，所以该位置后的数据均要前移一位
    int numMoved = size - index - 1;
    if (numMoved > 0)
        System.arraycopy(elementData, index+1, elementData, index,
                         numMoved);
    // 数据末尾设为空，GC垃圾回收
    elementData[--size] = null; // clear to let GC do its work
}

forEach

1.8后，ArrayList支持函数式编程、Lambda表达式

@Override
public void forEach(Consumer<? super E> action) {
    Objects.requireNonNull(action);
    final int expectedModCount = modCount;
    @SuppressWarnings("unchecked")
    final E[] elementData = (E[]) this.elementData;
    final int size = this.size;
    for (int i=0; modCount == expectedModCount && i < size; i++) {
        action.accept(elementData[i]);
    }
    if (modCount != expectedModCount) {
        throw new ConcurrentModificationException();
    }
}

Lambda遍历输出list集合

ArrayList<String> list = new ArrayList<>();
list.forEach(x -> System.out.print(x));

get

public E get(int index) {
    // 检查下标是否合法
    rangeCheck(index);
    // 返回指定下标值
    return elementData(index);
}

grow

扩容方法，扩容为1.5倍，需要注意的是，扩容时会出现溢出为负数的情况

private void grow(int minCapacity) {
    // overflow-conscious code
    int oldCapacity = elementData.length;
    // 新容量为旧容量1.5倍，有可能会溢出变成负数
    int newCapacity = oldCapacity + (oldCapacity >> 1);
    // 新容量小于minCapacity有三种情况，,第一种情况是默认空数组扩容，会直接将容量提高到10而不是0的1.5倍，第二种情况是调用ensureCapacity方法扩容至指定数量，第三种情况是newCapacity溢出为负数
    
    // 当出现以上种情况时，设定新容量为minCapacity
    if (newCapacity - minCapacity < 0)
        newCapacity = minCapacity;
    // MAX_ARRAY_SIZE是Integer.MAX_VALUE - 8，那什么数会比这个大，答案就是一堆负数和int最大的那8个正数，出现这种情况，容量提高到Integer.MAX_VALUE或者MAX_ARRAY_SIZE，之后如果再次扩容就是OutOfMemoryError
    if (newCapacity - MAX_ARRAY_SIZE > 0)
        newCapacity = hugeCapacity(minCapacity);
    // 扩容成功后就会将数据copy到新数组
    elementData = Arrays.copyOf(elementData, newCapacity);
}

因为扩容会消耗较多的时间，初始化设定容量或者调用ensureCapacity方法设定容量，避免ArrayList内部进行扩容是一种优化方式

hugeCapacity

私有方法，由grow方法调用，用于处理容量很大时扩容情况

private static int hugeCapacity(int minCapacity) {
    // minCapacity小于0的情况发生于溢出时，抛出内存溢出错误
    if (minCapacity < 0) // overflow
        throw new OutOfMemoryError();
    return (minCapacity > MAX_ARRAY_SIZE) ?
        Integer.MAX_VALUE :
        MAX_ARRAY_SIZE;
}

indexOf

返回数组中指定元素出现的第一个位置

1. 判断是否为空，如果为空找到第一个为空的值，返回下标
2. 不为空，找到第一个相等的值，返回下标
3. 找不到，返回-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;
}

isEmpty

判断集合是否为空

public boolean isEmpty() {
    return size == 0;
}

iterator

返回Iterator迭代器

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

lastIndexOf

同indexOf，返回数组中指定元素出现的最后一个位置

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

listIterator

返回ListIterator迭代器

public ListIterator<E> listIterator() {
    return new ListItr(0);
}

listIterator

返回L从指定位置开始的ListIterator迭代器

public ListIterator<E> listIterator(int index) {
    if (index < 0 || index > size)
        throw new IndexOutOfBoundsException("Index: "+index);
    return new ListItr(index);
}

outOfBoundsMsg

私有方法，rangeCheck、rangeCheckForAdd调用用于抛出越界异常信息

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

rangeCheck

检查下标是否合法

private void rangeCheck(int index) {
    判断下标，如果大于size就抛出异常，如果负数由数组的底层实现抛出异常
    if (index >= size)
        throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
}

rangeCheckForAdd

用于添加元素至指定位置，检查下标是否合法

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

readObject

私有方法，序列化时调用，因为elementData被transient修饰，所以elementData不会被序列化，需要重写readObject方法来序列化。为什么要用transient修饰？因为elementData数组只有size个数据，长度为elementData.length,还有length-size个位置是null数据，这些null数据是没有必要序列化输入输出的，避免了浪费资源，所以将用transient修饰elementData数组并重写readObject、writeObject。

private void readObject(java.io.ObjectInputStream s)
    throws java.io.IOException, ClassNotFoundException {
    elementData = EMPTY_ELEMENTDATA;

    // Read in size, and any hidden stuff
    s.defaultReadObject();

    // Read in capacity
    s.readInt(); // ignored

    if (size > 0) {
        // be like clone(), allocate array based upon size not capacity
        int capacity = calculateCapacity(elementData, size);
        SharedSecrets.getJavaOISAccess().checkArray(s, Object[].class, capacity);
        ensureCapacityInternal(size);

        Object[] a = elementData;
        // Read in all elements in the proper order.
        for (int i=0; i<size; i++) {
            a[i] = s.readObject();
        }
    }
}

remove

remove(int index)方法的作用是删除指定下标的元素。

public E remove(int index) {
    // 判断下标合法性
    rangeCheck(index);
    // 结构性修改计数器+1
    modCount++;
    // 获取旧值
    E oldValue = elementData(index);
    // 将指定下标后面一位到数组末尾的全部元素向前移动一个单位，并且把数组最后一个元素设置为null，需要移动的元素个数为：size-index-1。
    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;
}

删除指定元素。

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

removeAll

去除包含在指定集合中的所有元素

public boolean removeAll(Collection<?> c) {
    Objects.requireNonNull(c);
    return batchRemove(c, false);
}

removeIf

按照一定规则过滤集合中的元素，JDK1.8新增方法，详情见ArrayList.removeIf

removeRange

去除指定返回内的数据

protected void removeRange(int fromIndex, int toIndex) {
    modCount++;
    // toIndex后的数据前移fromIndex个位置，直接覆盖要去除的数据
    int numMoved = size - toIndex;
    System.arraycopy(elementData, toIndex, elementData, fromIndex,
                     numMoved);

    // 根据size，将多余的数据设为null，GC垃圾回收
    int newSize = size - (toIndex-fromIndex);
    for (int i = newSize; i < size; i++) {
        elementData[i] = null;
    }
    size = newSize;
}

replaceAll

用函数接口的返回结果替代原list中的值，详情见ArrayList.replaceAll

retainAll

去除未包含在指定集合中的元素，和removeAll相反

public boolean retainAll(Collection<?> c) {
    Objects.requireNonNull(c);
    return batchRemove(c, true);
}

set

public E set(int index, E element) {
    // 检查下标是否合法
    rangeCheck(index);
    // 取旧值
    E oldValue = elementData(index);
    // 设置新值
    elementData[index] = element;
    // 返回旧值
    return oldValue;
}

size

返回数组大小

public int size() {
    return size;
}

sort

根据业务逻辑，实现了Comparator的接口，然后调用该方法就能对ArrayList排序

@Override
@SuppressWarnings("unchecked")
public void sort(Comparator<? super E> c) {
    final int expectedModCount = modCount;
    Arrays.sort((E[]) elementData, 0, size, c);
    if (modCount != expectedModCount) {
        throw new ConcurrentModificationException();
    }
    modCount++;
}

spliterator

JDK1.8新增方法，splitable iterator，可分割迭代器。跟iterator迭代器的区别在于，Spliterator可分割，从而实现并行遍历

@Override
public Spliterator<E> spliterator() {
    return new ArrayListSpliterator<>(this, 0, -1, 0);
}

subList

返回List集合部分视图，左闭右开

public List<E> subList(int fromIndex, int toIndex) {
    // 判断fromIndex、toIndex是否合法
    subListRangeCheck(fromIndex, toIndex, size);
    return new SubList(this, 0, fromIndex, toIndex);
}

subListRangeCheck

subList方法调用，用于校验下标是否越界

static void subListRangeCheck(int fromIndex, int toIndex, int size) {
    if (fromIndex < 0)
        throw new IndexOutOfBoundsException("fromIndex = " + fromIndex);
    if (toIndex > size)
        throw new IndexOutOfBoundsException("toIndex = " + toIndex);
    if (fromIndex > toIndex)
        throw new IllegalArgumentException("fromIndex(" + fromIndex +
                                           ") > toIndex(" + toIndex + ")");
}

toArray

ArrayList转数组

第一个方法直接转为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;
}

trimToSize

将elementData的数组设置为ArrayList实际的容量,删除多余容量。

public void trimToSize() {
    // 结构性修改计数器+1
    modCount++;
    if (size < elementData.length) {
        elementData = (size == 0)
          ? EMPTY_ELEMENTDATA
          : Arrays.copyOf(elementData, size);
    }
}

writeObject

私有方法，序列化时调用，结合readObject方法

private void writeObject(java.io.ObjectOutputStream s)
    throws java.io.IOException{
    // Write out element count, and any hidden stuff
    int expectedModCount = modCount;
    s.defaultWriteObject();

    // Write out size as capacity for behavioural compatibility with clone()
    s.writeInt(size);

    // 注意这里，elementData长度为length,大小为size，还有length-size个null数据，序列化时只输出size个数据，null数据不输出，避免资源浪费
    for (int i=0; i<size; i++) {
        s.writeObject(elementData[i]);
    }

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

优缺点

优点

1. ArrayList底层以数组实现，是一种随机访问模式，再加上它实现了RandomAccess接口，因此get、put不仅方便而且速度快。
2. 根据下标遍历元素，效率高。
3. 根据下标访问元素，效率高。
4. 可以自动扩容，默认为每次扩容为原来的1.5倍。

缺点

1. 线程不安全
2. 插入（从指定位置插入）、删除较慢
3. 使用indexOf查找元素需遍历整个数组，速度慢

ArrayList遍历方式

ArrayList 遍历的三种方式（建议使用for循环）

// 1
Integer value = null;
int size = list.size();
for (int i=0; i<size; i++) {
    value = (Integer)list.get(i);        
}

// 2
Integer value = null;
Iterator iter = list.iterator();
while (iter.hasNext()) {
    value = (Integer)iter.next();
}

// 3
Integer value = null;
for (Integer integ:list) {
    value = integ;
}

// 4
list.forEach(x -> System.out.print(x));

toArray()

ArrayList转数组

// toArray(T[] contents)调用方式一
public static Integer[] vectorToArray1(ArrayList<Integer> v) {
    Integer[] newText = new Integer[v.size()];
    v.toArray(newText);
    return newText;
}

// toArray(T[] contents)调用方式二。最常用！
public static Integer[] vectorToArray2(ArrayList<Integer> v) {
    Integer[] newText = (Integer[])v.toArray(new Integer[0]);
    return newText;
}

// toArray(T[] contents)调用方式三
public static Integer[] vectorToArray3(ArrayList<Integer> v) {
    Integer[] newText = new Integer[v.size()];
    Integer[] newStrings = (Integer[])v.toArray(newText);
    return newStrings;
}

举例

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

public class Main{
    public static void main(String[] args) {
        // Java集合不能存放基本类型，只能对象
        List<Integer> list = new ArrayList<Integer>();
        list.add(1);
        list.add(2);
        list.add(3);
        list.add(4);
        list.add(0, 5);
        for(int i=0;i<list.size();i++)
            System.out.println("list.get(0): "+ list.get(i));
        list.remove("3");
        System.out.println("ArrayList contains 3 is: "+ list.contains(3));
        list.set(1, 5);

        for(Iterator iter = list.iterator(); iter.hasNext(); ) {
            System.out.println("next is: "+ iter.next());
        }
        Integer[] arr = new Integer[list.size()];
        list.toArray(arr);
        for (Integer i:arr)
            System.out.println("str: "+ i);
        list.clear();
        System.out.println("ArrayList is empty: "+ list.isEmpty());
    }

}