2019-12-04 Java-ArrayList 扩容机制 以及 add方法 remove方法 核心代码解读

@[TOC](Java-ArrayList 扩容机制 以及 add方法 remove方法 核心代码解读)

1、创建MyArrayList类

public class MyArrayList {
}

2、构造方法

先看 JDK中ArrayList的构造方法

    /**
     * Constructs an empty list with the specified initial capacity.
     * 使用指定的容量长度 构造一个空list。
     *
     * @param  initialCapacity  the initial capacity of the list
     * @throws IllegalArgumentException if the specified initial capacity
     *         is negative
     */
    public ArrayList(int initialCapacity) {
        if (initialCapacity > 0) {
            // 如果传入的初始化容量大于0 就用初始化容量初始化内部数组
            this.elementData = new Object[initialCapacity];
        } else if (initialCapacity == 0) {
            // 如果初始化容量 等于0 就使用默认的空元素数据来做初始化
            this.elementData = EMPTY_ELEMENTDATA;
        } else {
            // 其他的容量长度是不合法的
            throw new IllegalArgumentException("Illegal Capacity: "+initialCapacity);
        }
    }

    /**
     * Constructs an empty list with an initial capacity of ten.
     * 使用一个默认的初始化容量10 构造一个空list, 这应该是jdk1.8之前 会在构造函数中直接初始化内部数组 1.8之后做了修改 放到了add方法中初始化。
     * (但是好像实现中并没有在构造方法中使用默认的数组长度10来初始化内部数组,而是直接使用了DEFAULTCAPACITY_EMPTY_ELEMENTDATA )
     */
    public ArrayList() {
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }

jdk 中的两个最重要的构造方法如上。
其中有几个重要的参数

    // 内部数组
    private Object[] elementData;

    // 默认数组容量
    private static final int DEFAULT_CAPACITY = 10;

    // 用于空实例的共享空数组实例
    private static final Object[] EMPTY_ELEMENTDATA = {};

    // 共享空数组实例,用于默认大小的空实例。我们将其与EMPTY_ELEMENTDATA区分开来,以了解添加第一个元素时应该膨胀多少。
    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

    //ArrayList的大小(它包含的元素的数量)。
    private int size;

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

参考jdk ArrayList 的构造方法 实现MyArrayList的构造方法

  // 1. 构造方法 初始化内部数组
    public MyArrayList(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);
        }
    }

    // 1. 构造方法 初始化内部数组
    public MyArrayList(){
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }

2.1ArrayList最多可以存放多少个元素?

从字段
private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;
可以看出来 最大值就是Integer的最大值
Integer的范围是
因为最左边的一位是符号位 所以剩下31位可以表达数值
JDK源码中的写法

   /**
     * A constant holding the minimum value an {@code int} can
     * have, -2<sup>31</sup>.
     */
    @Native public static final int   MIN_VALUE = 0x80000000;

    /**
     * A constant holding the maximum value an {@code int} can
     * have, 2<sup>31</sup>-1.
     */
    @Native public static final int   MAX_VALUE = 0x7fffffff;

3、add方法的实现

参考JDK ArrayList add方法实现
1.确定容量大小(这一步包含内部数组扩容机制)
2.elementData持有传入的元素
3.处理完成后返回true

     // 2. add方法
    public Boolean add(Object ele){

        // 2.1确定内部数组的容量大小 判断是否需要扩容(如果是默认无参数构造方法生成的对象,在第一次add的时候会初始化内部数组)
        ensureCapacityInternal(size + 1); // 这里传入的参数是 内置数组应该有的最小值

        // 保存元素到数组中
        elementData[size++] = ele;

        return true;
    }

     // 2.1 确定数组的长度
    private void ensureCapacityInternal(int minCapacity) {
        // 判断是否是使用默认无参数构造方法来创建的arraylist
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
            // 如果是的话 对比需要的最小数组长度和默认数组长度 获取到其中的最大值 作为内部数组的最小长度
            minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
        }
        // 2.1.1明确数组长度
        ensureExplicitCapacity(minCapacity);
    }
    
    // 2.1.1明确数组长度 参数是数组应有的最小容量长度
    private void ensureExplicitCapacity(int minCapacity) {

        // overflow-conscious code
        // 如果数组需要的最小值 大于当前数组的长度 则数组需要扩容
        if (minCapacity - elementData.length > 0){
            // 2.1.1.1 数组扩容
            grow(minCapacity);
        }
    }
