首页>>后端>>java->JAVA ArrayList源码解读

JAVA ArrayList源码解读

时间:2023-12-05 本站 点击:0

1.ArrayList 简介

ArrayList 的底层是数组队列,相当于动态数组。与 Java 中的数组相比,它的容量能动态增长。在添加大量元素前,应用程序可以使用ensureCapacity操作来增加 ArrayList 实例的容量。这可以减少递增式再分配的数量。

ArrayList继承于 AbstractList ,实现了 List, RandomAccess, Cloneable, java.io.Serializable 这些接口。

public class ArrayList<E> extends AbstractList<E>        implements List<E>, RandomAccess, Cloneable, java.io.Serializable{  }

RandomAccess 是一个标志接口,表明实现这个这个接口的 List 集合是支持快速随机访问的。在 ArrayList 中,我们即可以通过元素的序号快速获取元素对象,这就是快速随机访问。

ArrayList 实现了 Cloneable 接口 ,即覆盖了函数clone(),能被克隆。

ArrayList 实现了 java.io.Serializable接口,这意味着ArrayList支持序列化,能通过序列化去传输。

1.1 Arraylist 和 Vector 的区别?

ArrayListList 的主要实现类,底层使用 Object[ ]存储,适用于频繁的查找工作,线程不安全 ;

VectorList 的古老实现类,底层使用 Object[ ]存储,线程安全的。方法都被synchronized 修饰,但是现在基本不用。

1.2 Arraylist 与 LinkedList 区别?

是否保证线程安全: ArrayListLinkedList 都是不同步的,也就是不保证线程安全;

底层数据结构: Arraylist 底层使用的是 Object 数组;LinkedList 底层使用的是 双向链表 数据结构

插入和删除是否受元素位置的影响: ① ArrayList 采用数组存储,所以插入和删除元素的时间复杂度受元素位置的影响。 比如:执行add(E e)方法的时候, ArrayList 会默认在将指定的元素追加到此列表的末尾,这种情况时间复杂度就是 O(1)。但是如果要在指定位置 i 插入和删除元素的话(add(int index, E element))时间复杂度就为 O(n-i)。因为在进行上述操作的时候集合中第 i 和第 i 个元素之后的(n-i)个元素都要执行向后位/向前移一位的操作。 ② LinkedList 采用链表存储,所以对于add(E e)方法的插入,删除元素时间复杂度不受元素位置的影响,近似 O(1),如果是要在指定位置i插入和删除元素的话((add(int index, E element)) 时间复杂度近似为o(n))因为需要先移动到指定位置再插入。

是否支持快速随机访问: LinkedList 不支持高效的随机元素访问,而 ArrayList 支持。快速随机访问就是通过元素的序号快速获取元素对象(对应于get(int index)方法)。

内存空间占用: ArrayList 的空 间浪费主要体现在在 list 列表的结尾会预留一定的容量空间,而 LinkedList 的空间花费则体现在它的每一个元素都需要消耗比 ArrayList 更多的空间(因为要存放直接后继和直接前驱以及数据)。

2. ArrayList 核心源码解读

2.1 我们先看一下,ArraryList 类的基本属性和构造方法

