专题一、ArrayList增删操作技术细节详解

一、索引检查

1）在指定位置插入元素时，第一步都需要检查输入的指定位置是否合法

public void add(int index, E element)
{
    rangeCheckForAdd(index);
    ...
}

==>

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

分析：rangeCheckForAdd方法用于检查index是否越界。如果该index大于ArrayList元素个数或者小于0时，抛出索引越界异常。

其中outOfBoundsMsg方法，是用来展示IndexOutOfBoundsException detail message。

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

2）在指定位置删除元素时，第一步也需要检查输入的索引号是否合法

public E remove(int index)
{
    rangeCheck(index);
    ...
}

==>

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

分析：rangeCheck方法只需检测index索引是否超出ArrayList元素个数。

 

问题1：为什么添加元素和删除元素使用的索引检查方法不同呢？

 

二、确保容量

1）增加容量

public void add(int index, E element)
{
    rangeCheckForAdd(index);
    ensureCapacityInternal(size + 1);
    ...
}

==>

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

其中，minCapacity取与默认值之间的最大值。

ensureExplicitCapacity ==>

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

 

问题二：size与elementData.length之间的关系？

如果size==elementData.length，if (minCapacity - elementData.length > 0)就一直会成立。

分析：

• size很好理解，就是ArrayList的长度大小，也可理解为ArrayList中已添加的元素个数，这里需要注意：ArrayList允许添加为null的元素，所以null也会占用一份空间。
• elementData就是ArrayList的内部数组实现，它是一个一维对象数组。当通过add方法向ArrayList中添加元素时，这些元素就会被依次存储于elementData这个数组中。 elementData既然是数组，它必然拥有长度length，那么这个数组的长度是否等于ArrayList的size？

这里需要了解一些ArrayList的相关设计概念：

1、作为ArrayList的内部实现数组elementData具备一定的长度（初始值为10），此长度又被称为capacity（容量）。

2、而每一个ArrayList实例又具有一个size，此size是该实例的列表长度，这其中capacity永远等于数组elementData的长度，并永远大于等于列表size。

所以capacity可以理解为ArrayList的容纳能力，而size可以理解为已使用的空间大小。用生活中的例子，鞋柜就像一个容器，容器的大小（capacity）都是不变的，而其中size会随着填充元素数量增加而增加，但最终只可能等于容器大小。

注意：elementData.length等于elementData.size()，但是ArrayList中的size是记录ArrayList元素的个数，而elementData是用来存放ArrayList的元素。或者说elementData相当于鞋柜容器，它的容器大小==elementData.length==elementData.size()，而ArrayList的size相当于鞋子双数。

参考：List实现之ArrayList

a）容量增长算法

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

1. 得到数组的旧容量，然后进行oldCapacity + (oldCapacity >> 1)，将oldCapacity 右移一位，其效果相当于oldCapacity /2，我们知道位运算的速度远远快于整除运算，整句运算式的结果就是将新容量更新为旧容量的1.5倍，
2. 然后检查新容量是否大于最小需要容量，若还是小于最小需要容量，那么就把最小需要容量当作数组的新容量，
3. 再检查新容量是否超出了ArrayList所定义的最大容量，若超出了，则调用hugeCapacity()来比较minCapacity和 MAX_ARRAY_SIZE，如果minCapacity大于最大容量，则新容量则为ArrayList定义的最大容量，否则，新容量大小则为 minCapacity。 （在判断容量是否超过MAX_ARRAY_SIZE的值，MAX_ARRAY_SIZE值为Integer.MAX_VALUE - 8，比int的最大值小8，不知道为什设计，可能方便判断吧。如果已经超过，调用hugeCapacity方法检查容量的int值是不是已经溢出。一般很少用到int最大值的情况，那么多数据也不会用ArrayList来做容器了，估计这辈子没机会见到hugeCapacity运行一次了。）
4. 最后确定了新的容量，就使用Arrays.copyOf方法来生成新的数组，copyOf也已经完成了将就的数据拷贝到新数组的工作。（Arrays.copyof(···)与System.arraycopy(···)区别）

需要注意的是，容量拓展，是创建一个新的数组，然后将旧数组上的数组copy到新数组，这是一个很大的消耗，所以在我们使用ArrayList时，最好能预计数据的大小，在第一次创建时就申请够内存。

参考：ArrayList实现原理以及其在jdk1.6和jdk1.7的实现区别

hugeCapacity ==> 

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

2）缩小容量

ArrayList还给我们提供了将底层数组的容量调整为当前列表保存的实际元素的大小的功能。它可以通过trimToSize方法来实现。

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