// 2.1.1.1 数组扩容
    private void grow(int minCapacity) {
        // overflow-conscious code
        // 获取到 数组原长度
        int oldCapacity = elementData.length;
        // 获取到新的数组长度 (新长度 = 原长度+ 0.5*原长度) >>1 右移一位相当于除2
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        // 如果新长度 小于 数组应有的最小长度 的话 新长度就等于 最小长度
        // 这里 解决了 初始容量为1的arraylist 的扩容问题
        // 如果没有这个判断的话 根据上面的计算 1的扩容 newCapacity= 1+(1>>1) = 1 导致无法扩容
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;
        // 如果新长度 大于MAX_ARRAY_SIZE, MAX_ARRAY_SIZE这个
        if (newCapacity - MAX_ARRAY_SIZE > 0)
            // 如果是 已经大于了MAX_ARRAY_SIZE 就赋予一个很大的值 这个条件下 会赋值Integer的最大值
            newCapacity = hugeCapacity(minCapacity);
        // minCapacity is usually close to size, so this is a win:
        // 这里使用了 数组copy的api 来扩容数组
        elementData = Arrays.copyOf(elementData, newCapacity);
    }
    
  // 获取一个极大的长度
    private static int hugeCapacity(int minCapacity) {
        if (minCapacity < 0) // overflow
            throw new OutOfMemoryError();
        return (minCapacity > MAX_ARRAY_SIZE) ?
                Integer.MAX_VALUE :
                MAX_ARRAY_SIZE;
    }

3.1、 ArrayList内置数组的扩容规则是什么?

// 获取到 数组原长度
int oldCapacity = elementData.length;
// 获取到新的数组长度 (新长度 = 原长度+ 0.5*原长度) >>1 右移一位相当于除2
int newCapacity = oldCapacity + (oldCapacity >> 1);

3.2、为什么ArrayList的默认长度是10?

从这可以看出 我们初始化时的长度是2,当添加第三个元素的时候要扩容 2+(2>>1) = 3
如果 我们在添加第四个元素的话 会再次扩容 3+(3>>1) = 5 这样的话,当我们添加第六个元素的时候又会扩容。
从这里可以看出如果初始定义的长度比较小会造成频繁扩容。
所以 jdk默认的长度是10.

3.3、如果ArrayList初始化长度是1 那扩容的时候会怎么处理?

具体看grow(int minCapacity)方法的实现。
minCapacity = 2;
oldCapacity = 1; newCapacity = 1+(1>>1) ;
newCapacity = 1;
if (newCapacity - minCapacity < 0)
newCapacity = minCapacity;
所以 这时候 newCapacity = 2;
最终扩容的结果是2;

4、get方法实现

get方法的实现比较简单
1.检查数组越界
2.返回对应index的对象

// 3. get方法
    public Object get(int index){
        // 3.1 检查是否越界
        rangeCheck(index);
        // 返回存储对应index的值
        return elementData[index];
    }
// 3.1 检查是否越界
    private void rangeCheck(int index) {
        if (index >= size)
            // 3.1.1 输出越界情况
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }
// 3.1.1 输出越界情况
    private String outOfBoundsMsg(int index) {
        return "Index: "+index+", Size: "+size;
    }

5、remove(int index)移除元素方法实现