package java.util;import java.util.function.Consumer;import java.util.function.Predicate;import java.util.function.UnaryOperator;public class ArrayList<E> extends AbstractList<E>        implements List<E>, RandomAccess, Cloneable, java.io.Serializable{    private static final long serialVersionUID = 8683452581122892189L;    /**     * 默认初始容量大小     */    private static final int DEFAULT_CAPACITY = 10;    /**     * 空数组(用于空实例)。     */    private static final Object[] EMPTY_ELEMENTDATA = {};     //用于默认大小空实例的共享空数组实例。      //我们把它从EMPTY_ELEMENTDATA数组中区分出来,以知道在添加第一个元素时容量需要增加多少。    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};    /**     * 保存ArrayList数据的数组     */    transient Object[] elementData; // non-private to simplify nested class access    /**     * ArrayList 所包含的元素个数     */    private int size;    /**     * ArrayList 最大元素个数     */    private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;    /**     * 带初始容量参数的构造函数(用户可以在创建ArrayList对象时自己指定集合的初始大小)     */    public ArrayList(int initialCapacity) {        if (initialCapacity > 0) {            //如果传入的参数大于0,创建initialCapacity大小的数组            this.elementData = new Object[initialCapacity];        } else if (initialCapacity == 0) {            //如果传入的参数等于0,创建空数组            this.elementData = EMPTY_ELEMENTDATA;        } else {            //其他情况,抛出异常            throw new IllegalArgumentException("Illegal Capacity: "+                                               initialCapacity);        }    }    /**     *默认无参构造函数     *DEFAULTCAPACITY_EMPTY_ELEMENTDATA 为0.初始化为10,也就是说初始其实是空数组 当添加第一个元素的时候数组容量才变成10     */    public ArrayList() {        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;    }    /**     * 构造一个包含指定集合的元素的列表,按照它们由集合的迭代器返回的顺序。     */    public ArrayList(Collection<? extends E> c) {        //将指定集合转换为数组        elementData = c.toArray();        //如果elementData数组的长度不为0        if ((size = elementData.length) != 0) {            // 如果elementData不是Object类型数据(c.toArray可能返回的不是Object类型的数组所以加上下面的语句用于判断)            if (elementData.getClass() != Object[].class)                //将原来不是Object类型的elementData数组的内容,赋值给新的Object类型的elementData数组                elementData = Arrays.copyOf(elementData, size, Object[].class);        } else {            // 其他情况,用空数组代替            this.elementData = EMPTY_ELEMENTDATA;        }    }    /**     * 修改这个ArrayList实例的容量是列表的当前大小。 应用程序可以使用此操作来最小化ArrayList实例的存储。     */    public void trimToSize() {        modCount++;        if (size < elementData.length) {            elementData = (size == 0)              ? EMPTY_ELEMENTDATA              : Arrays.copyOf(elementData, size);        }    }

2.2 再来看一下常用方法的底层原理

2.2.1 add() 方法

/**     * 将指定的元素追加到此列表的末尾。     */    public boolean add(E e) {        ensureCapacityInternal(size + 1);  // Increments modCount!!        //这里看到ArrayList添加元素的实质就相当于为数组赋值        elementData[size++] = e;        return true;    }   //1.得到最小扩容量   //2.通过最小容量扩容    private void ensureCapacityInternal(int minCapacity) {        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {              // 获取“默认的容量”和“传入参数”两者之间的最大值            minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);        }        ensureExplicitCapacity(minCapacity);    }  //判断是否需要扩容    private void ensureExplicitCapacity(int minCapacity) {        modCount++;        // overflow-conscious code        if (minCapacity - elementData.length > 0)            //调用grow方法进行扩容,调用此方法代表已经开始扩容了            grow(minCapacity);    }    /**     * ArrayList扩容的核心方法。     */    private void grow(int minCapacity) {        // oldCapacity为旧容量,newCapacity为新容量        int oldCapacity = elementData.length;        //将oldCapacity 右移一位,其效果相当于oldCapacity /2,        //我们知道位运算的速度远远快于整除运算,整句运算式的结果就是将新容量更新为旧容量的1.5倍,        int newCapacity = oldCapacity + (oldCapacity >> 1);        //然后检查新容量是否大于最小需要容量,若还是小于最小需要容量,那么就把最小需要容量当作数组的新容量,        if (newCapacity - minCapacity < 0)            newCapacity = minCapacity;        //再检查新容量是否超出了ArrayList所定义的最大容量,        //若超出了,则调用hugeCapacity()来比较minCapacity和 MAX_ARRAY_SIZE,        //如果minCapacity大于MAX_ARRAY_SIZE,则新容量则为Interger.MAX_VALUE,否则,新容量大小则为 MAX_ARRAY_SIZE。        if (newCapacity - MAX_ARRAY_SIZE > 0)            newCapacity = hugeCapacity(minCapacity);      //通过复制的形式进行ArrayList 扩容        elementData = Arrays.copyOf(elementData, newCapacity);    }    //比较minCapacity和 MAX_ARRAY_SIZE    private static int hugeCapacity(int minCapacity) {        if (minCapacity < 0) // overflow            throw new OutOfMemoryError();        return (minCapacity > MAX_ARRAY_SIZE) ?            Integer.MAX_VALUE :            MAX_ARRAY_SIZE;    } /**     * 在此列表中的指定位置插入指定的元素。     *先调用 rangeCheckForAdd 对index进行界限检查;然后调用 ensureCapacityInternal 方法保证capacity足够大;     *再将从index开始之后的所有成员后移一个位置;将element插入index位置;最后size加1。     */    public void add(int index, E element) {        rangeCheckForAdd(index);        ensureCapacityInternal(size + 1);  // Increments modCount!!        //arraycopy()这个实现数组之间复制的方法一定要看一下,下面就用到了arraycopy()方法实现数组自己复制自己        System.arraycopy(elementData, index, elementData, index + 1,                         size - index);        elementData[index] = element;        size++;    }    /**     * 按指定集合的Iterator返回的顺序将指定集合中的所有元素追加到此列表的末尾。     */    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;    }    /**     * 将指定集合中的所有元素插入到此列表中,从指定的位置开始。     先调用 rangeCheckForAdd 对index进行界限检查;然后调用 ensureCapacityInternal 方法保证     capacity足够大;     */    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;    }    /**     * add和addAll使用的rangeCheck的一个版本     */    private void rangeCheckForAdd(int index) {        if (index > size || index < 0)            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));    }

2.2.2 remove 方法

/**     * 从列表中删除指定元素的第一个出现(如果存在)。 如果列表不包含该元素,则它不会更改。     *返回true,如果此列表包含指定的元素     */    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;    }    /**     * 删除该列表中指定位置的元素。 将任何后续元素移动到左侧(从其索引中减去一个元素)。     */    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;     }    /**     * 删除该列表中指定位置的元素。 将任何后续元素移动到左侧(从其索引中减去一个元素)。     * 并返回删除的元素数据     */    public E remove(int index) {        rangeCheck(index);        modCount++;        E oldValue = elementData(index);        //这里应该可以调用fastRemove() 方法        int numMoved = size - index - 1;        if (numMoved > 0)            System.arraycopy(elementData, index+1, elementData, index,                             numMoved);        elementData[--size] = null;       //从列表中删除的元素        return oldValue;    }    /**     * 删除所有索引为fromIndex (含)和toIndex之间的元素。     *     */    protected void removeRange(int fromIndex, int toIndex) {        modCount++;        int numMoved = size - toIndex;        System.arraycopy(elementData, toIndex, elementData, fromIndex,                         numMoved);        int newSize = size - (toIndex-fromIndex);        for (int i = newSize; i < size; i++) {            elementData[i] = null;        }        size = newSize;    }    /**     * 从此列表中删除指定集合中包含的所有元素。     */    public boolean removeAll(Collection<?> c) {        Objects.requireNonNull(c);        //如果此列表被修改则返回true        return batchRemove(c, false);    }    /**     * 仅保留此列表中包含在指定集合中的元素。     *换句话说,从此列表中删除其中不包含在指定集合中的所有元素。     */    public boolean retainAll(Collection<?> c) {        Objects.requireNonNull(c);        return batchRemove(c, true);    }    private boolean batchRemove(Collection<?> c, boolean complement) {        final Object[] elementData = this.elementData;        int r = 0, w = 0;        boolean modified = false;        try {            for (; r < size; r++)                if (c.contains(elementData[r]) == complement)                    elementData[w++] = elementData[r];        } finally {            // c.contains()  如果抛异常了那么将剩余部分的数据复制过来            if (r != size) {                System.arraycopy(elementData, r,                                 elementData, w,                                 size - r);                w += size - r;            }            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;    }    /**     * 检查给定的索引是否在范围内。     */    private void rangeCheck(int index) {        if (index >= size)            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));    }

2.2.3 indexOf 方法

/**     *返回此列表中指定元素的首次出现的索引,如果此列表不包含此元素,则为-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++)                //equals()方法比较                if (o.equals(elementData[i]))                    return i;        }        return -1;    }    /**     * 返回此列表中指定元素的最后一次出现的索引,如果此列表不包含元素,则返回-1。.     */    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;    }

