java ArrayList添加元素源码分析记录

Joen W

于 2023-02-17 22:17:43 发布

阅读量132

点赞数 1

分类专栏：随记文章标签： java Powered by 金山文档

本文链接：https://blog.csdn.net/qq_34317140/article/details/129094241

版权

随记专栏收录该内容

1 篇文章 0 订阅

订阅专栏

向ArrayList中添加元素

add 添加元素

    /**
     * Appends the specified element to the end of this list.
     * 在数组末尾追加指定元素
     * @param e element to be appended to this list
     * @return <tt>true</tt> (as specified by {@link Collection#add})
     */
    public boolean add(E e) {
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        elementData[size++] = e;    // 等价于elementData[size] = e; size++;
        return true;
    }

ensureCapacityInternal方法确保内容容量可以满足本次添加元素操作，然后把元素追加到数组中

ensureCapacityInternal确保数组内部容量足以满足本次添加元素操作

    /**
     * 确保数组内部容量足以满足本次添加元素操作
     * @param minCapacity 最小容量要求
     */
    private void ensureCapacityInternal(int minCapacity) {
        ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));
    }

ensureCapacityInternal方法中有两个方法完成添加元素确保容量要求。

calculateCapacity用于计算容量

ensureExplicitCapacity确保数组剩余容量足够

接下来我们看一下 calculateCapacity方法和ensureExplicitCapacity方法

calculateCapacity计算容量

    /**
     * 计算满足本次新增操作所需的容量
     * 当elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA说明是默认构造且未初始化容量
     * 此时取默认容量和最小应赋容量较大值
     * 否则直接返回最小应赋容量
     */
    private static int calculateCapacity(Object[] elementData, int minCapacity) {
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
            return Math.max(DEFAULT_CAPACITY, minCapacity);
        }
        return minCapacity;
    }

这里判断了下elementData是否等于使用默认构造的空元素数组，若等于空元素数组说明此时还未添加元素，需要扩容。此时取默认容量和指定最小容量较大值。

当elementData为非默认容量空元素数组时返回最小容量。

ensureExplicitCapacity 确保数组容量足够

    /**
     * 确保数组剩余容量足够
     *
     * @param minCapacity 最小容量
     */
    private void ensureExplicitCapacity(int mi
        nCapacity) {
        modCount++;

        // overflow-conscious code
        // elementData不满足添加元素要求进行扩容
        if (minCapacity - elementData.length > 0)
            grow(minCapacity);
    }

其中源码注释中有关于溢出考虑可参考扩展点的关于Integer数据特点

此处minCapacity - elementData.length > 0代表的意思是minCapacity比elementData.length在图1 Integer圆环中较大侧

grow扩容

    /**
     * Increases the capacity to ensure that it can hold at least the
     * number of elements specified by the minimum capacity argument.
     * 扩容以确保控制在至少满足指定的最小容量参数的元素个数
     * @param minCapacity the desired minimum capacity
     */
    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;
        // 若新容量在MAX_ARRAY_SIZE较大测，则执行hugeCapacity，在靠近MAX_ARRAY_SIZE是容易从正数变为负数
        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);
    }

int newCapacity = oldCapacity + (oldCapacity >> 1)，数组容量扩容为原来1.5倍，其中grow方法中也有溢出考虑

在newCapacity在MAX_ARRAY_SIZE附近时，需要判断是否处于图1 Integer圆环上MAX_ARRAY_SIZE的较大侧，当结果为true时，需要执行hugeCapacity控制巨大容量（注意此处传入参数是minCapacity，满足添加元素要求即可）

hugeCapacity巨大容量处理

    private static int hugeCapacity(int minCapacity) {
        // 当elementData元素已经是Integer.MAX_VALUE再添加元素时，minCapacity（Integer.MAX_VALUE + 1）此时为负数，抛出OOM错误
        if (minCapacity < 0) // overflow
            throw new OutOfMemoryError();
        // 若minCapacity大于MAX_ARRAY_SIZE则赋值为Integer.MAX_VALUE，否则赋值为MAX_ARRAY_SIZE
        // 此处为尽量照顾一下数组包含头信息的虚拟机
        return (minCapacity > MAX_ARRAY_SIZE) ?
            Integer.MAX_VALUE :
            MAX_ARRAY_SIZE;
    }

起初不理解if (minCapacity < 0) ，后来才知道这里主要是判断最小容量也已经溢出了。例如elementData的size已经时Integer.MAX_VALUE，此时minCapacity是Integer.MIN_VALUE，所以此时需要抛出OOM错误。

` (minCapacity > MAX_ARRAY_SIZE) ? Integer.MAX_VALUE : MAX_ARRAY_SIZE` 主要考虑到部分虚拟机中数组包含的头数据信息