根据JDK中ArrayList的remove实现 可以得到remove的处理原理
删除的原理
假设 ArrayList中存放 1 2 3 4 5 6
现在remove(2)
所以可以获取到要删除 元素 是 3
3后面有 3个元素 4 5 6 的下标 前移一位 覆盖掉原来的3(这一步通过数组copy的方法来处理System.arraycopy)
结果就是 1 2 4 5 6
具体实现代码

    public Object remove(int index) {
        // 4.1 检查左边是否越界
        rangeCheck(index);

        // 4.2 获取到原来的元素
        Object oldValue = elementData[index];
        // 4.3 计算inedx后面 需要移动的元素的数量
        /*
        假设 1 2 3 4 5 6
        remove(2)
        numMoved = 6(size) - 2(index) - 1 = 3 所以后面三个元素要往前移动一个下标
         */
        // 需要移动的元素的数量
        int numMoved = size - index - 1;

        // 如果后面没有要移动的元素 就不做数组copy操作了
        if (numMoved > 0)
            // 4.4 处理数组 原数组是 elementData 从index+1开始复制 复制到 elementData 从index开始复制numMoved个元素
            // 通过这个方式 就把 elementData 的index元素用后面的元素覆盖掉了
            System.arraycopy(elementData, index+1, elementData, index,
                    numMoved);
        // 4.5 最后 size - 1 并把size-1后指向的最后一个元素置空
        elementData[--size] = null; // clear to let GC do its work
        // 4.6 返回被删除的元素
        return oldValue;
    }

    //4.1 检查是否越界
    private void rangeCheck(int index) {
        if (index >= size)
            // 3.1.1 输出越界情况
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

6、remove(Object o)方法的实现

根据JDK中ArrayList相关方法的实现,我们可以看出这个方法的实现是基于remove(int index) 的。

判断参数o是不是null

  1. 如果是null ,从index=0 开始遍历elementDate内置数组 找到null对应的index,通过index来移除null
  2. 如果不是null,从index=0 开始遍历elementDate内置数组 找到o对应的index,通过index来移除null
    public boolean remove(Object o) {
        // 5.1 判断o是不是null
        if (o == null) {
            // 5.2如果是空的话 就会遍历删除 《《第一个》》 null 对象
            for (int index = 0; index < size; index++)
                // 判断 index 对应的元素是不是null
                if (elementData[index] == null) {
                    // 5.3 快速删除index对应的对象
                    fastRemove(index);
                    return true;
                }
        } else {
            // 5.4 如果不是空
            for (int index = 0; index < size; index++)
                // 5.5 遍历数组
                if (o.equals(elementData[index])) {
                    //5.6 如果找到第一个equals的对象 就快速删除掉
                    fastRemove(index);
                    return true;
                }
        }
        return false;
    }

    // 5.3/5.6 如果找到第一个equals的对象 就快速删除掉
    // 与remove(index) 方法不同的地方是:1.不做越界检查 2.不会返后被删除的数据
    private void fastRemove(int index) {
        int numMoved = size - index - 1;
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index,
                    numMoved);
        elementData[--size] = null;
    }

7、add(int index,Object ele) 方法的具体实现

通过arraylist 对该方法的具体实现 可以看到具体的步骤是

  1. 检查越界
  2. 确定内置数组容量(包含扩容机制)
  3. 利用System.arraycopy方法,移动数组元素
  4. 赋值新对象到 内置数组的指定的index上
  5. ArrayList的size+1

具体代码实现

    // 6. 向指定的index 添加元素
    public void add(int index, Object ele) {
        // 6.1 检查是否越界
        rangeCheckForAdd(index);

        // 6.2 确定是否需要扩容
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        // 6.3 复制移动数组
        /*
           已有数组 A B C D
           向 index  1 插入 M
           通过arraycopy方法 elementData从index的位置开始复制 复制到 elementData的index+1的位置 复制的长度是 4 - 1 = 3
           所以移动完之后就是 A null B C D
         */
        System.arraycopy(elementData, index, elementData, index + 1,
                size - index);
        // 6.4 赋值对象到指定的index上
        elementData[index] = ele;
        // 6.5 元素总数量+1 size+1
        size++;
    }

 // 6.1 检查是否越界
    private void rangeCheckForAdd(int index) {
        if (index > size || index < 0)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }
    

8、全部代码实现(详细注释)

package com.lhit.collection;

import java.util.Arrays;

public class MyArrayList {

    // 内部数组
    private Object[] elementData;

    // 默认数组容量
    private static final int DEFAULT_CAPACITY = 10;

    // 用于空实例的共享空数组实例
    private static final Object[] EMPTY_ELEMENTDATA = {};