2.2.4 其他常用方法

 /**     * 如果此列表包含指定的元素,则返回true 。     */    public boolean contains(Object o) {        //indexOf()方法:返回此列表中指定元素的首次出现的索引,如果此列表不包含此元素,则为-1        return indexOf(o) >= 0;    }  /**     * 返回此列表中指定位置的元素。     */    public E get(int index) {        rangeCheck(index);        return elementData(index);    }    /**     * 用指定的元素替换此列表中指定位置的元素。     */    public E set(int index, E element) {        //对index进行界限检查        rangeCheck(index);        E oldValue = elementData(index);        elementData[index] = element;        //返回原来在这个位置的元素        return oldValue;    }    @SuppressWarnings("unchecked")    E elementData(int index) {        return (E) elementData[index];    }    /**     * 从列表中删除所有元素。     */    public void clear() {        modCount++;        // 把数组中所有的元素的值设为null        for (int i = 0; i < size; i++)            elementData[i] = null;        size = 0;    }/**     *返回此列表中的元素数。     */    public int size() {        return size;    }    /**     * 返回IndexOutOfBoundsException细节信息     */    private String outOfBoundsMsg(int index) {        return "Index: "+index+", Size: "+size;    }    /**     * 如果此列表不包含元素,则返回 true 。     */    public boolean isEmpty() {        //注意=和==的区别        return size == 0;    }    /**     * 返回此ArrayList实例的浅拷贝。 (元素本身不被复制。)     */    public Object clone() {        try {            ArrayList<?> v = (ArrayList<?>) super.clone();            //Arrays.copyOf功能是实现数组的复制,返回复制后的数组。参数是被复制的数组和复制的长度            v.elementData = Arrays.copyOf(elementData, size);            v.modCount = 0;            return v;        } catch (CloneNotSupportedException e) {            // 这不应该发生,因为我们是可以克隆的            throw new InternalError(e);        }    }    /**     *以正确的顺序(从第一个到最后一个元素)返回一个包含此列表中所有元素的数组。     *返回的数组将是“安全的”,因为该列表不保留对它的引用。 (换句话说,这个方法必须分配一个新的数组)。     *因此,调用者可以自由地修改返回的数组。 此方法充当基于阵列和基于集合的API之间的桥梁。     */    public Object[] toArray() {        return Arrays.copyOf(elementData, size);    }    /**     * 以正确的顺序返回一个包含此列表中所有元素的数组(从第一个到最后一个元素);     *返回的数组的运行时类型是指定数组的运行时类型。 如果列表适合指定的数组,则返回其中。     *否则,将为指定数组的运行时类型和此列表的大小分配一个新数组。     *如果列表适用于指定的数组,其余空间(即数组的列表数量多于此元素),则紧跟在集合结束后的数组中的元素设置为null 。     *(这仅在调用者知道列表不包含任何空元素的情况下才能确定列表的长度。)     */    @SuppressWarnings("unchecked")    public <T> T[] toArray(T[] a) {        if (a.length < size)            // 新建一个运行时类型的数组,但是ArrayList数组的内容            return (T[]) Arrays.copyOf(elementData, size, a.getClass());            //调用System提供的arraycopy()方法实现数组之间的复制        System.arraycopy(elementData, 0, a, 0, size);        if (a.length > size)            a[size] = null;        return a;    }    // Positional Access Operations    /**     * 从列表中的指定位置开始,返回列表中的元素(按正确顺序)的列表迭代器。     *指定的索引表示初始调用将返回的第一个元素为next 。 初始调用previous将返回指定索引减1的元素。     *返回的列表迭代器是fail-fast 。     */    public ListIterator<E> listIterator(int index) {        if (index < 0 || index > size)            throw new IndexOutOfBoundsException("Index: "+index);        return new ListItr(index);    }    /**     *返回列表中的列表迭代器(按适当的顺序)。     *返回的列表迭代器是fail-fast 。     */    public ListIterator<E> listIterator() {        return new ListItr(0);    }    /**     *以正确的顺序返回该列表中的元素的迭代器。     *返回的迭代器是fail-fast 。     */    public Iterator<E> iterator() {        return new Itr();    }

2.3 ensureCapacity方法

ArrayList 源码中有一个 ensureCapacity 方法,这个方法 ArrayList 内部没有被调用过,所以很显然是提供给用户调用的,那么这个方法有什么作用呢?

 /**    如有必要,增加此 ArrayList 实例的容量,以确保它至少可以容纳由minimum capacity参数指定的元素数。     *     * @param   minCapacity   所需的最小容量     */    public void ensureCapacity(int minCapacity) {        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;        if (minCapacity > minExpand) {            ensureExplicitCapacity(minCapacity);        }    }

最好在 add 大量元素之前用 ensureCapacity 方法,以减少增量重新分配的次数

2.4 System.arraycopy() 和 Arrays.copyOf()方法

ArrayList 中大量调用了这两个方法。比如:我们上面讲的扩容操作以及add(int index, E element)toArray() 等方法中都用到了该方法!

2.4.1 System.arraycopy() 方法

 // 我们发现 arraycopy 是一个 native 方法,接下来我们解释一下各个参数的具体意义    /**    *   复制数组    * @param src 源数组    * @param srcPos 源数组中的起始位置    * @param dest 目标数组    * @param destPos 目标数组中的起始位置    * @param length 要复制的数组元素的数量    */    public static native void arraycopy(Object src,  int  srcPos,                                        Object dest, int destPos,                                        int length);

2.4.2 Arrays.copyOf()方法

 public static int[] copyOf(int[] original, int newLength) {        // 申请一个新的数组        int[] copy = new int[newLength];    // 调用System.arraycopy,将源数组中的数据进行拷贝,并返回新的数组        System.arraycopy(original, 0, copy, 0,                         Math.min(original.length, newLength));        return copy;    }

联系:

看两者源代码可以发现 copyOf()内部实际调用了 System.arraycopy() 方法

区别:

arraycopy() 需要目标数组,将原数组拷贝到你自己定义的数组里或者原数组,而且可以选择拷贝的起点和长度以及放入新数组中的位置 copyOf() 是系统自动在内部新建一个数组,并返回该数组。

原文'https://juejin.cn/post/7096730202428047367


本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如若转载,请注明出处:/java/12200.html