java.util.Collection包之ArrayList源码解读（基于jdk18）

1、ArrayList简介

ArrayList属于java.util的类，底层是基于数组实现的，其实就是一个动态数组。继承自AbstractList，AbstractList继承自AbstractCollection，而AbstractCollection继承自Collection。

 

接下来，将从源码级别解读ArrayList的实现原理。

 

2、源码

/**
* 默认数组大小java.util.Collection包之ArrayList源码解读（基于jdk18）
*/
private static final int DEFAULT_CAPACITY = 10;

/**
* 空的数组，初始化为空的时候会赋值
*/
private static final Object[] EMPTY_ELEMENTDATA = {};

/**
* 用于缺省大小的共享空数组实例
*/
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
transient Object[] elementData; // non-private to simplify nested class access

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

private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;

这些字段等看完源码解读以后就明白意思了。

 

2.1 构造函数

想要初始化一个ArrayList就需要用到构造函数，接下来看下构造函数都有哪些。

 

/**
 * 构造函数1
 * @param initialCapacity
 */
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);
    }
}
/**
 * 构造函数2
 */
public ArrayList() {
    this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
}
/**
 * 构造函数3
 * @param c
 */
public ArrayList(Collection<? extends E> c) {
    elementData = c.toArray();
    if ((size = elementData.length) != 0) {
        // c.toArray might (incorrectly) not return Object[] (see 62606
        if (elementData.getClass() != Object[].class)
            elementData = Arrays.copyOf(elementData, size, Object[].cla
    } else {
        // replace with empty array.
        this.elementData = EMPTY_ELEMENTDATA;
    }
}

不难发现想要初始化一个ArrayList可以通过三种方式，接下来一一解读。

2.1.1、构造函数2

（构造函数2）为默认构造函数。

初始化过程是将缺省的DEFAULTCAPACITY_EMPTY_ELEMENTDATA赋值给了elementData。

因此使用该方法初始化ArrayList的话，此时ArrayList的elementData的长度为0。

 

2.1.2、构造函数1

传入一个arrayList的大小，并初始化一个该大小的数组。

 

2.1.3、构造函数3

该方法，首先把传入的集合，转成数组，复制给elementData，并且计算size，将size赋值为elementData.length。

如果传入的集合不为空，则会验证一下数组的getClass是否等于Object，如果不等于则会重新强转一遍，至于为什么这样做，jdk中有注释c.toArray might (incorrectly) not return Object[] (see 6260652)

see 6260652 这个编号代表JDK bug库中的编号。可以去官网查看bug详情

http://bugs.java.com/bugdatabase/view_bug.do?bug_id=6260652

 

2.2 add方法

ArrayList提供了几种方法，首先看一下add方法，

2.2.1 add(E e)

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

add(E e)是直接添加一个元素。添加成功会返回true。

添加之前，首先要调用ensureCapacityInternal（size+1）来确认可以添加成功。该方法源码如下：

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 static int calculateCapacity(Object[] elementData, int minCapacity) {
    if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
        return Math.max(DEFAULT_CAPACITY, minCapacity);
    }
    return minCapacity;
}

可以看到，首先calculateCapacity会获取数组的长度，如果此时数组为空，则会取DEFAULT_CAPACITY的长度，即为10。然后调用ensureExplicitCapacity，来初始化数组的结构，如果，数组长度小于需要初始化的长度。则会调用grow()方法。

grow方法中会先取数组的长度，然后做了如下计算

private void grow(int minCapacity) {
    // overflow-conscious code
    int oldCapacity = elementData.length;
    //对数组进行1.5倍扩容
    int newCapacity = oldCapacity + (oldCapacity >> 1);
    //如果新的长度小于需要初始化的长度，则就默认用初始化的长度
    if (newCapacity - minCapacity < 0)
        newCapacity = minCapacity;
    //如果新的长度，大于最大的长度，则会调用hugeCapacity
    if (newCapacity - MAX_ARRAY_SIZE > 0)
        newCapacity = hugeCapacity(minCapacity);
    //对数组进行扩容
    elementData = Arrays.copyOf(elementData, newCapacity);
}


private static int hugeCapacity(int minCapacity) {
    //需要扩容的数组大于最大长度以后，则会抛出OutOfMemoryError异常
    if (minCapacity < 0) // overflow
        throw new OutOfMemoryError();
    return (minCapacity > MAX_ARRAY_SIZE) ?
            Integer.MAX_VALUE :
            MAX_ARRAY_SIZE;
}

因此，如果只添加一个元素，则不难发现，数组扩容了一次，并扩容到了10。

2.2.2  add(index,e)

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

首先会调用rangeCheckForAdd检查是否越界，然后判断是否需要扩容。然后调用System.arraycopy进行进行数组索引变动。

2.2.3  addAll()

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

  循环调用add方法增加元素

2.2.4  addAll(index,c)

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

2.3移除方法

2.3.1 remove(index)

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);
    //将最后的数组置为null
    elementData[--size] = null; // clear to let GC do its work
    return oldValue;
}

2.3.2 remove(object) 

public boolean remove(Object o) {
    if (o == null) {
        //如果为null，循环遍历，找到该对象
        for (int index = 0; index < size; index++)
            if (elementData[index] == null) {
                fastRemove(index);
                return true;
            }
    } else {
        for (int index = 0; index < size; index++)
            //如果不为null，则用equals比较，找到该元素
            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
}

 

欢迎转载，转载请注明引用地址。

本文永久链接为：http://www.lingshu.xin/article/366c5038.html