    // 共享空数组实例,用于默认大小的空实例。我们将其与EMPTY_ELEMENTDATA区分开来,以了解添加第一个元素时应该膨胀多少。
    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};

    //ArrayList的大小(它包含的元素的数量)。
    private int size;

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

    // 1. 构造方法 初始化内部数组
    public MyArrayList(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);
        }
    }

    // 1. 构造方法 初始化内部数组
    public MyArrayList(){
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }

    // 2. add方法
    public Boolean add(Object ele){

        // 2.1确定内部数组的容量大小 判断是否需要扩容(如果是默认无参数构造方法生成的对象,在第一次add的时候会初始化内部数组)
        ensureCapacityInternal(size + 1); // 这里传入的参数是这个数字应该有的最小值

        // 保存元素到数组中
        elementData[size++] = ele;

        return true;
    }

    // 3. get方法
    public Object get(int index){
        // 3.1 检查是否越界
        rangeCheck(index);
        // 返回存储对应index的值
        return elementData[index];
    }

    // 4. remove 通过index
    /*
        删除的原理
        假设 ArrayList中存放 1 2 3 4 5 6
        现在remove(2)
        所以可以获取到 元素 是 3
        3后面有 3个元素 4 5 6 的下标 前移 覆盖掉原来的3(这一步通过数组copy的方法来处理System.arraycopy)
        结果就是 1 2 4 5 6
     */
    public Object remove(int index) {
        // 4.1 检查左边是否越界
        rangeCheck(index);

        // 4.2 获取到原来的元素
        Object oldValue = elementData[index];
        // 4.3 计算inedx后面 需要移动的元素的数量
        /*
        假设 1 2 3 4 5 6
        remove(2)
        numMoved = 6(size) - 2(index) - 1 = 3 所以后面三个元素要往前移动一个下标
         */
        // 需要移动的元素的数量
        int numMoved = size - index - 1;

        // 如果后面没有要移动的元素 就不做数组copy操作了
        if (numMoved > 0)
            // 4.4 处理数组 原数组是 elementData 从index+1开始复制 复制到 elementData 从index开始复制numMoved个元素
            // 通过这个方式 就把 elementData 的index元素用后面的元素覆盖掉了
            System.arraycopy(elementData, index+1, elementData, index,
                    numMoved);
        // 4.5 最后 size - 1 并把size-1后指向的最后一个元素置空
        elementData[--size] = null; // clear to let GC do its work
        // 4.6 返回被删除的元素
        return oldValue;
    }

    // 5. remove 通过Object元素来删除
    // 需要注意的是 如果存在相同对象 只能删除index靠前的第一个
    public boolean remove(Object o) {
        // 5.1 判断o是不是null
        if (o == null) {
            // 5.2如果是空的话 就会遍历删除 《《第一个》》 null 对象
            for (int index = 0; index < size; index++)
                // 判断 index 对应的元素是不是null
                if (elementData[index] == null) {
                    // 5.3 快速删除index对应的对象
                    fastRemove(index);
                    return true;
                }
        } else {
            // 5.4 如果不是空
            for (int index = 0; index < size; index++)
                // 5.5 遍历数组
                if (o.equals(elementData[index])) {
                    //5.6 如果找到第一个equals的对象 就快速删除掉
                    fastRemove(index);
                    return true;
                }
        }
        return false;
    }


    // 6. 向指定的index 添加元素
    public void add(int index, Object ele) {
        // 6.1 检查是否越界
        rangeCheckForAdd(index);

        // 6.2 确定是否需要扩容
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        // 6.3 复制移动数组
        /*
           已有数组 A B C D
           向 index  1 插入 M
           通过arraycopy方法 elementData从index的位置开始复制 复制到 elementData的index+1的位置 复制的长度是 4 - 1 = 3
           所以移动完之后就是 A null B C D
         */
        System.arraycopy(elementData, index, elementData, index + 1,
                size - index);
        // 6.4 赋值对象到指定的index上
        elementData[index] = ele;
        // 6.5 元素总数量+1 size+1
        size++;
    }

    // 2.1/6.2 确定数组的长度
    private void ensureCapacityInternal(int minCapacity) {
        // 判断是否是使用默认无参数构造方法来创建的arraylist
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
            // 如果是的话 对比需要的最小数组长度和默认数组长度 获取到其中的最大值 作为内部数组的最小长度
            minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
        }
        // 2.1.1明确数组长度
        ensureExplicitCapacity(minCapacity);
    }

    // 2.1.1明确数组长度 参数是数组应有的最小容量长度
    private void ensureExplicitCapacity(int minCapacity) {

        // overflow-conscious code
        // 如果数组需要的最小值 大于当前数组的长度 则数组需要扩容
        if (minCapacity - elementData.length > 0){
            // 2.1.1.1 数组扩容
            grow(minCapacity);
        }
    }

    // 2.1.1.1 数组扩容
    private void grow(int minCapacity) {
        // overflow-conscious code
        // 获取到 数组原长度
        int oldCapacity = elementData.length;
        // 获取到新的数组长度 (新长度 = 原长度+ 0.5*原长度) >>1 右移一位相当于除2
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        // 如果新长度 小于 数组应有的最小长度 的话 新长度就等于 最小长度
        // 这里 解决了 初始容量为1的arraylist 的扩容问题
        // 如果没有这个判断的话 根据上面的计算 1的扩容 newCapacity= 1+(1>>1) = 1 导致无法扩容
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;
        // 如果新长度 大于MAX_ARRAY_SIZE, MAX_ARRAY_SIZE这个
        if (newCapacity - MAX_ARRAY_SIZE > 0)
            // 如果是 已经大于了MAX_ARRAY_SIZE 就赋予一个很大的值 这个条件下 会赋值Integer的最大值
            newCapacity = hugeCapacity(minCapacity);
        // minCapacity is usually close to size, so this is a win:
        // 这里使用了 数组copy的api 来扩容数组
        elementData = Arrays.copyOf(elementData, newCapacity);

        // 从这可以看出 我们初始化时的长度是2,当添加第三个元素的时候要扩容 2+(2>>1) = 3
        // 如果 我们在添加第四个元素的话 会再次扩容 3+(3>>1) = 5 这样的话,当我们添加第六个元素的时候又会扩容。
        // 从这里可以看出如果初始定义的长度比较小会造成频繁扩容。所以 jdk默认的长度是10.

        // 这里如果初始化长度是1 那扩容的时候会怎么处理?
        // 具体看grow(int minCapacity)方法的实现。
        /*
        minCapacity = 2;
        oldCapacity = 1; newCapacity = 1+(1>>1) ;
        newCapacity = 1;
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;
        所以 这时候 newCapacity = 2;
        最终扩容的结果是2;
        */
    }

    // 3.1/4.1 检查是否越界
    private void rangeCheck(int index) {
        if (index >= size)
            // 3.1.1 输出越界情况
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

    // 3.1.1 输出越界情况
    private String outOfBoundsMsg(int index) {
        return "Index: "+index+", Size: "+size;
    }

    // 5.3/5.6 如果找到第一个equals的对象 就快速删除掉
    // 与remove(index) 方法不同的地方是:1.不做越界检查 2.不会返后被删除的数据
    private void fastRemove(int index) {

        int numMoved = size - index - 1;
        if (numMoved > 0)
            System.arraycopy(elementData, index+1, elementData, index,
                    numMoved);
        elementData[--size] = null;
    }

    // 6.1 检查是否越界
    private void rangeCheckForAdd(int index) {
        if (index > size || index < 0)
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }


    // 获取一个极大的长度
    private static int hugeCapacity(int minCapacity) {
        if (minCapacity < 0) // overflow
            throw new OutOfMemoryError();
        return (minCapacity > MAX_ARRAY_SIZE) ?
                Integer.MAX_VALUE :
                MAX_ARRAY_SIZE;
    }

    // 获取当前ArrayList的元素数量
    public int getSize() {
        return size;
    }
}

9、Vector的扩容机制

这里吧jdk中的Vector中的扩容函数拿过来了

    public Vector(int initialCapacity, int capacityIncrement) {
        super();
        if (initialCapacity < 0)
            throw new IllegalArgumentException("Illegal Capacity: "+
                                               initialCapacity);
        this.elementData = new Object[initialCapacity];
        this.capacityIncrement = capacityIncrement;
    }
   
    public Vector(int initialCapacity) {
        this(initialCapacity, 0);
    }
    
    public Vector() {
        this(10);
    }

capacityIncrement 参数是Vector初始化时可以指定的 默认是0

private void grow(int minCapacity) {
        // overflow-conscious code
        int oldCapacity = elementData.length;
        // 这是是与ArrayList扩容最大的不同点
        // Vector 当默认是0的情况下 会 是2倍扩容
        // 如果初始化时指定了每次扩容的增长容量 则会按照增长量扩容
        int newCapacity = oldCapacity + ((capacityIncrement > 0) ?
                                         capacityIncrement : oldCapacity);
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;
        if (newCapacity - MAX_ARRAY_SIZE > 0)
            newCapacity = hugeCapacity(minCapacity);
        elementData = Arrays.copyOf(elementData, newCapacity);
    }

9.1 Vector与ArrayList有什么不同?

  1. Vector 源码中使用synchronized关键字较多,线程安全要好于ArrayList。
  2. Vector与ArrayList的内置数组的扩容机制不同。默认情况下Vector是两倍扩容,ArrayList是1.5倍扩容

9.2 Vector的扩容机制是什么样的?

Vector在默认情况下是2倍扩容,如果在初始化时指定的每次扩容的容量,则会按照指定容量大小扩容。

推荐阅读更多精彩内容